{"id":22882526,"url":"https://github.com/cqcl/pytemplate","last_synced_at":"2025-09-09T19:22:43.151Z","repository":{"id":181780304,"uuid":"667294197","full_name":"CQCL/pytemplate","owner":"CQCL","description":"Template repo for Python projects","archived":false,"fork":false,"pushed_at":"2025-05-01T16:17:35.000Z","size":126,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-08T03:06:42.887Z","etag":null,"topics":["pre-commit","python","ruff","template-project"],"latest_commit_sha":null,"homepage":"https://cqcl.github.io/pytemplate/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CQCL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-07-17T07:23:19.000Z","updated_at":"2025-05-01T16:17:32.000Z","dependencies_parsed_at":"2024-04-29T17:49:43.037Z","dependency_job_id":"f99abffa-a1e1-4570-b7e4-185330603e67","html_url":"https://github.com/CQCL/pytemplate","commit_stats":null,"previous_names":["nathancqc/pytemplate","cqcl/pytemplate"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/CQCL/pytemplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CQCL","download_url":"https://codeload.github.com/CQCL/pytemplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CQCL%2Fpytemplate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260606471,"owners_count":23035350,"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":["pre-commit","python","ruff","template-project"],"created_at":"2024-12-13T18:18:09.424Z","updated_at":"2025-06-18T18:06:01.521Z","avatar_url":"https://github.com/CQCL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pytemplate\n\nThis is a Python 3.13 app called pytemplate. The project includes Docker, pyright, ruff, typos, GitHub Actions, pre-commit, and Sphinx.\n\nThe extremely fast Python package and project manager, [uv](https://docs.astral.sh/uv/#getting-started), is required.\n\n\u003cdetails\u003e\n\n\u003csummary\u003eProject Structure\u003c/summary\u003e\n\n## Project Structure\n\nThe project structure is as follows:\n\n```sh\npytemplate\n├── .dockerignore\n├── .github\n│   ├── dependabot.yml\n│   └── workflows\n│       └── python-app.yml\n├── .gitignore\n├── .pre-commit-config.yaml\n├── Dockerfile\n├── Makefile\n├── README.md\n├── docs\n│   ├── Makefile\n│   └── source\n│       ├── conf.py\n│       └── index.rst\n├── pyproject.toml\n├── pytemplate\n│   ├── __init__.py\n│   ├── main.py\n│   └── utils.py\n├── ruff.toml\n└── tests\n    ├── test_main.py\n    └── test_utils.py\n```\n\nThe source code is located in the `pytemplate` folder, which contains the `__init__.py`, `main.py`, and `utils.py` files. The tests are located in the `tests` folder, which contains the `test_main.py` and `test_utils.py` files.\n\nThe project uses toml for configuration instead of `setup.py`. The configuration file is located in `pyproject.toml`.\n\nThe project includes Docker, with a `Dockerfile` located in the root directory. The `.dockerignore` file is also located in the root directory.\n\nThe project includes `pyright` for static type checking, `typos` for code spell check, `ruff` for linting \u0026 code formatting, and `pre-commit` for enforcing these checks before git commits and on the CI. The configuration for these tools is located in the `ruff.toml` and `.pre-commit-config.yaml` files.\n\nThe project includes Sphinx for documentation, with the documentation located in the `docs` folder. The `source/conf.py` file contains the configuration for Sphinx.\n\nThe project includes GitHub Actions for continuous integration, with the configuration located in the `.github/workflows/python-app.yml` file.\n\n\u003c/details\u003e\n\n## Usage Notes\n\n- [Replace](https://github.com/your-tools/ruplacer) all mentions of \"pytemplate\" to your own project's name.\n- Edit `.github/workflows/python-app.yml` to configure which triggers and jobs to enable/disable.\n\n## Installation\n\nTo install the project, clone the repository and run:\n\n```sh\nuv sync\nuv run pre-commit install\n```\n\nSee `Makefile` for other useful commands.\n\n## Testing\n\nIssue `make tests` or `uv run pytest` from the root directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqcl%2Fpytemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqcl%2Fpytemplate/lists"}