Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cqcl/pytemplate

Template repo for Python projects

https://github.com/cqcl/pytemplate

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.6%) to scientific vocabulary

Keywords

pre-commit python ruff template-project

Keywords from Contributors

standardization autograder sequences projections interpretability hack meshing generalization archival report
Last synced: 5 months ago · JSON representation

Repository

Template repo for Python projects

Basic Info
Statistics
  • Stars: 4
  • Watchers: 4
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Topics
pre-commit python ruff template-project
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme

README.md

pytemplate

This is a Python 3.13 app called pytemplate. The project includes Docker, pyright, ruff, typos, GitHub Actions, pre-commit, and Sphinx.

The extremely fast Python package and project manager, uv, is required.

Project Structure ## Project Structure The project structure is as follows: ```sh pytemplate ├── .dockerignore ├── .github │ ├── dependabot.yml │ └── workflows │ └── python-app.yml ├── .gitignore ├── .pre-commit-config.yaml ├── Dockerfile ├── Makefile ├── README.md ├── docs │ ├── Makefile │ └── source │ ├── conf.py │ └── index.rst ├── pyproject.toml ├── pytemplate │ ├── __init__.py │ ├── main.py │ └── utils.py ├── ruff.toml └── tests ├── test_main.py └── test_utils.py ``` The 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. The project uses toml for configuration instead of `setup.py`. The configuration file is located in `pyproject.toml`. The project includes Docker, with a `Dockerfile` located in the root directory. The `.dockerignore` file is also located in the root directory. The project includes `pyright` for static type checking, `typos` for code spell check, `ruff` for linting & 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. The project includes Sphinx for documentation, with the documentation located in the `docs` folder. The `source/conf.py` file contains the configuration for Sphinx. The project includes GitHub Actions for continuous integration, with the configuration located in the `.github/workflows/python-app.yml` file.

Usage Notes

  • Replace all mentions of "pytemplate" to your own project's name.
  • Edit .github/workflows/python-app.yml to configure which triggers and jobs to enable/disable.

Installation

To install the project, clone the repository and run:

sh uv sync uv run pre-commit install

See Makefile for other useful commands.

Testing

Issue make tests or uv run pytest from the root directory.

Owner

  • Name: Cambridge Quantum
  • Login: CQCL
  • Kind: organization
  • Location: Cambridge, UK

Quantum Software and Technologies

GitHub Events

Total
  • Issues event: 3
  • Watch event: 4
  • Delete event: 13
  • Issue comment event: 5
  • Push event: 7
  • Pull request review event: 3
  • Pull request event: 15
  • Fork event: 1
  • Create event: 14
Last Year
  • Issues event: 3
  • Watch event: 4
  • Delete event: 13
  • Issue comment event: 5
  • Push event: 7
  • Pull request review event: 3
  • Pull request event: 15
  • Fork event: 1
  • Create event: 14

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 89
  • Total Committers: 4
  • Avg Commits per committer: 22.25
  • Development Distribution Score (DDS): 0.573
Past Year
  • Commits: 16
  • Committers: 2
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.25
Top Committers
Name Email Commits
dependabot[bot] 4****] 38
Kartik Singhal k****l@q****m 27
github-actions[bot] 4****] 15
Nathan Fitzpatrick 4****C 9
Committer Domains (Top 20 + Academic)
quantinuum.com: 1

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 4
  • Total pull requests: 106
  • Average time to close issues: 2 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 1.75
  • Average comments per pull request: 0.2
  • Merged pull requests: 92
  • Bot issues: 0
  • Bot pull requests: 91
Past Year
  • Issues: 2
  • Pull requests: 22
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.14
  • Merged pull requests: 16
  • Bot issues: 0
  • Bot pull requests: 19
View more stats
Top Authors
Issue Authors
  • qartik (3)
  • ss2165 (1)
Pull Request Authors
  • dependabot[bot] (70)
  • github-actions[bot] (21)
  • qartik (15)
Top Labels
Issue Labels
enhancement (1) github_actions (1)
Pull Request Labels
dependencies (70) python (64) github_actions (6)

Dependencies

.github/workflows/python-app.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
Dockerfile docker
  • python 3.11-slim-buster build
requirements.txt pypi
  • black *
  • pre-commit *
  • pyright *
  • pytest *
  • pytest-lazy-fixture *
  • pytket *
  • pytket-qiskit *
  • sphinx *
  • wheel *
pyproject.toml pypi