Convert README.nfo to README.org !1

merged merged by cmc on 2026-08-31 22:42 UTC · krz/yoshi-cli:nfo-to-org into main

6 files changed, +216 −47

Layout: unified · split

.github/workflows/codeql.yml added +96

@@ -0,0 +1,96 @@
	1	# For most projects, this workflow file will not need changing; you simply need
	2	# to commit it to your repository.
	3	#
	4	# You may wish to alter this file to override the set of languages analyzed,
	5	# or to provide custom queries or build logic.
	6	#
	7	# ****** NOTE ******
	8	# We have attempted to detect the languages in your repository. Please check
	9	# the `language` matrix defined below to confirm you have the correct set of
	10	# supported CodeQL languages.
	11	#
	12	name: "CodeQL Advanced"
	13
	14	on:
	15	push:
	16	branches: [ "main" ]
	17	pull_request:
	18	branches: [ "main" ]
	19
	20	jobs:
	21	analyze:
	22	name: Analyze (${{ matrix.language }})
	23	# Runner size impacts CodeQL analysis time. To learn more, please see:
	24	# - https://gh.io/recommended-hardware-resources-for-running-codeql
	25	# - https://gh.io/supported-runners-and-hardware-resources
	26	# - https://gh.io/using-larger-runners (GitHub.com only)
	27	# Consider using larger runners or machines with greater resources for possible analysis time improvements.
	28	runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') \|\| 'ubuntu-latest' }}
	29	permissions:
	30	# required for all workflows
	31	security-events: write
	32
	33	# required to fetch internal or private CodeQL packs
	34	packages: read
	35
	36	# only required for workflows in private repositories
	37	actions: read
	38	contents: read
	39
	40	strategy:
	41	fail-fast: false
	42	matrix:
	43	include:
	44	- language: python
	45	build-mode: none
	46	# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
	47	# Use `c-cpp` to analyze code written in C, C++ or both
	48	# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
	49	# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
	50	# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
	51	# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
	52	# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
	53	# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
	54	steps:
	55	- name: Checkout repository
	56	uses: actions/checkout@v4
	57
	58	# Add any setup steps before running the `github/codeql-action/init` action.
	59	# This includes steps like installing compilers or runtimes (`actions/setup-node`
	60	# or others). This is typically only required for manual builds.
	61	# - name: Setup runtime (example)
	62	# uses: actions/setup-example@v1
	63
	64	# Initializes the CodeQL tools for scanning.
	65	- name: Initialize CodeQL
	66	uses: github/codeql-action/init@v3
	67	with:
	68	languages: ${{ matrix.language }}
	69	build-mode: ${{ matrix.build-mode }}
	70	# If you wish to specify custom queries, you can do so here or in a config file.
	71	# By default, queries listed here will override any specified in a config file.
	72	# Prefix the list here with "+" to use these queries and those in the config file.
	73
	74	# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
	75	# queries: security-extended,security-and-quality
	76
	77	# If the analyze step fails for one of the languages you are analyzing with
	78	# "We were unable to automatically build your code", modify the matrix above
	79	# to set the build mode to "manual" for that language. Then modify this step
	80	# to build your code.
	81	# ℹ️ Command-line programs to run using the OS shell.
	82	# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
	83	- if: matrix.build-mode == 'manual'
	84	shell: bash
	85	run: \|
	86	echo 'If you are using a "manual" build mode for one or more of the' \
	87	'languages you are analyzing, replace this with the commands to build' \
	88	'your code, for example:'
	89	echo ' make bootstrap'
	90	echo ' make release'
	91	exit 1
	92
	93	- name: Perform CodeQL Analysis
	94	uses: github/codeql-action/analyze@v3
	95	with:
	96	category: "/language:${{matrix.language}}"

.github/workflows/python-publish.yml added +34

@@ -0,0 +1,34 @@
	1	# This workflow will upload a Python Package using Twine when a release is created
	2	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
	3
	4	name: Upload Python Package
	5
	6	on:
	7	release:
	8	types: [published]
	9
	10	permissions:
	11	contents: read
	12
	13	jobs:
	14	deploy:
	15	runs-on: ubuntu-latest
	16	environment:
	17	name: pypi
	18	url: https://pypi.org/p/yoshi-cli
	19	permissions:
	20	id-token: write
	21	steps:
	22	- uses: actions/checkout@v4
	23	- name: Set up Python
	24	uses: actions/setup-python@v5
	25	with:
	26	python-version: '3.x'
	27	- name: Install dependencies
	28	run: \|
	29	python -m pip install --upgrade pip
	30	pip install build
	31	- name: Build package
	32	run: python -m build
	33	- name: Publish package
	34	uses: pypa/gh-action-pypi-publish@release/v1\ No newline at end of file

