From 6dde4dd0bc5e5f91f89587c75a30c9ef7a24494c Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Wed, 6 Nov 2024 23:23:27 -0600 Subject: package as a cli app --- yoshi_cli.egg-info/PKG-INFO | 197 ++++++++++++++++++++++++++++++++ yoshi_cli.egg-info/SOURCES.txt | 15 +++ yoshi_cli.egg-info/dependency_links.txt | 1 + yoshi_cli.egg-info/entry_points.txt | 2 + yoshi_cli.egg-info/top_level.txt | 1 + 5 files changed, 216 insertions(+) create mode 100644 yoshi_cli.egg-info/PKG-INFO create mode 100644 yoshi_cli.egg-info/SOURCES.txt create mode 100644 yoshi_cli.egg-info/dependency_links.txt create mode 100644 yoshi_cli.egg-info/entry_points.txt create mode 100644 yoshi_cli.egg-info/top_level.txt (limited to 'yoshi_cli.egg-info') diff --git a/yoshi_cli.egg-info/PKG-INFO b/yoshi_cli.egg-info/PKG-INFO new file mode 100644 index 0000000..085f3f6 --- /dev/null +++ b/yoshi_cli.egg-info/PKG-INFO @@ -0,0 +1,197 @@ +Metadata-Version: 2.1 +Name: yoshi-cli +Version: 0.1.1 +Summary: A password manager for the command line. +Author-email: Christian Cleberg +Project-URL: Homepage, https://github.com/ccleberg/yoshi +Project-URL: Issues, https://github.com/ccleberg/yoshi/issues +Classifier: Programming Language :: Python :: 3 +Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) +Classifier: Operating System :: OS Independent +Requires-Python: >=3.8 +Description-Content-Type: text/markdown +License-File: LICENSE + +# Yoshi: A Password Manager + +A simple command-line pass manager, writtin in Python + SQLite3. This tool +allows you to manage accounts and generate random passwords containing ASCII +letters, numbers, and punctuation (min. 8 characters) or XKCD-like passphrases +(min. 3 words). + +Please note that the script is written in Python 3 - you may need to run the +script with the `python3` command instead of `python` if your system uses a +default of Python 2. See the Installation & Usage sections below for more +information. + +# Table of Contents + +- [Installation](#installation) +- [Usage](#usage) + - [Arguments](#arguments) +- [Contributing](#contributing) + +# Installation + +[(Back to top)](#table-of-contents) + +## PyPi + +```bash +pip install yoshi-cli +``` + +## Manual + +To run the script locally, run the following commands: + +```bash +git clone REPO_URL +cd yoshi +pip3 install -r requirements.txt +python3 src/yoshi/cli.py --help +``` + +# Usage + +[(Back to top)](#table-of-contents) + +All commands can be passed to the program with the following template: +`python3 src/yoshi/cli.py ` + +![Yoshi CLI Help](./examples/yoshi-help.png) + +## Arguments + +### Summary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentShortcutExplanation
helphPrint the welcome message
newnCreate a new account
listlList all saved accounts
editeEdit a saved account (see below for required flags)
deletedDelete a saved account (see below for required flags)
purgeN/APurge all accounts and delete the vault
encryptN/AEncrypt the vault database (see below for required flags)
decryptN/ADecrypt the vault database (see below for required flags)
+ +#### Flags + +Flags for the `edit`, `e` command - both are required: + + + + + + + + + + + + + + + + + + + + + +
ArgumentShortcutExplanation
--uuid-uProvide the account UUID to edit
--field-fProvide the account field to edit
+ +Flags for the `delete`, `d` command - this flag is required: + + + + + + + + + + + + + + + + +
ArgumentShortcutExplanation
--uuid-uProvide the account UUID to delete
+ +Flags for the `encrypt` or `decrypt` command - you must provide at least one +when encrypting, none are required when decrypting: + + + + + + + + + + + + + + + + + + + + + +
ArgumentShortcutExplanation
--generate-gWhen encrypting, generate a new key
--keyfile-kWhen encrypting or decrypting, provide the path to a saved key file
+ +![Yoshi CLI New Account](./examples/yoshi-example.png) + +# Contributing + +[(Back to top)](#table-of-contents) + +Any and all contributions are welcome. Feel free to fork the project, add +features, and submit a pull request. diff --git a/yoshi_cli.egg-info/SOURCES.txt b/yoshi_cli.egg-info/SOURCES.txt new file mode 100644 index 0000000..62143a6 --- /dev/null +++ b/yoshi_cli.egg-info/SOURCES.txt @@ -0,0 +1,15 @@ +LICENSE +README.md +pyproject.toml +yoshi/__init__.py +yoshi/__main__.py +yoshi/account.py +yoshi/cli.py +yoshi/crypto.py +yoshi/database.py +yoshi/process.py +yoshi_cli.egg-info/PKG-INFO +yoshi_cli.egg-info/SOURCES.txt +yoshi_cli.egg-info/dependency_links.txt +yoshi_cli.egg-info/entry_points.txt +yoshi_cli.egg-info/top_level.txt \ No newline at end of file diff --git a/yoshi_cli.egg-info/dependency_links.txt b/yoshi_cli.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/yoshi_cli.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/yoshi_cli.egg-info/entry_points.txt b/yoshi_cli.egg-info/entry_points.txt new file mode 100644 index 0000000..cb6e7c1 --- /dev/null +++ b/yoshi_cli.egg-info/entry_points.txt @@ -0,0 +1,2 @@ +[console_scripts] +yoshi = yoshi.cli:yoshi diff --git a/yoshi_cli.egg-info/top_level.txt b/yoshi_cli.egg-info/top_level.txt new file mode 100644 index 0000000..017a863 --- /dev/null +++ b/yoshi_cli.egg-info/top_level.txt @@ -0,0 +1 @@ +yoshi -- cgit v1.2.3-70-g09d2