Little api client for paperless(-ngx).
Project description
PyPaperless
Little asynchronous client for Paperless-ngx, written in Python. You should at least use Python >=3.11.
Find out more about Paperless-ngx here:
- Project: https://docs.paperless-ngx.com
- API Docs: https://docs.paperless-ngx.com/api/
- Source Code: https://github.com/paperless-ngx/paperless-ngx
Features
- Depends on aiohttp, works in async environments.
- Token authentication only. No credentials anymore.
- Request single resource items.
- Iterate over all resource items or request them page by page.
- Create, update and delete resource items.
- Almost feature complete.
- PyPaperless is designed to transport data only. Your code must organize it.
Installation
pip install pypaperless
Documentation
Please check out the docs for detailed instructions and examples.
Authors & contributors
PyPaperless is written by Tobias Schulz. Its his first Python project. Feedback appreciated.
Check out all contributors here.
Thanks to
- The Paperless-ngx Team
- The Home Assistant Community
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pypaperless-3.1.7.tar.gz
(25.9 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.1.7.tar.gz.
File metadata
- Download URL: pypaperless-3.1.7.tar.gz
- Upload date:
- Size: 25.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fc8a83057dfb38d73e69c757011294b6efeb5f35d1ca43696f63103da60a7de5 |
|
| MD5 | 43b910869f59d1532e801e66351de013 |
|
| BLAKE2b-256 | dc795e530caf8273b1c5787c358c097b5985bbbe45b34964d245055030869bf6 |
Provenance
File details
Details for the file pypaperless-3.1.7-py3-none-any.whl.
File metadata
- Download URL: pypaperless-3.1.7-py3-none-any.whl
- Upload date:
- Size: 38.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0992d6b48bac6d2078517109dc6b1bf924dc2021a27b7b713758d50c46509fc9 |
|
| MD5 | 6ddc047f682615f4b69ed8fce90a7d17 |
|
| BLAKE2b-256 | e7b630132f9abbb7145bb8b6c9bf498942f636c4ac377c561a6bc04ac10c146a |