.github/workflows/ruff.yml added +37

@@ -0,0 +1,37 @@
	1	name: Ruff
	2
	3	on:
	4	push:
	5	paths:
	6	- '**.py'
	7
	8	jobs:
	9	build:
	10	runs-on: ubuntu-latest
	11	strategy:
	12	matrix:
	13	python-version: ["3.x"]
	14	steps:
	15	- uses: actions/checkout@v4
	16	- name: Set up Python ${{ matrix.python-version }}
	17	uses: actions/setup-python@v5
	18	with:
	19	python-version: ${{ matrix.python-version }}
	20	ref: ${{ github.event.pull_request.head.ref }}
	21	- name: Install dependencies
	22	run: \|
	23	python -m pip install --upgrade pip
	24	pip install pandas dash plotly.express
	25	- name: Install Ruff
	26	uses: astral-sh/ruff-action@v3.2.2
	27	- name: Ruff Actions
	28	run: \|
	29	ruff check --fix
	30	ruff format
	31	- name: Add and Commit
	32	uses: EndBug/add-and-commit@v9
	33	env:
	34	GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	35	with:
	36	default_author: github_actions
	37	pathspec_error_handling: ignore

.mailmap deleted −2

	@@ -1,2 +0,0 @@
1	Christian Cleberg <hello@cleberg.net> <156287552+ccleberg@users.noreply.github.com>
2	Christian Cleberg <hello@cleberg.net> <hello@cmc.pub>

README.nfo deleted −45

	@@ -1,45 +0,0 @@
1	┌──────────────────────────────────────────────────────────────┐
2	│ Y O S H I [ KRZ ] krz.sh │
3	└──────────────────────────────────────────────────────────────┘
4
5	WHAT
6	command-line password manager in python + sqlite3. manages accounts
7	and generates random passwords (ascii, min 8 chars) or xkcd-style
8	passphrases (min 3 words).
9
10	INSTALL
11	pypi:
12
13	pipx install yoshi-cli
14
15	manual:
16
17	git clone REPO_URL
18	cd yoshi-cli
19	pipx install .
20
21	USE
22	yoshi <COMMAND> <FLAG> <PARAMETER>
23
24	commands:
25	--help -h print the welcome message
26	--new -n create an account
27	--list -l list saved accounts
28	--edit -e edit an account (needs --uuid and --field)
29	--delete -d delete an account (needs --uuid)
30	--purge purge all accounts, delete the vault
31	--encrypt encrypt the vault (needs --generate or --keyfile)
32	--decrypt decrypt the vault (optional --keyfile)
33
34	flags:
35	--uuid -u account uuid
36	--field -f account field to edit
37	--generate -g generate a new key when encrypting
38	--keyfile -k path to a saved key file
39
40	CONTRIBUTING
41	fork, add features, open a pull request.
42
43	┌──────────────────────────────────────────────────────────────┐
44	│ krz.sh │
45	└──────────────────────────────────────────────────────────────┘

README.org added +49

@@ -0,0 +1,49 @@
	1	#+title: yoshi
	2
	3	* what
	4	command-line password manager in python + sqlite3. manages accounts
	5	and generates random passwords (ascii, min 8 chars) or xkcd-style
	6	passphrases (min 3 words).
	7
	8	* install
	9	- pypi:
	10
	11	#+begin_src sh
	12	pipx install yoshi-cli
	13	#+end_src
	14
	15	- manual:
	16
	17	#+begin_src sh
	18	git clone REPO_URL
	19	cd yoshi-cli
	20	pipx install .
	21	#+end_src
	22
	23	* use
	24	#+begin_src sh
	25	yoshi <COMMAND> <FLAG> <PARAMETER>
	26	#+end_src
	27
	28	#+begin_example
	29	commands:
	30	--help -h print the welcome message
	31	--new -n create an account
	32	--list -l list saved accounts
	33	--edit -e edit an account (needs --uuid and --field)
	34	--delete -d delete an account (needs --uuid)
	35	--purge purge all accounts, delete the vault
	36	--encrypt encrypt the vault (needs --generate or --keyfile)
	37	--decrypt decrypt the vault (optional --keyfile)
	38	#+end_example
	39
	40	#+begin_example
	41	flags:
	42	--uuid -u account uuid
	43	--field -f account field to edit
	44	--generate -g generate a new key when encrypting
	45	--keyfile -k path to a saved key file
	46	#+end_example
	47
	48	* contributing
	49	fork, add features, open a pull request.