README cleanup and minor fixes
This commit is contained in:
parent
5e457d8da6
commit
70b8ced056
1 changed files with 18 additions and 25 deletions
43
README.md
43
README.md
|
@ -3,17 +3,17 @@
|
|||
Source is available [at GitHub](https://github.com/reinefjord/pass2csv).
|
||||
|
||||
You can install it directly from PyPI with pip:
|
||||
```
|
||||
python3 -m pip install --user pass2csv
|
||||
```
|
||||
|
||||
python3 -m pip install --user pass2csv
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
$ pass2csv --help
|
||||
usage: pass2csv.py [-h] [-a] [-b GPGBINARY] [-x] [-l LOGIN_FIELDS [LOGIN_FIELDS ...]] [-u]
|
||||
[-e EXCLUDE_ROWS [EXCLUDE_ROWS ...]]
|
||||
path
|
||||
usage: pass2csv [-h] [-a] [-b GPGBINARY] [-x] [-l LOGIN_FIELDS [LOGIN_FIELDS ...]] [-u]
|
||||
[-e EXCLUDE_ROWS [EXCLUDE_ROWS ...]]
|
||||
path
|
||||
|
||||
positional arguments:
|
||||
path path to the password-store folder to export
|
||||
|
@ -29,7 +29,6 @@ optional arguments:
|
|||
-u, --get-url match row starting with 'url:' and extract it (only used with -x)
|
||||
-e EXCLUDE_ROWS [EXCLUDE_ROWS ...], --exclude-rows EXCLUDE_ROWS [EXCLUDE_ROWS ...]
|
||||
regexps to exclude from the notes field (only used with -x)
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
@ -81,7 +80,7 @@ There are two ways to export CSV data:
|
|||
sites, example, user_name, password123, example.com, "email: user@example.com\nsome_note"
|
||||
|
||||
- `user_name` was chosen because `username` was the first argument to `-l`.
|
||||
- Both logn and URL fields were excluded from the notes field because they
|
||||
- Both login and URL fields were excluded from the notes field because they
|
||||
were used in another field.
|
||||
- `---` Was not included in the notes field because it was matched by `-e`.
|
||||
|
||||
|
@ -100,36 +99,30 @@ There are two ways to export CSV data:
|
|||
## Development
|
||||
Create a virtual environment:
|
||||
|
||||
```sh
|
||||
python3 -m venv venv
|
||||
```
|
||||
python3 -m venv venv
|
||||
|
||||
Activate the environment:
|
||||
|
||||
```sh
|
||||
. venv/bin/activate
|
||||
```
|
||||
. venv/bin/activate
|
||||
|
||||
Now you may either use `pip` directly to install the dependencies, or
|
||||
you can install `pip-tools`. The latter is recommended.
|
||||
|
||||
|
||||
### pip
|
||||
|
||||
```sh
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
|
||||
|
||||
### pip-tools
|
||||
[pip-tools](https://github.com/jazzband/pip-tools) can keep your virtual
|
||||
environment in sync with the `requirements.txt` file, as well as compiling a
|
||||
new `requirements.txt` when adding/removing a dependency in `requirements.in`.
|
||||
environment in sync with the `requirements.txt` file, as well as
|
||||
compiling a new `requirements.txt` when adding/removing a dependency in
|
||||
`requirements.in`.
|
||||
|
||||
It is recommended that pip-tools is installed within the virutal
|
||||
It is recommended that pip-tools is installed within the virtual
|
||||
environment.
|
||||
|
||||
```sh
|
||||
pip install pip-tools
|
||||
pip-compile # only necessary when adding/removing a dependency
|
||||
pip-sync
|
||||
```
|
||||
pip install pip-tools
|
||||
pip-compile # only necessary when adding/removing a dependency
|
||||
pip-sync
|
||||
|
|
Loading…
Reference in a new issue