{"id":29118065,"url":"https://github.com/thermophase-fcsrg/blank-python-project","last_synced_at":"2025-06-29T12:32:52.437Z","repository":{"id":79266567,"uuid":"150047893","full_name":"ThermoPhase-FCSRG/blank-python-project","owner":"ThermoPhase-FCSRG","description":"A starting point to structure a Python project from the scratch.","archived":false,"fork":false,"pushed_at":"2025-06-23T18:17:03.000Z","size":1198,"stargazers_count":5,"open_issues_count":6,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-23T19:28:26.394Z","etag":null,"topics":["development","project","prototype","template-project"],"latest_commit_sha":null,"homepage":"https://thermophase-fcsrg.github.io/blank-python-project/","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/ThermoPhase-FCSRG.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,"zenodo":null}},"created_at":"2018-09-24T03:05:31.000Z","updated_at":"2025-06-23T18:17:06.000Z","dependencies_parsed_at":"2025-05-14T20:31:38.046Z","dependency_job_id":"31e78ce2-c7e8-4ef5-b290-0c389ca77609","html_url":"https://github.com/ThermoPhase-FCSRG/blank-python-project","commit_stats":null,"previous_names":[],"tags_count":14,"template":true,"template_full_name":null,"purl":"pkg:github/ThermoPhase-FCSRG/blank-python-project","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThermoPhase-FCSRG%2Fblank-python-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThermoPhase-FCSRG%2Fblank-python-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThermoPhase-FCSRG%2Fblank-python-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThermoPhase-FCSRG%2Fblank-python-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThermoPhase-FCSRG","download_url":"https://codeload.github.com/ThermoPhase-FCSRG/blank-python-project/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThermoPhase-FCSRG%2Fblank-python-project/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262594225,"owners_count":23334168,"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":["development","project","prototype","template-project"],"created_at":"2025-06-29T12:31:28.390Z","updated_at":"2025-06-29T12:32:52.406Z","avatar_url":"https://github.com/ThermoPhase-FCSRG.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# A generic blank Python project\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Tests using conda](https://github.com/volpatto/blank-python-project/actions/workflows/tests-conda.yml/badge.svg)](https://github.com/volpatto/blank-python-project/actions/workflows/tests-conda.yml)\n[![Tests using venv](https://github.com/volpatto/blank-python-project/actions/workflows/tests-venv.yml/badge.svg)](https://github.com/volpatto/blank-python-project/actions/workflows/tests-venv.yml)\n[![Coverage badge](https://raw.githubusercontent.com/volpatto/blank-python-project/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/volpatto/blank-python-project/blob/python-coverage-comment-action-data/htmlcov/index.html)\n[![Publish docs via GitHub Pages](https://github.com/volpatto/blank-python-project/actions/workflows/publish-docs.yml/badge.svg)](https://github.com/volpatto/blank-python-project/actions/workflows/publish-docs.yml)\n[![CodeQL Analyzes](https://github.com/volpatto/blank-python-project/actions/workflows/codeql.yml/badge.svg)](https://github.com/volpatto/blank-python-project/actions/workflows/codeql.yml)\n\nThis repo provides a scratch of a Python project. Its purpose is to serve as starting point for the development of a Python project based on a minimal working structure.\n\n## Covered features\n\n* A Python package organized following the [src-layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/#src-layout-vs-flat-layout);\n* A preconfigured `pyproject.toml` file following the suggestions from [the Official Python Packaging docs](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/);\n* [GitHub Actions](https://github.com/features/actions) convenient workflows with minimal configurations for the latest Ubuntu, macOS, and Windows;\n* Tests with [pytest](https://docs.pytest.org/en/latest/), integrating Python notebooks as tests together with the usual `test_*.py` files;\n* Development environment with two options:\n    * The classic [venv](https://docs.python.org/3.12/library/venv.html)\n    * A [conda/miniconda](https://conda.io/en/latest/) environment with [conda-devenv](https://github.com/ESSS/conda-devenv) extension\n* Hierarchical structure to a Python package inspired by [PyPA recommendations](https://github.com/pypa/sampleproject). See also the [Official Python docs](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/);\n* A [MkDocs](https://www.mkdocs.org/) for nice-looking and modern docs (at least at the moment that you are reading this). A GH Actions workflow is provided to automatically update the docs after each PR based on docstrings and Jupyter Notebooks. See the [Docs website here](https://volpatto.github.io/blank-python-project/);\n* [pre-commit](https://pre-commit.com/) to perform git hooks before commits. A GH Actions workflow is provided to check and update the hooks on a weekly basis, opening PRs by `github-actions[bot]`. The following plugins are being used as git hooks:\n    * trailing-whitespace\n    * end-of-file-fixer\n    * ruff\n    * blacken-docs\n    * nb-clean\n    * jupytext\n* A free Coverage reporter using [this Action](https://github.com/py-cov-action/python-coverage-comment-action/tree/main). It comments on PR, annotates where there is a lack of coverage, and provides coverage badges in a dedicated branch after PRs;\n* Type-checking with [mypy](https://mypy-lang.org/);\n* A bunch of convenient tasks to improve productivity defined using [invoke](https://docs.pyinvoke.org/en/stable/);\n* Automated Python Package releases to PyPI through Pre-Release PRs using git tags. The release is uploaded using [this official GH Action](https://github.com/pypa/gh-action-pypi-publish);\n* A PR automerge workflow (based on [this GH Actions](https://github.com/pascalgn/automerge-action)) for when a PR is ready to go with all reviews, code changes, and checks done. Just label the PR with `automerge` and see the magic;\n* Use [conda-lock](https://github.com/conda/conda-lock) when working with `conda` envs, assuring fully reproducible envs for Windows, Ubuntu, and MacOS. A GH Actions workflow is also provided to update conda-lock files on a weekly basis, opening PRs with updates whenever needed;\n* Run [CodeQL](https://github.com/github/codeql) to analyze the code and report security issues;\n* [Dependabot](https://docs.github.com/en/code-security/dependabot) is configured to watch and send PRs updating the GH Actions versions.\n\n## Contributions\n\nContributions are VERY welcome. But please be aware of the purpose of the repo: **A minimal working structure.** If you want to add a feature that is very particular to your needs, please analyse if it fits the goals of this template.\n\nSuggestions and advice are welcome; feel free to open an Issue or send me an email.\n\n## Contact\n\nMy name is Diego. Feel free to contact me through the email \u003cvolpatto@lncc.br\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthermophase-fcsrg%2Fblank-python-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthermophase-fcsrg%2Fblank-python-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthermophase-fcsrg%2Fblank-python-project/lists"}