{"id":29195431,"url":"https://github.com/julesgirardon/spyrk","last_synced_at":"2026-04-17T05:02:21.563Z","repository":{"id":301366645,"uuid":"1009017417","full_name":"JulesGirardon/spyrk","owner":"JulesGirardon","description":"Spyrk is a Python project designed to facilitate development and TDD practice.","archived":false,"fork":false,"pushed_at":"2025-06-26T13:18:31.000Z","size":9,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-26T14:24:31.200Z","etag":null,"topics":["bash","black","flake8","isort","mypy","pytest","python","tdd"],"latest_commit_sha":null,"homepage":"https://jules-girardon.vercel.app","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JulesGirardon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-26T12:54:56.000Z","updated_at":"2025-06-26T13:21:27.000Z","dependencies_parsed_at":"2025-06-26T14:36:11.224Z","dependency_job_id":null,"html_url":"https://github.com/JulesGirardon/spyrk","commit_stats":null,"previous_names":["julesgirardon/spyrk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/JulesGirardon/spyrk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulesGirardon%2Fspyrk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulesGirardon%2Fspyrk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulesGirardon%2Fspyrk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulesGirardon%2Fspyrk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JulesGirardon","download_url":"https://codeload.github.com/JulesGirardon/spyrk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JulesGirardon%2Fspyrk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263077630,"owners_count":23410167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","black","flake8","isort","mypy","pytest","python","tdd"],"created_at":"2025-07-02T05:04:24.495Z","updated_at":"2025-10-25T02:33:34.809Z","avatar_url":"https://github.com/JulesGirardon.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spyrk\n\nSpyrk is a Python project designed to facilitate modern development workflows, automation, and Test-Driven Development (TDD).\n\n---\n\n## 🚀 Quick Start\n\n1. **Clone the repository**\n\n   ```bash\n   git clone git@github.com:JulesGirardon/spyrk.git\n   cd spyrk\n   ```\n\n2. **Install dependencies and set up the environment**\n\n   ```bash\n   ./install\n   ```\n---\n\n## 🛠️ Requirements\n\n- Python 3.12 or higher\n- [uv](https://github.com/astral-sh/uv) (for fast dependency management)\n- Git\n\n---\n\n## 📂 Project Structure\n\n- `bin/` : Automation scripts for development, testing, linting, type checking, documentation, and cache clearing.\n- `src/` : Main source code.\n- `tests/` : Unit and integration tests.\n- `docs/` : Sphinx documentation.\n- `.venv/` : Virtual environment (created automatically).\n- `pyproject.toml` : Project configuration and dependencies.\n\n---\n\n## ⚡ Main Commands\n\nAll automation scripts are in the `bin/` directory.  \nRun them from the project root (with the virtual environment activated):\n\n| Script       | Description                                                  |\n| ------------ | ------------------------------------------------------------ |\n| `mypycheck`  | Run type checking with mypy                                  |\n| `ruffcheck`  | Lint and auto-fix code with Ruff                             |\n| `tests`      | Run tests with coverage (HTML report)                        |\n| `make_doc`   | Generate documentation with Sphinx                           |\n| `clearcache` | Remove all Python cache files and folders                    |\n\nScripts in main directory.\n\n| Script       | Description                                                  |\n| ------------ | ------------------------------------------------------------ |\n| `install`    | Install all dependencies (dev, lint, tests…)                 |\n| `codecheck`  | Run type checks (mypy), lint (ruff), and tests with coverage |\n\nExample usage:\n\n```bash\n./codecheck\nbin/tests\nbin/make_doc\nbin/clearcache\n```\n\n---\n\n## 🧪 Testing\n\n- Tests are in the `tests/` directory.\n- Run all tests with coverage:\n  ```bash\n  bin/tests\n  ```\n- Coverage HTML report is generated in `htmlcov`.\n\n---\n\n## 📚 Documentation\n\n- Documentation is generated with Sphinx.\n- To build the docs:\n  ```bash\n  bin/make_doc\n  ```\n- Output is in `docs/build/html`.\n\n---\n\n## 🧹 Cache Cleaning\n\nRemove all Python cache files and folders:\n\n```bash\nbin/clearcache\n```\n\n---\n\n## 🏆 Quality Tools\n\n- **Type Checking**: mypy (`bin/mypycheck`)\n- **Linting \u0026 Auto-fix**: Ruff (`bin/ruffcheck`)\n- **Testing \u0026 Coverage**: pytest (`bin/tests`)\n- **Documentation**: Sphinx (`bin/make_doc`)\n\n---\n\n## 💡 Recommended Workflow\n\n1. Install dependencies: `./install`\n2. Check code quality: `bin/codecheck`\n3. Run tests: `bin/tests`\n4. Generate docs: `bin/make_doc`\n5. Clean cache: `bin/clearcache`\n\n---\n\n## 📄 Example `.gitignore`\n\nHere is a recommended `.gitignore` for your project:\n\n````gitignore\n# Python cache\n__pycache__/\n*.pyc\n*.pyo\n*.pyd\n.mypy_cache/\n.pytest_cache/\n.ruff_cache/\n.coverage\nhtmlcov/\n.cache/\n\n# Virtual environments\n.venv/\nenv/\nvenv/\n\n# Sphinx build\ndocs/build/\ndocs/_build/\n\n# IDE files\n.vscode/\n.idea/\n*.swp\n\n# OS files\n.DS_Store\nThumbs.db\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulesgirardon%2Fspyrk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjulesgirardon%2Fspyrk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjulesgirardon%2Fspyrk/lists"}