# libpixiv
Client library for [pixiv](https://pixiv.net)
## Usage
> *NOTE*: Also consider minor version bumps as breaking change as long as this library is pre-1.0.
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:
```bash
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 :)