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.11.tar.gz
(26.1 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.1.11.tar.gz
.
File metadata
- Download URL: pypaperless-3.1.11.tar.gz
- Upload date:
- Size: 26.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87138d489c1e21c74cdd4887b27df908da1969ddf2d91cb49bb11a51addec4d0 |
|
MD5 | c41ff1b8ad4a95606c60b28974ce5aa5 |
|
BLAKE2b-256 | 7d396caad6e1b4ef1093ace7d4f807bc29c3b6b0bacb90e69e2b647ace36b0b4 |
Provenance
File details
Details for the file pypaperless-3.1.11-py3-none-any.whl
.
File metadata
- Download URL: pypaperless-3.1.11-py3-none-any.whl
- Upload date:
- Size: 38.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1153de702d83001ae803942a9c321885a1783da82f58f3bec7480cbf288dae6 |
|
MD5 | 1833900f1f9bf7005fd4709fab8bc8a3 |
|
BLAKE2b-256 | 08e8a75e5e083ddbd061366a021b9d82011bcc7f58475577253fdad9533badbe |