https://github.com/alanwilter/poetry-python-cookiecutter

A cookiecutter template using poetry, ruff, pre-commit and mypy

https://github.com/alanwilter/poetry-python-cookiecutter

Science Score: 13.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
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A cookiecutter template using poetry, ruff, pre-commit and mypy

Basic Info
  • Host: GitHub
  • Owner: alanwilter
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 38.1 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog License

README.md

Python Poetry Managed Cookiecutter template

Maintenance GitHub GitHub release (latest by date) GitHub Release Poetry Ruff pre-commit

This is a cookiecutter template that utilises poetry, ruff, pre-commit, and mypy.

How to Use

  1. Install poetry, via homebrew or pipx:

bash brew install poetry

or

bash pipx install poetry

  1. Create a Python virtual environment of your preference and activate it.

  2. Install cookiecutter and cruft via, e.g., homebrew or pip:

bash python3 -m pip install --upgrade cookiecutter cruft

  1. Run the command below to create your new project based on this cookiecutter template:

bash cookiecutter https://github.com/alanwilter/poetry-python-cookiecutter

or

bash cookiecutter gh:/alanwilter/poetry-python-cookiecutter

Alternatively, you can use cruft, which is a layer above cookiecutter. This allows you to manage your project from the template after it has been generated, enabling you to check, diff, or update it:

bash cruft create https://github.com/alanwilter/poetry-python-cookiecutter

The command line interface will ask you to provide several informations.

  1. It's optional, but we strongly recommend commitizen

Not Exactly What You Want?

If this template doesn't meet your needs, you can explore thousands of other cookiecutter templates here.

Owner

  • Name: Alan Silva
  • Login: alanwilter
  • Kind: user
  • Location: London
  • Company: MEH

Scientific Programmer & Data Scientist, DSc in Biophysics, Python3 mostly. ACPYPE creator and maintainer.

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

poetry.lock pypi
  • cfgv 3.4.0
  • distlib 0.3.8
  • filelock 3.13.1
  • identify 2.5.35
  • mypy 1.8.0
  • mypy-extensions 1.0.0
  • nodeenv 1.8.0
  • pip 23.3.2
  • platformdirs 4.2.0
  • pre-commit 3.6.2
  • pyyaml 6.0.1
  • ruff 0.1.15
  • setuptools 69.1.1
  • tomli 2.0.1
  • typing-extensions 4.10.0
  • virtualenv 20.25.1
  • wheel 0.42.0
pyproject.toml pypi
  • mypy ^1.6.1 develop
  • pip ^23.1.2 develop
  • pre-commit ^3.0.0 develop
  • ruff ^0.1.2 develop
  • wheel ^0.42.0 develop
  • python ^3.10
{{cookiecutter.dist_name}}/pyproject.toml pypi