From b0a2e837956cd587937855cda2e296c3d3b48cc4 Mon Sep 17 00:00:00 2001 From: "Antonio J. Delgado" Date: Fri, 22 Nov 2024 14:56:20 +0200 Subject: [PATCH] Update readme and increase version --- README.md | 30 ++++++++++++++---------- nc_password_client/nc_password_client.py | 2 +- pyproject.toml | 2 +- setup.cfg | 2 +- 4 files changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 046a9e7..4167c18 100644 --- a/README.md +++ b/README.md @@ -32,19 +32,21 @@ Change your configuration file in "${HOME}/.config/nc_password_client.conf" (see Usage: nc_password_client.sh [OPTIONS] COMMAND [ARGS]... ### Options: -| option | parameters | description | -| --------------------- | ------------------------------------------ | --------------------------------------------------------------- | -| -d, --debug-level | [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] | Set the debug level for the standard output. | -| -l, --log-file | TEXT | File to store all debug messages. | -| -H, --host | TEXT | Nextcloud host name [required] | -| -u, --user | TEXT | Nextcloud user name [required] | -| -a, --api-token | TEXT | Nextcloud user's application token [required] | -| -p, --cse-password | TEXT | Nextcloud user's end-to-end encryption password | -| -t, --timeout | INTEGER | Timeout for HTTPS requests | -| -c, --cache-duration | INTEGER | Number of seconds to hold the list of passwords | -| -P, --https-proxy | TEXT | HTTPS proxy to use to connect to the Nextcloud instance| -| --config | FILE | Read configuration from FILE. | -| --help | | Show this message and exit. | +| option | parameters | description | +| ------------------------- | ------------------------------------------ | --------------------------------------------------------------- | +| -d, --debug-level | [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET] | Set the debug level for the standard output. | +| -f, --output-format | [json|yaml|plain] | Set the output format.| +| -l, --log-file | TEXT | File to store all debug messages. | +| -H, --host | TEXT | Nextcloud host name [required] | +| -u, --user | TEXT | Nextcloud user name [required] | +| -a, --api-token | TEXT | Nextcloud user's application token [required] | +| -p, --cse-password | TEXT | Nextcloud user's end-to-end encryption password | +| -t, --timeout | INTEGER | Timeout for HTTPS requests | +| -c, --cache-duration | INTEGER | Number of seconds to hold the list of passwords | +| -P, --https-proxy | TEXT | HTTPS proxy to use to connect to the Nextcloud instance| +| -F, --field-replacements | TEXT | Pairs of field names to be replaced separated by a : (colon). Like: -F login:username | +| --config | FILE | Read configuration from FILE. | +| --help | | Show this message and exit. | ### Commands: | command | description | @@ -54,10 +56,12 @@ Usage: nc_password_client.sh [OPTIONS] COMMAND [ARGS]... | delete-all-passwords |Delete all passwords | | delete-password |Delete a password | | delete-passwords-folder |Delete a password folder | +| import-csv | Import passwords stored in a CSV file to Nextcloud Passwords | | list-passwords-folders |List all password folders | | ls |List all password | | migrate-pass |Migrate Password Store passwords to Nextcloud...| | remove-duplicates |Remove duplicate passwords | +| search | Search for a password (or passwords) that... | | show |Show a single password | Use --help after the command to get more details of it's options diff --git a/nc_password_client/nc_password_client.py b/nc_password_client/nc_password_client.py index 800be99..7fe3c78 100755 --- a/nc_password_client/nc_password_client.py +++ b/nc_password_client/nc_password_client.py @@ -1816,7 +1816,7 @@ def delete_all_passwords(ctx, yes_i_am_sure): def import_csv( ctx, limit, update, csv_file, encoding, delimiter, quotechar, first_line_fields, fieldnames): - '''Migrate Password Store passwords to Nextcloud Passwords''' + '''Import passwords stored in a CSV file to Nextcloud Passwords''' ctx.obj['NcPasswordClient'].import_csv( limit, update, csv_file, encoding, delimiter, quotechar, first_line_fields, fieldnames) diff --git a/pyproject.toml b/pyproject.toml index d6987a5..588bf3c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ Homepage = "https://repos.susurrando.com/adelgado/nc_password_client" [project] name = "nc_password_client" -version = "0.0.2" +version = "0.0.3" description = "Nextcloud Password client" readme = "README.md" authors = [{ name = "Antonio J. Delgado", email = "ad@susurrando.com" }] diff --git a/setup.cfg b/setup.cfg index 6b4e507..82e3605 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = nc_password_client -version = 0.0.2 +version = 0.0.3 [options] packages = nc_password_client