Little api client for paperless(-ngx).
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
PyPaperless
Little asynchronous client for Paperless-ngx, written in Python. You should at least use Python >=3.12.
v4 upgrade warning
- We dropped support for Python
<=3.11. - Major changes in various classes occurred. Consider using Paperless-ngx
>=2.15.0. - Support for Paperless-ngx
<2.15.0will end after 2025/07.
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.
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
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.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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-4.1.0.tar.gz
(127.7 kB
view details)
Built Distribution
File details
Details for the file pypaperless-4.1.0.tar.gz.
File metadata
- Download URL: pypaperless-4.1.0.tar.gz
- Upload date:
- Size: 127.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b37a213dbb2efed62fcc00a5b85ab16dbcaee046276e7968d4c4cadd2b131f7e |
|
| MD5 | b210ac1fbb122f5ae1dc88611afd9947 |
|
| BLAKE2b-256 | 279167116557a97285e478d7a47fda262860eb0f0bce272ecf0a67b22fa3da37 |
Provenance
The following attestation bundles were made for pypaperless-4.1.0.tar.gz:
Publisher:
release.yml on tb1337/paperless-api
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
pypaperless-4.1.0.tar.gz - Subject digest:
b37a213dbb2efed62fcc00a5b85ab16dbcaee046276e7968d4c4cadd2b131f7e - Sigstore transparency entry: 215376676
- Sigstore integration time:
- Permalink:
tb1337/paperless-api@c42c8bd33dbb30afa34f30439064fa3253ca9afe - Branch / Tag:
refs/tags/v4.1.0 - Owner: https://github.com/tb1337
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
release.yml@c42c8bd33dbb30afa34f30439064fa3253ca9afe - Trigger Event:
release
- Statement type:
File details
Details for the file pypaperless-4.1.0-py3-none-any.whl.
File metadata
- Download URL: pypaperless-4.1.0-py3-none-any.whl
- Upload date:
- Size: 43.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48314b8ce1fa5a60e8f2cb03657539cd7e2738e89c5b7dfc50b452b6ff058b29 |
|
| MD5 | 7386e3731043f6055480bff28cd92846 |
|
| BLAKE2b-256 | fffb1d15773e4fff358cbee4e34944f651fe6df8d5e003bce0c202bde22307e6 |
Provenance
The following attestation bundles were made for pypaperless-4.1.0-py3-none-any.whl:
Publisher:
release.yml on tb1337/paperless-api
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
pypaperless-4.1.0-py3-none-any.whl - Subject digest:
48314b8ce1fa5a60e8f2cb03657539cd7e2738e89c5b7dfc50b452b6ff058b29 - Sigstore transparency entry: 215376677
- Sigstore integration time:
- Permalink:
tb1337/paperless-api@c42c8bd33dbb30afa34f30439064fa3253ca9afe - Branch / Tag:
refs/tags/v4.1.0 - Owner: https://github.com/tb1337
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
release.yml@c42c8bd33dbb30afa34f30439064fa3253ca9afe - Trigger Event:
release
- Statement type:
