getred 0.1.5__tar.gz → 0.1.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
getred-0.1.6/AGENTS.md ADDED
@@ -0,0 +1,31 @@
1
+ # Repository Guidelines
2
+
3
+ ## Project Structure & Module Organization
4
+ - `src/getred/`: Python package (CLI + fetch/parse/save pipeline)
5
+ - `cli.py` (Click entrypoint), `fetcher.py` (httpx client), `parser.py`, `models.py`, `utils.py`
6
+ - `tests/`: pytest suite and fixtures (`tests/conftest.py`)
7
+ - `pyproject.toml`: packaging (hatchling), dependencies, and pytest config
8
+ - `.github/workflows/`: CI (PR tests, version bump check, publish)
9
+
10
+ ## Build, Test, and Development Commands
11
+ - Create a venv: `python -m venv .venv && source .venv/bin/activate`
12
+ - Install (editable + tests): `python -m pip install -U pip && python -m pip install -e ".[test]"`
13
+ - Run locally: `getred "<thread_url>"` or `python -m getred "<thread_url>"`
14
+ - Run tests: `pytest`
15
+ - Build artifacts (sdist/wheel): `python -m pip install build && python -m build`
16
+
17
+ ## Coding Style & Naming Conventions
18
+ - Python 3.12+ (CI uses 3.12); keep code compatible with the declared minimum.
19
+ - 4-space indentation, PEP 8, and small focused functions.
20
+ - Naming: `snake_case` (functions/vars), `PascalCase` (classes), `UPPER_SNAKE_CASE` (constants).
21
+ - Prefer `pathlib.Path` for file paths and keep dependencies minimal (edit `pyproject.toml`).
22
+
23
+ ## Testing Guidelines
24
+ - Use pytest; keep tests in `tests/` and name files `test_*.py`.
25
+ - Prefer deterministic tests: avoid live Reddit calls (mock httpx or use fixtures).
26
+ - Add/adjust tests alongside behavior changes (parser edge-cases, URL validation, output shape).
27
+
28
+ ## Commit & Pull Request Guidelines
29
+ - Commit messages follow a Conventional Commits-style prefix used in this repo: `feat: ...`, `fix: ...`, `docs: ...`, `chore: ...`, `cicd: ...`.
30
+ - PRs should include: what changed, why, how to test (`pytest`), and any user-facing CLI/output changes.
31
+ - Versioning: PRs to `master` must bump `version = "..."` in `pyproject.toml` (CI enforces this); keep other version strings (e.g. `src/getred/__init__.py#__version__`) consistent when releasing.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: getred
3
- Version: 0.1.5
3
+ Version: 0.1.6
4
4
  Summary: A CLI tool to fetch Reddit threads and save them as structured JSON
5
5
  Project-URL: Homepage, https://github.com/mgelei/getred
6
6
  Project-URL: Issues, https://github.com/mgelei/getred/issues
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "getred"
7
- version = "0.1.5"
7
+ version = "0.1.6"
8
8
  description = "A CLI tool to fetch Reddit threads and save them as structured JSON"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.8"
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes