Skip to content

Commit 6b8ee72

Browse files
snapsynapseclaude
andcommitted
build: consolidate deps into pyproject.toml; drop requirements*.txt
pyproject.toml is now the single source of truth for dependencies. The two requirements files duplicated what [project] and [project.optional-dependencies].dev already declared, and in practice they would have drifted. Removed: - requirements.txt - tests/requirements-dev.txt Updated to use ``pip install -e ".[dev]"``: - .github/workflows/tests.yml (CI install step) - CONTRIBUTING.md (local dev setup) - README.md troubleshooting block - tests/EVALS.md (historical run instructions) CONTRIBUTING.md also now documents the logging module as the established convention (not a "future commit"), and adds the pre-push ruff check that CI enforces. No behavior change. Tests still pass (58 / 1 skipped). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9313792 commit 6b8ee72

6 files changed

Lines changed: 14 additions & 16 deletions

File tree

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
- name: Install dependencies
2626
run: |
2727
python -m pip install --upgrade pip
28-
pip install -r requirements.txt -r tests/requirements-dev.txt
28+
pip install -e ".[dev]"
2929
3030
- name: Lint (ruff)
3131
run: |

CONTRIBUTING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ Thanks for your interest. A few conventions that keep the repo easy to maintain.
44

55
## Before you open a PR
66

7-
1. Install dev dependencies and run the test suite locally:
7+
1. Install in editable mode with dev extras and run the test suite locally:
88
```bash
99
python -m venv .venv && source .venv/bin/activate
10-
pip install -r requirements.txt -r tests/requirements-dev.txt
10+
pip install -e ".[dev]"
1111
pytest tests/ -v
1212
```
13-
Expect 30+ passed, 1 skipped (the live smoke test is opt-in via `SUBSTACK2MD_LIVE=1`).
13+
Expect 50+ passed, 1 skipped (the live smoke test is opt-in via `SUBSTACK2MD_LIVE=1`).
14+
15+
2. Before pushing, run the linter the way CI does:
16+
```bash
17+
ruff check substack2md tests
18+
ruff format --check substack2md tests
19+
```
1420

1521
2. If you changed behavior that users see, update `README.md` and `CHANGELOG.md` in the same PR.
1622

@@ -27,7 +33,8 @@ Thanks for your interest. A few conventions that keep the repo easy to maintain.
2733

2834
- Follow existing code style. Indent is 4 spaces.
2935
- Type hints on new function signatures are encouraged but not strictly required yet.
30-
- Use the `logging` module for user-visible output (future commit). `print()` is fine for CLI-level messages in `main()`.
36+
- Use the `logging` module for diagnostics. The module-level `log` object in `substack2md._core` is the shared logger; reserve `print()` for boot-time errors that happen before logging is configured.
37+
- Run `ruff check` and `ruff format` before pushing; CI enforces both.
3138
- No em dashes in user-facing strings (markdown output, CLI help, README, docs).
3239

3340
## Tests

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ This is opt-in and requires no additional authentication; the metadata endpoint
229229

230230
### "Missing modules" error
231231
```bash
232-
pip install -r requirements.txt
232+
pip install .
233233
```
234234

235235
### URLs not being converted to wikilinks

requirements.txt

Lines changed: 0 additions & 7 deletions
This file was deleted.

tests/EVALS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Base: snapsynapse:main
99
```bash
1010
python -m venv .venv
1111
source .venv/bin/activate
12-
pip install -r requirements.txt -r tests/requirements-dev.txt
12+
pip install -e ".[dev]"
1313

1414
# Fetch PR code into a local checkout
1515
git remote add drew https://github.com/drewid74/substack2md.git

tests/requirements-dev.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)