{"id":16157773,"url":"https://github.com/leynier/python-template","last_synced_at":"2025-10-25T19:12:12.272Z","repository":{"id":54733252,"uuid":"318385544","full_name":"leynier/python-template","owner":"leynier","description":"Python template with CI/CD ready for production","archived":false,"fork":false,"pushed_at":"2021-08-30T14:14:58.000Z","size":295,"stargazers_count":34,"open_issues_count":11,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-15T23:17:58.727Z","etag":null,"topics":["boilerplate","ci-cd","codecov","cookiecutter","fastapi","fastapi-template","github-actions","github-pages","github-template","github-workflows","mkdocs","mkdocs-material","opensource","python","python-3","python-poetry","python-template","python3","template","typer"],"latest_commit_sha":null,"homepage":"","language":"Makefile","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/leynier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-04T02:58:20.000Z","updated_at":"2023-12-17T03:10:08.000Z","dependencies_parsed_at":"2022-08-14T01:10:28.434Z","dependency_job_id":null,"html_url":"https://github.com/leynier/python-template","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leynier%2Fpython-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leynier%2Fpython-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leynier%2Fpython-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leynier%2Fpython-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leynier","download_url":"https://codeload.github.com/leynier/python-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243950792,"owners_count":20373664,"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":["boilerplate","ci-cd","codecov","cookiecutter","fastapi","fastapi-template","github-actions","github-pages","github-template","github-workflows","mkdocs","mkdocs-material","opensource","python","python-3","python-poetry","python-template","python3","template","typer"],"created_at":"2024-10-10T01:50:35.932Z","updated_at":"2025-10-25T19:12:12.217Z","avatar_url":"https://github.com/leynier.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python Template\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n[![Last commit](https://img.shields.io/github/last-commit/leynier/python-template.svg?style=flat)](https://github.com/leynier/python-template/commits)\n[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/leynier/python-template)](https://github.com/leynier/python-template/commits)\n[![Github Stars](https://img.shields.io/github/stars/leynier/python-template?style=flat\u0026logo=github)](https://github.com/leynier/python-template/stargazers)\n[![Github Forks](https://img.shields.io/github/forks/leynier/python-template?style=flat\u0026logo=github)](https://github.com/leynier/python-template/network/members)\n[![Github Watchers](https://img.shields.io/github/watchers/leynier/python-template?style=flat\u0026logo=github)](https://github.com/leynier/python-template)\n[![Website](https://img.shields.io/website?up_message=online\u0026url=https%3A%2F%2Fleynier.github.io/python-template)](https://leynier.github.io/python-template)\n[![GitHub contributors](https://img.shields.io/github/contributors/leynier/python-template)](https://github.com/leynier/python-template/graphs/contributors)\n\nPython template with CI/CD ready for production\n\n## Branches\n\n- [main](https://github.com/leynier/python-template): For libraries and/or console applications\n- [typer](https://github.com/leynier/python-template): Command line interfaces implemented with [Typer](https://typer.tiangolo.com)\n- [fastapi](https://github.com/leynier/python-template/tree/fastapi): For web applications implemented with [FastAPI](https://fastapi.tiangolo.com)\n\n## Features\n\n### Main Features\n\n- Management of dependencies with [Poetry](https://python-poetry.org)\n- Generation of documentation based on Markdown with [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material)\n- Automatic check of the pythonic style with [flake8](https://flake8.pycqa.org), [black](https://black.readthedocs.io) and [isort](https://pycqa.github.io/isort)\n- Automatic code checking with [pytest](https://pytest.org)\n- Automatic code report with [codecov](https://codecov.io)\n- Automatic code reviews with [deepsource](https://deepsource.io)\n- Automatic publish to [GitHub Releases](https://docs.github.com/es/free-pro-team@latest/github/administering-a-repository/releasing-projects-on-github)\n- Automatic publish to [PyPI](https://pypi.org)\n- Automatic dependency update check with [dependabot](https://github.com/dependabot)\n\n### FastAPI Features\n\n- Configuration for deploy on [Heroku](https://www.heroku.com)\n- Configuration for deploy with [Docker](https://www.docker.com)\n\n\u003e All of the above via [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com)\n\n## Tutorial\n\n### Install `cookiecutter` ([Official Instructions](https://cookiecutter.readthedocs.io/en/latest/installation.html#install-cookiecutter))\n\nAt the command line:\n\n```bash\npython3 -m pip install --user cookiecutter\n```\n\nOr, if you do not have pip:\n\n```bash\neasy_install --user cookiecutter\n```\n\nThough, `pip` is recommended.\n\nOr, if you are using `conda`, first add `conda-forge` to your channels:\n\n```bash\nconda config --add channels conda-forge\n```\n\nOnce the `conda-forge` channel has been enabled, cookiecutter can be installed with:\n\n```bash\nconda install cookiecutter\n```\n\n#### Alternate installations\n\n**Homebrew (Mac OS X only):**\n\n```bash\nbrew install cookiecutter\n```\n\n**Pipx (Linux, OSX and Windows):**\n\n```bash\npipx install cookiecutter\n```\n\n**Debian/Ubuntu:**  \n\n```bash\nsudo apt-get install cookiecutter\n```\n\n#### Upgrading from `0.6.4` to `0.7.0` or greater\n\nFirst, read [History](https://cookiecutter.readthedocs.io/en/latest/HISTORY.html) in detail. There are a lot of major changes. The big ones are:\n\nCookiecutter no longer deletes the cloned repo after generating a project.\n\nCloned repos are saved into `~/.cookiecutters/`.\n\nYou can optionally create a `~/.cookiecutterrc` config file.\n\nUpgrade **Cookiecutter** either with `easy_install`:\n\n```bash\neasy_install --upgrade cookiecutter\n```\n\nOr with pip:\n\n```bash\npython3 -m pip install --upgrade cookiecutter\n```\n\n### Usage\n\nThen, after you have installed `cookiecutter`, execute the following command in the terminal of your choice:\n\n```bash\ncookiecutter gh:leynier/python-template --checkout \u003cbranch\u003e\n```\n\nWhere `\u003cbranch\u003e` can be `main`, `fastapi`, `typer`, etc.\n\n#### Example using FastAPI template\n\n```bash\ncookiecutter gh:leynier/python-template --checkout fastapi\n```\n\n## License\n\nThis project is collaborative and open source under the [MIT license](LICENSE). Contributions are super appreciated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleynier%2Fpython-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleynier%2Fpython-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleynier%2Fpython-template/lists"}