theBreadCompany/libpixiv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
59 commits 1 branch 2 tags 203 KiB
Find a file
Exact
theBreadCompany 65e1284189
Some checks failed
Publish / audit for vulnerabilities (push) Successful in 3m25s
Details
/ test (push) Successful in 1m24s
Details
Publish / test library (push) Failing after 1s
Details
Publish / publish (push) Has been skipped
Details
update README.md
2025-09-04 03:43:08 +02:00
.cargo add publishing workflow 2025-09-03 03:38:37 +02:00
.forgejo/workflows fix publishing pipeline 2025-09-03 12:05:25 +02:00
src remove fxpixiv 2025-09-03 02:30:53 +02:00
.gitignore remove fxpixiv 2025-09-03 02:30:53 +02:00
Cargo.lock update README.md 2025-09-04 03:43:08 +02:00
Cargo.toml update README.md 2025-09-04 03:43:08 +02:00
LICENSE fix file modes 2025-07-31 00:25:03 +02:00
README.md update README.md 2025-09-04 03:43:08 +02:00

README.md

libpixiv

Client library for pixiv

Usage

For now, no OAuth2 login will be provided, so please make sure to provide refresh tokens yourself.

The following features are available (some might be missing)

  • users
    • search
    • metadata
    • related
    • following/unfollowing
    • bookmarks
  • illustrations
    • search
    • metadata
    • related
    • comments
    • recommendations
    • bookmarking
    • bookmarks
  • animations (ugoira)
    • metadata lookup
    • NOTE: Animations are provided as image sequences, building those is currently not implemented in this crate.

Testing

You can run the following command to test existing features:

PIXIV_REFRESH_TOKEN= cargo test --lib

Notes

  • The crate user is currently responsible to refresh the token from time to time (API currently reports an expiration of 1 hour)
  • Documentation is NOT complete
  • cargo-llvm-cov currently reports a coverage of 67%
  • This is an unofficial API library, please consider all the implications this might have.
  • Also, this library is probably missing a few endpoints and/or features - if you happen to know or find any of those, feel free to open a PR :)