{"id":16551116,"url":"https://github.com/michaelcurrin/py-project-template","last_synced_at":"2026-02-28T02:44:36.246Z","repository":{"id":93179719,"uuid":"157021071","full_name":"MichaelCurrin/py-project-template","owner":"MichaelCurrin","description":"Starter template for a Python app - including CI and docs 🐍 🌠","archived":false,"fork":false,"pushed_at":"2025-02-24T12:36:50.000Z","size":302,"stargazers_count":7,"open_issues_count":16,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T00:22:49.923Z","etag":null,"topics":["boilerplate","python","python3","quickstart","scaffolding","skeleton","starter","template"],"latest_commit_sha":null,"homepage":"https://michaelcurrin.github.io/py-project-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/MichaelCurrin.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-10T21:00:09.000Z","updated_at":"2025-02-24T12:36:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"fa4e0c48-2fac-47ca-86dc-0524b7501c42","html_url":"https://github.com/MichaelCurrin/py-project-template","commit_stats":null,"previous_names":[],"tags_count":13,"template":true,"template_full_name":null,"purl":"pkg:github/MichaelCurrin/py-project-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fpy-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fpy-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fpy-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fpy-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelCurrin","download_url":"https://codeload.github.com/MichaelCurrin/py-project-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fpy-project-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29923428,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"online","status_checked_at":"2026-02-28T02:00:07.010Z","response_time":90,"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":["boilerplate","python","python3","quickstart","scaffolding","skeleton","starter","template"],"created_at":"2024-10-11T19:36:24.933Z","updated_at":"2026-02-28T02:44:36.217Z","avatar_url":"https://github.com/MichaelCurrin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Project Template 🐍 📦\n\u003e Starter template for a Python app - including CI and docs\n\n\u003c!-- Shields generated with https://michaelcurrin.github.io/badge-generator/ --\u003e\n\n[![Python CI](https://github.com/MichaelCurrin/py-project-template/actions/workflows/main.yml/badge.svg)](https://github.com/MichaelCurrin/py-project-template/actions/workflows/main.yml)\n[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/py-project-template?include_prereleases=\u0026sort=semver)](https://github.com/MichaelCurrin/py-project-template/releases/)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\n\n[![Made with Python](https://img.shields.io/badge/Python-\u003e=3.6-blue?logo=python\u0026logoColor=white)](https://python.org \"Go to Python website\")\n\n\u003c!-- You can take these out if you don't care about them in your new project. --\u003e\n[![code style - black](https://img.shields.io/badge/code_style-black-blue)](https://black.readthedocs.io/)\n[![dev dependency - flake8](https://img.shields.io/badge/dev_dependency-flake8-blue)](https://pypi.org/project/flake8)\n[![dev dependency - pylint](https://img.shields.io/badge/dev_dependency-pylint-blue)](https://pypi.org/project/pylint)\n[![dev dependency - mypy](https://img.shields.io/badge/dev_dependency-mypy-blue)](https://pypi.org/project/mypy)\n[![dev dependency - pytest](https://img.shields.io/badge/dev_dependency-pytest-blue)](https://pypi.org/project/pytest)\n\n## Purpose\n\nThis project provides a template for a Python application, enabling you to get up and running fast with local development and then move quickly when you want deploy your app to the cloud with confidence.\n\nIt includes a solid setup, from installing packages to running code quality checks locally and with GitHub Actions.\n\nWhat you get:\n\n- [x] Generic Python app code in [pyproject](/pyproject/), with sample tests in [tests](/tests/).\n- [x] Sample documentation.\n- [x] [Makefile](/Makefile) for running `make` commands (for macOS and Linux).\n- [x] Boiletplate for package management.\n    - [x] Requirements files for prod packages and dev packages managed with `pip` and option to use `make` commands with `pip`.\n    - [x] Config files for installing prod and dev packages with `poetry`.\n- [x] Code quality checks - `flake8`, `pylint`, `mypy` (type checking), and `pytest`, including `make` commands and configs for each.\n- [x] Git push hooks, to run checks on pushing.\n- [x] GitHub Actions pipeline config.\n- [x] Configs - VS Code, EditorConfig, and a Git ignore file.\n\n\n## How to use this starter project\n\nCreate your own repo from this one:\n\n\u003cdiv align=\"center\"\u003e\n\n[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/py-project-template/generate)\n\n\u003c/div\u003e\n\nSee the [Template Notes](/docs/template-notes/) part of the docs for more info on how to use this template. And for links to my other templates.\n\n\n## Sample usage\n\n_TODO: Add just a few lines to show how to use your application. Such as a Python or shell snippet._\n\n```sh\n$ foo-bar --help\n```\n\n```sh\n$ make install\n$ make run\n```\n\n\n```python\nimport foo\n\nfoo.bar(123)\n```\n\n\n\n## Documentation\n\u003e How to install and run this project\n\n\u003cdiv align=\"center\"\u003e\n\n[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://michaelcurrin.github.io/py-project-template/)\n\n\u003c/div\u003e\n\n\n## License\n\nReleased under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).\n\nA copy of the original license must be included if a significant portion of this template or project is used. You could rename it to `LICENSE-source` and then include your own `LICENSE` file with your name.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fpy-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcurrin%2Fpy-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fpy-project-template/lists"}