Convert README.nfo to README.org !1

merged merged by cmc on 2026-08-31 22:39 UTC · krz/daily-poem:nfo-to-org into main

3 files changed, +64 −28

Layout: unified · split

.github/workflows/test.yml added +38

		@@ -0,0 +1,38 @@
	1	name: Test
	2
	3	# main.py had never run: it referenced recipient_email where the variable was
	4	# recipient_emails, so it raised NameError before sending anything. Nothing
	5	# would have caught that — ruff's F821 does, in a second.
	6	on:
	7	pull_request:
	8	push:
	9	branches: [main]
	10
	11	permissions:
	12	contents: read
	13
	14	jobs:
	15	test:
	16	runs-on: ubuntu-latest
	17	steps:
	18	- uses: actions/checkout@v7
	19
	20	- uses: actions/setup-python@v7
	21	with:
	22	python-version: '3.11'
	23
	24	- name: Install
	25	run: pip install -r requirements-dev.txt
	26
	27	- uses: astral-sh/ruff-action@v3.2.2
	28	with:
	29	version: "0.16.4"
	30
	31	- name: Lint
	32	run: ruff check --no-fix
	33
	34	- name: Format
	35	run: ruff format --check
	36
	37	- name: Tests
	38	run: python -m pytest -q

README.nfo deleted −28

		@@ -1,28 +0,0 @@
1		┌──────────────────────────────────────────────────────────────┐
2		│ D A I L Y P O E M [ KRZ ] krz.sh │
3		└──────────────────────────────────────────────────────────────┘
4
5		WHAT
6		python program. requests a random poem from the poetrydb api and
7		emails it to a configured list of addresses.
8
9		REQUIRES
10		python, and a way to send mail (e.g. mailutils on debian).
11
12		RUN
13		git clone <REPO_URL>
14		cd daily-poem
15		pip install -r requirements.txt
16
17		edit main.py and set:
18		- sender_email: the from address
19		- recipient_emails: a list of to addresses
20		- smtp_server: smtp host, defaults to localhost
21
22		then:
23
24		python main.py
25
26		┌──────────────────────────────────────────────────────────────┐
27		│ krz.sh │
28		└──────────────────────────────────────────────────────────────┘

README.org added +26

		@@ -0,0 +1,26 @@
	1	#+title: daily poem
	2
	3	* what
	4	python program. requests a random poem from the poetrydb api and
	5	emails it to a configured list of addresses.
	6
	7	* requires
	8	python, and a way to send mail (e.g. mailutils on debian).
	9
	10	* run
	11	#+begin_src sh
	12	git clone <REPO_URL>
	13	cd daily-poem
	14	pip install -r requirements.txt
	15	#+end_src
	16
	17	edit main.py and set:
	18	- sender_email: the from address
	19	- recipient_emails: a list of to addresses
	20	- smtp_server: smtp host, defaults to localhost
	21
	22	- then:
	23
	24	#+begin_src sh
	25	python main.py
	26	#+end_src