adelgado/nc_password_client
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update readme and increase version

Browse source
This commit is contained in:
Antonio J. Delgado 2024-11-22 14:56:20 +02:00
parent f539617594
commit b0a2e83795
4 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -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

2
nc_password_client/nc_password_client.py
View file

@ -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)

2
pyproject.toml
View file

@ -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" }]

2
setup.cfg
View file

@ -1,6 +1,6 @@
[metadata]
name = nc_password_client
version = 0.0.2
version = 0.0.3
[options]
packages = nc_password_client