Little api client for the paperless(-ngx) dms.
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.0.1.tar.gz
(25.4 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.0.1.tar.gz.
File metadata
- Download URL: pypaperless-3.0.1.tar.gz
- Upload date:
- Size: 25.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 233e2003ef5ef6fb86eb017dd5e01408fc1802a213179213e23c0d9a777edb95 |
|
| MD5 | bd9f977f8ed185818e33775b6e65441d |
|
| BLAKE2b-256 | f900b45468b2a83356828ec22efe0615d92558f44be6f131da6625ea8cf89640 |
Provenance
File details
Details for the file pypaperless-3.0.1-py3-none-any.whl.
File metadata
- Download URL: pypaperless-3.0.1-py3-none-any.whl
- Upload date:
- Size: 37.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7b47d6461cff27dae4398357dc3cf5083f511a597aa3c98cfe7d0356d30725a2 |
|
| MD5 | f7d96c70c20e5f92c7d5b7ee806a36eb |
|
| BLAKE2b-256 | 942f3390d1d668eb30515726071ea13c8b2c450ac1617cfc985feb0ad5f4b84a |
