Little api client for paperless(-ngx).

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbsch from gravatar.com tbsch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Tobias Schulz
  • Tags api-client , async , library , paperless-ngx , python3
  • Requires: Python <3.14, >=3.13.5
Classifiers
Report project as malware

Project description

PyPaperless

GitHub Release Python Version GitHub License

Tests Codecov Linting Typing

Little asynchronous client for Paperless-ngx, written in Python. You should at least use Python >=3.12.

Features

  • Depends on aiohttp, works in async environments.
  • Token authentication only. No credentials.
  • Request single resource items.
  • Iterate over all resource items or request them page by page.
  • Create, update and delete resource items.
  • Add, remove and update custom fields on documents.
  • Almost feature complete.
  • pypaperless is designed to transport data only. Your code must organize it.

Find out more about Paperless-ngx here:

Installation

pip install pypaperless

Documentation

Please check out the docs for detailed instructions and examples.

Compatibility matrix

Choosing the right version of pypaperless for your Paperless-ngx instance can be tricky. This little matrix is here to help.

Paperless-ngx pypaperless
>= 2.17 >= 5.0
>= 2.16 >= 4.1
>= 2.15 >= 4.0
< 2.15 < 4.0
  • pypaperless <4.0 is not compatible with Paperless-ngx >=2.15 due to breaking server changes.
  • pypaperless 5.0 implements date changes in the document API and is therefore not compatible with Paperless-ngx <2.16.
  • pypaperless >=5.1 will drop support for all Paperless-ngx versions without the Open API schema, introduced in 2.15.

[!TIP] Consider keeping both Paperless-ngx and pypaperless always updated.

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 PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tbsch from gravatar.com tbsch

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Tobias Schulz
  • Tags api-client , async , library , paperless-ngx , python3
  • Requires: Python <3.14, >=3.13.5
Classifiers

Release history Release notifications | RSS feed

This version

5.0.0

4.1.2

4.1.1

4.1.0

4.0.0

3.1.15

3.1.14

3.1.13

3.1.12

3.1.11

3.1.10

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.2

3.0.1

3.0.0

2.4.0

2.3.0

2.2.1

2.2.0

2.1.0

2.0.1

1.1.0

1.0.0

0.0.8

0.0.7

0.0.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypaperless-5.0.0.tar.gz (121.6 kB view details)

Uploaded Source

Built Distribution

pypaperless-5.0.0-py3-none-any.whl (45.1 kB view details)

Uploaded Python 3

File details

Details for the file pypaperless-5.0.0.tar.gz.

File metadata

  • Download URL: pypaperless-5.0.0.tar.gz
  • Upload date:
  • Size: 121.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pypaperless-5.0.0.tar.gz
Algorithm Hash digest
SHA256 0fd1ebbb8e23b89874cdb09a734d4e0cd4f18b885c219058a1f279321d0d419b
MD5 e56de830a3399d6d838280672ffff8c2
BLAKE2b-256 f4af226b93d7bba25fd5890a34903d91206a031c8c185f679a35a2a3ef642e2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypaperless-5.0.0.tar.gz:

Publisher: release.yml on tb1337/paperless-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pypaperless-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: pypaperless-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 45.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pypaperless-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b93c2ddfeb0150c7dddbd986487fb5be6f2bd36e22e7efb4f1d5b58928ec976c
MD5 b21558b6223cc516257637775f566272
BLAKE2b-256 4a4377082842c1aa17703b32dbbd3d2f3ee384b1821b2352b36877e14081158f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pypaperless-5.0.0-py3-none-any.whl:

Publisher: release.yml on tb1337/paperless-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page