{"id":16085698,"url":"https://github.com/febus982/bootstrap-python-package","last_synced_at":"2026-03-01T16:04:37.597Z","repository":{"id":215827476,"uuid":"739859311","full_name":"febus982/bootstrap-python-package","owner":"febus982","description":"A template repository to create a python package, automatically published on pypi","archived":false,"fork":false,"pushed_at":"2026-02-26T21:31:38.000Z","size":1295,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-27T03:36:10.813Z","etag":null,"topics":["pypi","pypi-package","pypi-packages","python","python-lib","python-library","python3","template","template-project","template-repository"],"latest_commit_sha":null,"homepage":"https://febus982.github.io/bootstrap-python-package/","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/febus982.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-06T19:01:11.000Z","updated_at":"2025-10-11T10:50:24.000Z","dependencies_parsed_at":"2024-04-26T11:23:57.379Z","dependency_job_id":"1ad830fa-17a0-410b-9eb9-93bc322e5609","html_url":"https://github.com/febus982/bootstrap-python-package","commit_stats":null,"previous_names":["febus982/bootstrap-python-package"],"tags_count":15,"template":true,"template_full_name":null,"purl":"pkg:github/febus982/bootstrap-python-package","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/febus982%2Fbootstrap-python-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/febus982%2Fbootstrap-python-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/febus982%2Fbootstrap-python-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/febus982%2Fbootstrap-python-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/febus982","download_url":"https://codeload.github.com/febus982/bootstrap-python-package/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/febus982%2Fbootstrap-python-package/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29974336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T15:41:30.362Z","status":"ssl_error","status_checked_at":"2026-03-01T15:37:07.343Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["pypi","pypi-package","pypi-packages","python","python-lib","python-library","python3","template","template-project","template-repository"],"created_at":"2024-10-09T13:09:01.938Z","updated_at":"2026-03-01T16:04:37.582Z","avatar_url":"https://github.com/febus982.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bootstrap-python-package\n![Static Badge](https://img.shields.io/badge/Python-3.9_%7C_3.10_%7C_3.11_%7C_3.12_%7C_3.13-blue?logo=python\u0026logoColor=white)\n[![Stable Version](https://img.shields.io/pypi/v/bootstrap-python-package?color=blue)](https://pypi.org/project/bootstrap-python-package/)\n[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)\n\n[![Python tests](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml/badge.svg?branch=main)](https://github.com/febus982/bootstrap-python-package/actions/workflows/python-tests.yml)\n[![Maintainability](https://qlty.sh/badges/d1e0d7b6-ab8a-463d-bd55-5c747a6fe1f9/maintainability.svg)](https://qlty.sh/gh/febus982/projects/bootstrap-python-package)\n[![Code Coverage](https://qlty.sh/badges/d1e0d7b6-ab8a-463d-bd55-5c747a6fe1f9/test_coverage.svg)](https://qlty.sh/gh/febus982/projects/bootstrap-python-package)\n\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json)](https://github.com/charliermarsh/ruff)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n\nThis template repository provides the boilerplate to create a python package.\nIt is configured with all the following features:\n\n* Test suite using [tox](https://tox.wiki/en/latest/index.html) and [pytest](https://docs.pytest.org/en/7.4.x/)\n* Typing using [mypy](https://mypy.readthedocs.io/en/stable/)\n* Linting, security and code format using [ruff](https://github.com/astral-sh/ruff) (using [black](https://pypi.org/project/black/)\n  code style and [bandit](https://github.com/PyCQA/bandit) security rules)\n* Integration with CodeClimate for code quality and coverage checks\n* CI pipeline supporting:\n    * testing against multiple python versions\n    * releases on [PyPI](https://pypi.org)\n    * GitHub pages documentation using [mkdocs](https://www.mkdocs.org)\n* PyCharm profile basic configuration\n\n## How to use this repository template to create a new package\n\n* Create your github repository using this template. (The big green `Use this template` button)\n* Rename the `bootstrap_python_package` directory\n* Search and replace all the occurrences of `bootstrap-python-package` and `bootstrap_python_package`\n* Configure a pending trusted publisher on [pypi](https://pypi.org/manage/account/publishing) using the following values:\n    * PyPI Project Name: The github repository name (in this case `bootstrap-python-package`)\n    * Owner: The github repository owner (in this case `febus982`)\n    * Repository name: The github repository name (in this case `bootstrap-python-package`)\n    * Workflow name: `release.yml`\n* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions`)\n  containing the codeclimate reporter id (you can find it at `https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter`).\n  If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.\n* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)\n* Update the PyCharm Copyright profile in the IDE settings: Editor | Copyright | Copyright Profiles (if you want to use it)\n* Setup local development:\n    * Clone the repository\n    * [Install uv](https://docs.astral.sh/uv/getting-started/installation/)\n    * Install dev dependencies with `make dev-dependencies`\n    * (optional) It is strongly recommended to install [pre-commit](https://pre-commit.com/#installation)\n      and run `pre-commit install` so that formatting and linting are automatically executed during `git commit`.\n* Setup GitHub pages (this need local development setup):\n    * Initialise documentation branch `uv run mike deploy dev latest --update-aliases --push`\n    * Configure GitHub Pages to deploy from the `gh-pages` branch (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages`)\n    * Add the `main` branch and the `v*.*.*` tag rules to the \"deployment branches and tags\" list in the `gh-pages` environment (at URL `https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/environments`)\n\n**IMPORTANT:** The repository is configured to deploy on the [test PyPI repository](https://test.pypi.org/).\nIt's strongly recommended to create the project in the [test PyPI repository](https://test.pypi.org/) and test\nthe deployment pipeline. When you're happy with the result, create the project on the official [PyPI repository](https://pypi.org/)\nand remove the marked lines in `workflows/release.yml`.\n\n## Package release\n\nThis setup uses [uv-dynamic-versioning](https://github.com/ninoseki/uv-dynamic-versioning/tree/main).\nThis means it's not necessary to commit the version in the code but the CI pipeline\nwill infer it from the git tag.\n\nTo release a new version, just create a new release and tag in the GitHub repository, to:\n\n* Build and deploy the python package to PyPI\n* Build and deploy a new version of the documentation to GitHub pages\n\n**IMPORTANT:** The default configuration requires the release name and the tag to follow\nthe convention `vX.X.X` (semantic versioning preceded by lowercase `v`). It will publish\nthe correct version on Pypi, omitting the `v` (ie. `v1.0.0` will publish `1.0.0`).\n\nThis format can be customized, refer to [uv-dynamic-versioning docs](https://github.com/ninoseki/uv-dynamic-versioning/tree/main).\n\n## Commands for development\n\nAll the common commands used during development can be run using make targets:\n\n* `make dev-dependencies`: Install dev requirements\n* `make fix`: Run code style and lint automatic fixes (where possible)\n* `make test`: Run test suite against system python version\n* `make check`: Run tests against all available python versions, code style and lint checks\n* `make type`, `make format`, `make lint`, `make bandit`: Run the relevant check\n* `make docs`: Render the mkdocs website locally\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffebus982%2Fbootstrap-python-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffebus982%2Fbootstrap-python-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffebus982%2Fbootstrap-python-package/lists"}