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.8.tar.gz
(25.9 kB
view details)
Built Distribution
File details
Details for the file pypaperless-3.1.8.tar.gz.
File metadata
- Download URL: pypaperless-3.1.8.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 | ffe1f25afd7ffad81530d7d0204171baef677f61d6018073ccbe1251563d534b |
|
| MD5 | 3ea4fb7ce61158f9150e3e597b185c45 |
|
| BLAKE2b-256 | c1498b21131f48e33bc0ebc91cc42c3c01a6e8b95c88f5d8acf62830d7fd229b |
Provenance
File details
Details for the file pypaperless-3.1.8-py3-none-any.whl.
File metadata
- Download URL: pypaperless-3.1.8-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 | e3682c432eb39b213396bc3dad41b507a1fdc9d6ad481e3f5f0f1a895ca64ec7 |
|
| MD5 | bf4aa4ae220b9f409539927f2018abee |
|
| BLAKE2b-256 | f080d5f4edabe79063f99a5c5f74cf76059554ae133599496ed1e0bd7fbeb9b2 |
