{"id":16871399,"url":"https://github.com/itsluketwist/python-template","last_synced_at":"2025-07-21T10:33:43.930Z","repository":{"id":201086791,"uuid":"703474042","full_name":"itsluketwist/python-template","owner":"itsluketwist","description":"A simple python template repository, configured how I like to start my personal python projects.","archived":false,"fork":false,"pushed_at":"2024-09-03T18:45:35.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T22:29:23.663Z","etag":null,"topics":["package","pyproject","python","template"],"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/itsluketwist.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":"2023-10-11T10:05:25.000Z","updated_at":"2024-09-03T18:45:39.000Z","dependencies_parsed_at":"2024-02-08T20:41:15.422Z","dependency_job_id":"0a57f8d1-7d71-4ad1-9da3-3d5a3d9ac3f6","html_url":"https://github.com/itsluketwist/python-template","commit_stats":null,"previous_names":["itsluketwist/python-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsluketwist%2Fpython-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsluketwist%2Fpython-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsluketwist%2Fpython-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsluketwist%2Fpython-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsluketwist","download_url":"https://codeload.github.com/itsluketwist/python-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244296525,"owners_count":20430333,"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":["package","pyproject","python","template"],"created_at":"2024-10-13T15:08:28.393Z","updated_at":"2025-03-18T19:52:27.141Z","avatar_url":"https://github.com/itsluketwist.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **python-template**\n\n\n![lint code workflow](https://github.com/itsluketwist/python-template/actions/workflows/lint.yaml/badge.svg)\n![test code workflow](https://github.com/itsluketwist/python-template/actions/workflows/test.yaml/badge.svg)\n![release workflow](https://github.com/itsluketwist/python-template/actions/workflows/release.yaml/badge.svg)\n\n\n\u003cdiv\u003e\n    \u003c!-- badges from : https://shields.io/ --\u003e\n    \u003c!-- logos available : https://simpleicons.org/ --\u003e\n    \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n        \u003cimg alt=\"MIT License\" src=\"https://img.shields.io/badge/Licence-MIT-yellow?style=for-the-badge\u0026logo=docs\u0026logoColor=white\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.python.org/\"\u003e\n        \u003cimg alt=\"Python 3\" src=\"https://img.shields.io/badge/Python_3-blue?style=for-the-badge\u0026logo=python\u0026logoColor=white\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\n## *usage*\n\nOnce cloned, find and replace all instances of `python-template` with the new repository name.\nRemove below `README.md` sections where appropriate (whether this is a project or library),\nsimilarly determine whether the `pyproject.toml` or `requirements.txt` files are necessary.\n\n## *installation*\n\nInstall directly from GitHub, using pip:\n\n```shell\npip install git+https://github.com/itsluketwist/python-template\n```\n\n## *development*\n\nClone the repository code:\n\n```shell\ngit clone https://github.com/itsluketwist/python-template.git\n```\n\n_(for projects...)_ Once cloned, install the requirements locally in a virtual environment:\n\n```shell\npython -m venv .venv\n\n. .venv/bin/activate\n\npip install -r requirements.txt -r requirements-dev.txt\n```\n\n_(for libraries...)_ Once cloned, install the package locally in a virtual environment:\n\n```shell\npython -m venv .venv\n\n. .venv/bin/activate\n\npip install -e \".[dev]\"\n```\n\nInstall and use pre-commit to ensure code is in a good state (uses [ruff](https://astral.sh/ruff)):\n\n```shell\npre-commit install\n\npre-commit autoupdate\n\npre-commit run --all-files\n```\n\nDependencies are managed with [uv](https://astral.sh/blog/uv), add new packages to `requirements.in`, then compile:\n\n```shell\nuv pip compile requirements.in -o requirements.txt\n```\n\n## *todos*\n\n- Add docs template / support.\n\n\n## *testing*\n\nRun the test suite using:\n\n```shell\npytest .\n```\n\n\n## *inspiration*\n\nThis is currently how I like to make python projects/libraries, it ain't that deep.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsluketwist%2Fpython-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsluketwist%2Fpython-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsluketwist%2Fpython-template/lists"}