{"id":20231064,"url":"https://github.com/omar-abdelgawad/python-project-template","last_synced_at":"2025-10-31T10:07:14.633Z","repository":{"id":218015392,"uuid":"739942523","full_name":"omar-abdelgawad/python-project-template","owner":"omar-abdelgawad","description":"Template repository for python projects","archived":false,"fork":false,"pushed_at":"2024-06-02T13:06:50.000Z","size":18,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T15:47:29.204Z","etag":null,"topics":["gh-actions","mypy","precommit","pyproject-toml","pytest","python3","ruff","template","tox"],"latest_commit_sha":null,"homepage":"","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/omar-abdelgawad.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":"2024-01-07T02:35:08.000Z","updated_at":"2024-10-06T10:19:05.000Z","dependencies_parsed_at":"2024-01-19T09:55:16.477Z","dependency_job_id":"e83689f5-8027-4465-aafb-30217ba0804b","html_url":"https://github.com/omar-abdelgawad/python-project-template","commit_stats":null,"previous_names":["omar-abdelgawad/python-project-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omar-abdelgawad%2Fpython-project-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omar-abdelgawad%2Fpython-project-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omar-abdelgawad%2Fpython-project-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omar-abdelgawad%2Fpython-project-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omar-abdelgawad","download_url":"https://codeload.github.com/omar-abdelgawad/python-project-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248266151,"owners_count":21075108,"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":["gh-actions","mypy","precommit","pyproject-toml","pytest","python3","ruff","template","tox"],"created_at":"2024-11-14T07:45:02.891Z","updated_at":"2025-10-31T10:07:14.615Z","avatar_url":"https://github.com/omar-abdelgawad.png","language":"Python","readme":"[![license](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/license/mit/)\n[![Tests](https://github.com/omar-abdelgawad/python-project-template/actions/workflows/tests.yml/badge.svg)](https://github.com/omar-abdelgawad/python-project-template/actions)\n[![PythonVersion](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)\n\u003c!-- [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) --\u003e\n\n# Project Name\nThis is a modern template for a python project with the pyproject.toml with some fields to change based on project. It also has tox configured, docs dir for github pages, .github dir with tox-gh-actions configured and more.  \n- pyproject.toml (according to uv)\n- setuptools backend (setup.py and setup.cfg)\n- the src layout\n- tox configured\n- docs dir for github pages with a tests.yml ready\n- .github dir with a tests.yml configured with tox-gh-actions\n- tox configured with pytest, ruff, and mypy\n- tests dir for pytest \n- justfile for running commands\n\nPlease Note that tox is configured with python 3.10,3.11, and 3.12. Feel free to reconfigure everything to your need.\n\n## Prerequisites\n1. Make sure [uv](https://docs.astral.sh/uv/getting-started/installation/#installation-methods) is installed. Here is the install script on macOS and Linux\n```bash\ncurl -LsSf https://astral.sh/uv/install.sh | sh\n```\n2. Instead of using `make` as a command runner with `.PHONY` all over the place we use [just](https://just.systems/). You can run the commands manually by yourself instead if you don't want to install it but having your most common run commands in one place is a really good habit. \n\n## Installation/Usage\n```bash\n $ git clone \u003crepo_url\u003e\n $ cd \u003crepo_name\u003e\n $ uv sync\n $ pre-commit install\n``` \n\n## Testing with tox\nJust running `tox` with no args should work.\n```bash\n $ just tox\n```\ntox creates virtual environments and runs all of pytest, ruff, and mypy.\n## Package(s)\n\n### package1\n....\n### package2\n....\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomar-abdelgawad%2Fpython-project-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomar-abdelgawad%2Fpython-project-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomar-abdelgawad%2Fpython-project-template/lists"}