https://github.com/fkodom/python-repo-template

Template repo for Python projects, especially those focusing on machine learning and/or deep learning.
https://github.com/fkodom/python-repo-template

Last synced: 2 months ago
JSON representation

Template repo for Python projects, especially those focusing on machine learning and/or deep learning.

• Host: GitHub
• URL: https://github.com/fkodom/python-repo-template
• Owner: fkodom
• License: mit
• Created: 2022-02-19T04:26:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T19:01:36.000Z (4 months ago)
• Last Synced: 2024-10-23T03:17:05.775Z (2 months ago)
• Language: Python
• Size: 43 KB
• Stars: 12
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# {{REPO_NAME}}

A simple template for Python projects, with CI/CD configured through GitHub Actions.  Compatible with any virtual environment manager (e.g. `venv`, `pyenv`, `poetry`, `conda`).

## Usage

1. Create a new repository, using this one as a template.

2. Run the `templatize` script:

    ```bash

    ./templatize

    ```

    This updates placeholders like `{{REPO_NAME}}`, so everything is configured with your username, repo name, email, etc.

3. Commit and push the changes.

    ```bash

    git add .

    git commit -m "Templatize"

    git push

    ```

4. (Probably) delete this section of the README.

## Install

```bash

pip install "{{REPO_NAME}} @ git+ssh://[email protected]/{{REPO_OWNER}}/{{REPO_NAME}}.git"

# Install all dev dependencies (tests etc.)

pip install "{{REPO_NAME}}[test] @ git+ssh://[email protected]/{{REPO_OWNER}}/{{REPO_NAME}}.git"

# Setup pre-commit hooks

pre-commit install

```

## Tooling

| Tool | Description | Runs on |

| --- | --- | --- |

| [black](https://github.com/psf/black) | Code formatter | - `git commit` (through `pre-commit`) 
 - `git push` 
 - pull requests |

| [ruff](https://github.com/astral-sh/ruff) | Code linter | - `git commit` (through `pre-commit`) 
 - `git push` 
 - pull requests |

| [pytest](https://github.com/pytest-dev/pytest) | Unit testing framework | - `git push` 
 - pull requests |

| [mypy](https://github.com/python/mypy) | Static type checker | - `git push` 
 - pull requests |

| [pre-commit](https://github.com/pre-commit/pre-commit) | Pre-commit hooks | - `git commit` |

| [twine](https://github.com/pypa/twine) $\dagger$ | PyPI package uploader | - New release (`git tag`) |

> $\dagger$ Requires enabling the `publish.yaml` workflow.  To activate, move the file from `.github/disabled-workflows/publish.yaml.disabled` to `.github/workflows/publish.yaml`, and set a valid PyPI token as `PYPI_API_TOKEN` in the repo secrets.

>

> Then tag a new release of this repo, and GHA will automatically build and publish a Python wheel (`.whl`) to PyPI.