Relaunched project

Author: Wandersalamander

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: "0 6 * * 1"  # Every Monday at 06:00 UTC
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[test]"
+
+      - name: Run tests with coverage
+        run: >
+          python -m pytest tests/ -v --tb=short
+          --cov --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false

.github/workflows/lint.yml

@@ -0,0 +1,47 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  ruff:
+    name: Ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Ruff
+        run: pip install ruff
+
+      - name: Ruff check
+        run: ruff check .
+
+      - name: Ruff format check
+        run: ruff format --check .
+
+  pre-commit:
+    name: Pre-commit hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install system dependencies for local hooks
+        run: pip install ty
+
+      - uses: pre-commit/action@v3.0.1

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build & Publish
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -0,0 +1,48 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: requirements-txt-fixer
+    - id: detect-private-key
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v3.2.0
+    hooks:
+    -   id: setup-cfg-fmt
+-   repo: https://github.com/asottile/add-trailing-comma
+    rev: v4.0.0
+    hooks:
+    -   id: add-trailing-comma
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+    -   id: pyupgrade
+        args: [--py310-plus]
+
+- repo: https://github.com/PyCQA/isort
+  rev: 8.0.1
+  hooks:
+    - id: isort
+      args: [ "--line-length", "78", "--profile", "black" ]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.15.5
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+
+- repo: local
+  hooks:
+    - id: ty
+      name: ty type check
+      entry: ty check
+      language: system
+      types: [python]
+      pass_filenames: false

.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+- id: content-tree-generator
+  name: Content Tree Generator
+  entry: content-tree-generator
+  language: python
+  files: \.py$
+  pass_filenames: false

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+Thanks for your interest in contributing! This guide will help you get
+started.
+
+## Development Setup
+
+1. **Clone the repository**
+
+   ```bash
+   git clone https://github.com/Wandersalamander/python-content-tree-generator.git
+   cd python-content-tree-generator
+   ```
+
+2. **Create a virtual environment**
+
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate   # Linux / macOS
+   .venv\Scripts\activate      # Windows
+   ```
+
+3. **Install in editable mode with dev and test extras**
+
+   ```bash
+   pip install -e ".[dev,test]"
+   ```
+
+4. **Install the pre-commit hooks**
+
+   ```bash
+   pre-commit install
+   ```
+
+## Running Tests
+
+```bash
+pytest
+```
+
+With coverage:
+
+```bash
+pytest --cov --cov-report=term-missing
+```
+
+## Code Standards
+
+- **Formatting & linting** are handled by [Ruff](https://github.com/astral-sh/ruff).
+- **Type checking** is done with [ty](https://github.com/astral-sh/ty).
+- **Pre-commit hooks** run automatically on every commit. You can also run
+  them manually:
+
+  ```bash
+  pre-commit run --all-files
+  ```
+
+- All code must include type annotations and pass the type checker.
+- Aim for clear, single-responsibility functions with docstrings.
+
+## Submitting Changes
+
+1. Fork the repository and create a feature branch from `main`.
+2. Make your changes and add tests where appropriate.
+3. Ensure all checks pass (`pre-commit run --all-files && pytest`).
+4. Open a pull request with a clear description of the change.
+
+## Reporting Issues
+
+Please use [GitHub Issues](https://github.com/Wandersalamander/python-content-tree-generator/issues)
+to report bugs or request features. Include:
+
+- Steps to reproduce (for bugs).
+- Expected vs. actual behaviour.
+- Python version and OS.