# PyPaperless
[![GitHub Release][release-badge]][release-url]
[![Python Version][python-badge]][python-url]
[![GitHub License][license-badge]][license-url]
[![Tests][tests-badge]][tests-url]
[![Codecov][codecov-badge]][codecov-url]
[![Linting][linting-badge]][linting-url]
[![Typing][typing-badge]][typing-url]
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
```bash
pip install pypaperless
```
## Documentation
Please check out the **[docs][docs-url]** for detailed instructions and examples.
## Authors & contributors
_PyPaperless_ is written by [Tobias Schulz][contributors-tbsch]. Its his first Python project. Feedback appreciated.
Check out all [contributors here][contributors-url].
## Thanks to
- The Paperless-ngx Team
- The Home Assistant Community
[codecov-badge]: https://codecov.io/gh/tb1337/paperless-api/graph/badge.svg?token=IMXRBK3HRE
[codecov-url]: https://app.codecov.io/gh/tb1337/paperless-api/tree/main
[contributors-tbsch]: https://tbsch.de
[contributors-url]: https://github.com/tb1337/paperless-api/graphs/contributors
[docs-url]: https://github.com/tb1337/paperless-api/blob/main/docs/usage.md
[license-badge]: https://img.shields.io/github/license/tb1337/paperless-api
[license-url]: /LICENSE.md
[python-badge]: https://img.shields.io/pypi/pyversions/pypaperless
[python-url]: https://pypi.org/project/pypaperless/
[tests-badge]: https://github.com/tb1337/paperless-api/actions/workflows/tests.yml/badge.svg
[tests-url]: https://github.com/tb1337/paperless-api/actions
[release-badge]: https://img.shields.io/github/v/release/tb1337/paperless-api
[release-url]: https://github.com/tb1337/paperless-api/releases
[linting-badge]: https://github.com/tb1337/paperless-api/actions/workflows/linting.yml/badge.svg
[linting-url]: https://github.com/tb1337/paperless-api/actions
[typing-badge]: https://github.com/tb1337/paperless-api/actions/workflows/typing.yml/badge.svg
[typing-url]: https://github.com/tb1337/paperless-api/actions
Raw data
{
"_id": null,
"home_page": "https://github.com/tb1337/paperless-api",
"name": "pypaperless",
"maintainer": "Tobias Schulz",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "public.dev@tbsch.de",
"keywords": "library, async, api-client, python3, paperless-ngx",
"author": "Tobias Schulz",
"author_email": "public.dev@tbsch.de",
"download_url": "https://files.pythonhosted.org/packages/5e/ce/c6d271e20c857cf40ee26bc3a3b6806efba583970a319e53373ee6384d78/pypaperless-3.1.3.tar.gz",
"platform": null,
"description": "# PyPaperless\n\n[![GitHub Release][release-badge]][release-url]\n[![Python Version][python-badge]][python-url]\n[![GitHub License][license-badge]][license-url]\n\n[![Tests][tests-badge]][tests-url]\n[![Codecov][codecov-badge]][codecov-url]\n[![Linting][linting-badge]][linting-url]\n[![Typing][typing-badge]][typing-url]\n\nLittle asynchronous client for Paperless-ngx, written in Python. You should at least use Python `>=3.11`.\n\nFind out more about Paperless-ngx here:\n\n- Project: https://docs.paperless-ngx.com\n- API Docs: https://docs.paperless-ngx.com/api/\n- Source Code: https://github.com/paperless-ngx/paperless-ngx\n\n## Features\n\n- Depends on aiohttp, works in async environments.\n- Token authentication only. **No credentials anymore.**\n- Request single resource items.\n- Iterate over all resource items or request them page by page.\n- Create, update and delete resource items.\n- Almost feature complete.\n- _PyPaperless_ is designed to transport data only. Your code must organize it.\n\n## Installation\n\n```bash\npip install pypaperless\n```\n\n## Documentation\n\nPlease check out the **[docs][docs-url]** for detailed instructions and examples.\n\n## Authors & contributors\n\n_PyPaperless_ is written by [Tobias Schulz][contributors-tbsch]. Its his first Python project. Feedback appreciated.\n\nCheck out all [contributors here][contributors-url].\n\n## Thanks to\n\n- The Paperless-ngx Team\n- The Home Assistant Community\n\n[codecov-badge]: https://codecov.io/gh/tb1337/paperless-api/graph/badge.svg?token=IMXRBK3HRE\n[codecov-url]: https://app.codecov.io/gh/tb1337/paperless-api/tree/main\n[contributors-tbsch]: https://tbsch.de\n[contributors-url]: https://github.com/tb1337/paperless-api/graphs/contributors\n[docs-url]: https://github.com/tb1337/paperless-api/blob/main/docs/usage.md\n[license-badge]: https://img.shields.io/github/license/tb1337/paperless-api\n[license-url]: /LICENSE.md\n[python-badge]: https://img.shields.io/pypi/pyversions/pypaperless\n[python-url]: https://pypi.org/project/pypaperless/\n[tests-badge]: https://github.com/tb1337/paperless-api/actions/workflows/tests.yml/badge.svg\n[tests-url]: https://github.com/tb1337/paperless-api/actions\n[release-badge]: https://img.shields.io/github/v/release/tb1337/paperless-api\n[release-url]: https://github.com/tb1337/paperless-api/releases\n[linting-badge]: https://github.com/tb1337/paperless-api/actions/workflows/linting.yml/badge.svg\n[linting-url]: https://github.com/tb1337/paperless-api/actions\n[typing-badge]: https://github.com/tb1337/paperless-api/actions/workflows/typing.yml/badge.svg\n[typing-url]: https://github.com/tb1337/paperless-api/actions\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Little api client for paperless(-ngx).",
"version": "3.1.3",
"project_urls": {
"Coverage: codecov": "https://codecov.io/gh/tb1337/paperless-api",
"Documentation": "https://github.com/tb1337/paperless-api",
"GitHub: Issues": "https://github.com/tb1337/paperless-api/issues",
"GitHub: Source": "https://github.com/tb1337/paperless-api",
"Homepage": "https://github.com/tb1337/paperless-api",
"Repository": "https://github.com/tb1337/paperless-api"
},
"split_keywords": [
"library",
" async",
" api-client",
" python3",
" paperless-ngx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6356a433209cc236c05259e7897e77d18d93eb0f31c049c5cbab82644a972e7a",
"md5": "dcc84d79f350cbca8b7a40cd1d5f17b8",
"sha256": "ff5654ccaffc231910d27d80fd68644ac58b40fb0436b0662857dee089f7d2ee"
},
"downloads": -1,
"filename": "pypaperless-3.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcc84d79f350cbca8b7a40cd1d5f17b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 38681,
"upload_time": "2024-04-29T08:17:49",
"upload_time_iso_8601": "2024-04-29T08:17:49.340944Z",
"url": "https://files.pythonhosted.org/packages/63/56/a433209cc236c05259e7897e77d18d93eb0f31c049c5cbab82644a972e7a/pypaperless-3.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ecec6d271e20c857cf40ee26bc3a3b6806efba583970a319e53373ee6384d78",
"md5": "950cb56e999ac763422dd27aea7ba25a",
"sha256": "a44fdf1e8ae72fe1db4218bc7afe2f6008ec39e848ce9e15d1880060d3930b9e"
},
"downloads": -1,
"filename": "pypaperless-3.1.3.tar.gz",
"has_sig": false,
"md5_digest": "950cb56e999ac763422dd27aea7ba25a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 25929,
"upload_time": "2024-04-29T08:17:51",
"upload_time_iso_8601": "2024-04-29T08:17:51.173747Z",
"url": "https://files.pythonhosted.org/packages/5e/ce/c6d271e20c857cf40ee26bc3a3b6806efba583970a319e53373ee6384d78/pypaperless-3.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 08:17:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tb1337",
"github_project": "paperless-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pypaperless"
}
JSON
