pypaperless-cli2 0.2.0__tar.gz → 0.2.1__tar.gz

{pypaperless_cli2-0.2.0 → pypaperless_cli2-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypaperless-cli2
-Version: 0.2.0
+Version: 0.2.1
 Summary: Command-line interface for Paperless-ngx (fork of pypaperless-cli, updated for pypaperless 5.x / Paperless-ngx 3.x)
 License-File: LICENSE
 Author: Marcel Brückner
@@ -24,16 +24,14 @@ Description-Content-Type: text/markdown
 
 Paperless-ngx Command-Line Interface
 
-This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli), republished as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`). The `pngx` command and all usage below are unchanged from upstream.
+This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli).
 
-I've recently started a project to collect scripts around Paperless-ngx ([paperless.sh](https://paperless.sh)). It turned out - surprise - to be very tedious to write a separate [script](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/post-consumption/content-matching/pngx-update-document.py) [each](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum.py) [time](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum-of-differences.py) I need to work with Paperless-ngx's API.
-I was looking for a way to easily update certain fields of my documents but without the overhead of "manually" calling API endpoints each time.
-I wrapped things in simple python scripts which eventually became this tool which essentially ~~is~~ will become Paperless-ngx at your command-line.
+After updating my Paperless-ngx instances to version 3.x the current pypaperless-cli package has thrown some errors when editing documents.
+I republished the current pypaperless-cli as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`).
+The `pngx` command and all usage below are unchanged from upstream.
 
 ## Usage
 
-This very first public release currently only allows you to retrieve information or update certain fields of your existing documents (with more to come in the future).
-
 ```bash
 # Run pngx -h for help
 $ pngx [ command ] [ subcommand ] [ arguments and parameters ]
@@ -67,6 +65,16 @@ Update a document's title and correspondent.
 $ pngx document edit <ID> --title "My new document title" --correspondent <CORRESPONDENT_ID>
 ```
 
+Update a document's creation date.
+
+The Paperless-ngx API expects the date in ISO 8601 format. With Version 0.2.0 of this package comes a dateparser which auto-detects the used date format and converts it to ISO 8601 format.
+
+```bash
+# Set document creation date to "14.09.2026"
+$ pngx document edit <ID> --created-date 14.09.2026
+# The date parser automatically converts the date to 2026-09-14 and uses it in the communication with the API
+```
+
 Assign or unassign a document's tags.
 
 Tags can be specified by ID or the *exact* name. If your tag name contains spaces, wrap it in quotes.

{pypaperless_cli2-0.2.0 → pypaperless_cli2-0.2.1}/README.md

@@ -2,16 +2,14 @@
 
 Paperless-ngx Command-Line Interface
 
-This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli), republished as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`). The `pngx` command and all usage below are unchanged from upstream.
+This is a fork of [Marcel Brückner's `pypaperless-cli`](https://github.com/marcelbrueckner/paperless-ngx-cli).
 
-I've recently started a project to collect scripts around Paperless-ngx ([paperless.sh](https://paperless.sh)). It turned out - surprise - to be very tedious to write a separate [script](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/post-consumption/content-matching/pngx-update-document.py) [each](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum.py) [time](https://github.com/marcelbrueckner/paperless.sh/blob/6cc85b20482e0281d9e26ab82fcaccf34e27a276/scripts/api/custom-field-sum/custom-field-sum-of-differences.py) I need to work with Paperless-ngx's API.
-I was looking for a way to easily update certain fields of my documents but without the overhead of "manually" calling API endpoints each time.
-I wrapped things in simple python scripts which eventually became this tool which essentially ~~is~~ will become Paperless-ngx at your command-line.
+After updating my Paperless-ngx instances to version 3.x the current pypaperless-cli package has thrown some errors when editing documents.
+I republished the current pypaperless-cli as `pypaperless-cli2` with the `pypaperless` dependency updated to `^5.1.0` for compatibility with Paperless-ngx ≥3.0 (which rejects the older API versions requested by `pypaperless` 4.x with `406 Not Acceptable`).
+The `pngx` command and all usage below are unchanged from upstream.
 
 ## Usage
 
-This very first public release currently only allows you to retrieve information or update certain fields of your existing documents (with more to come in the future).
-
 ```bash
 # Run pngx -h for help
 $ pngx [ command ] [ subcommand ] [ arguments and parameters ]
@@ -45,6 +43,16 @@ Update a document's title and correspondent.
 $ pngx document edit <ID> --title "My new document title" --correspondent <CORRESPONDENT_ID>
 ```
 
+Update a document's creation date.
+
+The Paperless-ngx API expects the date in ISO 8601 format. With Version 0.2.0 of this package comes a dateparser which auto-detects the used date format and converts it to ISO 8601 format.
+
+```bash
+# Set document creation date to "14.09.2026"
+$ pngx document edit <ID> --created-date 14.09.2026
+# The date parser automatically converts the date to 2026-09-14 and uses it in the communication with the API
+```
+
 Assign or unassign a document's tags.
 
 Tags can be specified by ID or the *exact* name. If your tag name contains spaces, wrap it in quotes.

{pypaperless_cli2-0.2.0 → pypaperless_cli2-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pypaperless-cli2"
-version = "0.2.0"
+version = "0.2.1"
 description = "Command-line interface for Paperless-ngx (fork of pypaperless-cli, updated for pypaperless 5.x / Paperless-ngx 3.x)"
 authors = ["Marcel Brückner <marcelbrueckner@users.noreply.github.com>"]
 readme = "README.md"