{"id":39446325,"url":"https://github.com/mbeacom/python-template","last_synced_at":"2026-01-18T04:25:09.924Z","repository":{"id":178480146,"uuid":"661918820","full_name":"mbeacom/python-template","owner":"mbeacom","description":"This project is an opinionated python template","archived":false,"fork":false,"pushed_at":"2025-04-24T19:34:44.000Z","size":621,"stargazers_count":3,"open_issues_count":9,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-24T20:36:52.416Z","etag":null,"topics":["cli","example-project","examples","poetry","python","python-3-11","python-3-12","python-3-13","python3","template","templates","typer"],"latest_commit_sha":null,"homepage":"https://mbeacom.github.io/python-template/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mbeacom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-07-04T01:15:53.000Z","updated_at":"2024-12-12T02:36:11.000Z","dependencies_parsed_at":"2024-02-06T12:54:50.272Z","dependency_job_id":"980b0537-bcaf-4fb3-828b-9528158a4106","html_url":"https://github.com/mbeacom/python-template","commit_stats":null,"previous_names":["mbeacom/python-template"],"tags_count":11,"template":true,"template_full_name":null,"purl":"pkg:github/mbeacom/python-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbeacom%2Fpython-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbeacom%2Fpython-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbeacom%2Fpython-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbeacom%2Fpython-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbeacom","download_url":"https://codeload.github.com/mbeacom/python-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbeacom%2Fpython-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28529529,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"online","status_checked_at":"2026-01-18T02:00:07.578Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","example-project","examples","poetry","python","python-3-11","python-3-12","python-3-13","python3","template","templates","typer"],"created_at":"2026-01-18T04:25:09.851Z","updated_at":"2026-01-18T04:25:09.916Z","avatar_url":"https://github.com/mbeacom.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-template\n\n[![Validation Workflow](https://github.com/mbeacom/python-template/actions/workflows/validate.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/mbeacom/python-template/actions/workflows/validate.yaml)\n[![Pre-Commit Checks Workflow](https://github.com/mbeacom/python-template/actions/workflows/pre-commit.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/mbeacom/python-template/actions/workflows/pre-commit.yaml)\n[![Coverage Status](https://codecov.io/github/mbeacom/python-template/coverage.svg?branch=main)](https://codecov.io/github/mbeacom/python-template?branch=main)\n[![PyPi](https://img.shields.io/pypi/v/python-template-x)](https://pypi.org/project/python-template-x/)\n[![CodeQL](https://github.com/mbeacom/python-template/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/mbeacom/python-template/actions/workflows/github-code-scanning/codeql)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/mbeacom/python-template/badge)](https://securityscorecards.dev/viewer/?uri=github.com/mbeacom/python-template)\n\nThis project is an opinionated python template.\n\n## Usage\n\nThis project uses:\n\n- [poetry](https://python-poetry.org/) for dependency management and packaging.\n- [poethepoet](https://poethepoet.natn.io/) for task running.\n- [pytest](https://docs.pytest.org/en/stable/) for testing.\n- [black](https://black.readthedocs.io/en/stable/) for auto-formatting.\n- [mypy](https://mypy.readthedocs.io/en/stable/) for static type checking.\n- [pre-commit](https://pre-commit.com/) for git hooks.\n- [ruff](https://beta.ruff.rs/docs/) for linting.\n- [mkdocs](https://www.mkdocs.org/) for documentation.\n\nEnsure you have installed the relevant dependencies before continuing.\n\n### Install dependencies\n\n```bash\npoetry install\n```\n\n### Run tests\n\n```bash\npoetry run poe test\n```\n\n## GitHub Actions Setup\n\n### Validation Workflow\n\n#### CodeCov.io\n\nThe workflow is automatically setup to pass along coverage reports to CodeCov.io.\nYou must set the `CODECOV_TOKEN` secret in your repository settings.\nOtherwise, disable the routine in the `.github/workflows/validate.yaml` file.\n\n### Publishing Workflow\n\nEnsure you have Discussions enabled in your repository settings,\nor remove `discussion_category_name` from the `.github/workflows/publish.yaml` file.\n\n#### PyPi\n\nThe workflow is automatically setup to publish to PyPi.\nYou must set the `POETRY_PYPI_TOKEN_PYPI` secret in your repository settings.\nOtherwise, disable the routine in the `.github/workflows/publish.yaml` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbeacom%2Fpython-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbeacom%2Fpython-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbeacom%2Fpython-template/lists"}