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
Project details
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.2.tar.gz
(25.9 kB
view hashes)
Built Distribution
Close
Hashes for pypaperless-3.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ff371b828e0dad02a7ee02ba880bfde475db0e331a8c16abf1d283a268119da |
|
MD5 | a5a70eccc4af2b40989f2fc2e5a0d959 |
|
BLAKE2b-256 | acf4dc11a773c4657f82341bddc73001d8ecce0c723c1638458ef9f1cd1e353a |