https://github.com/martibosch/cookiecutter-geopy-package

cookiecutter-geopy-package
https://github.com/martibosch/cookiecutter-geopy-package

Last synced: 4 days ago
JSON representation

cookiecutter-geopy-package

• Host: GitHub
• URL: https://github.com/martibosch/cookiecutter-geopy-package
• Owner: martibosch
• License: gpl-3.0
• Created: 2023-04-12T10:09:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-28T03:20:04.000Z (about 1 year ago)
• Last Synced: 2024-06-11T16:30:27.075Z (7 months ago)
• Language: Python
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CI](https://github.com/martibosch/cookiecutter-geopy-package/actions/workflows/dev.yml/badge.svg)](https://github.com/martibosch/cookiecutter-geopy-package/blob/main/.github/workflows/dev.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/martibosch/cookiecutter-geopy-package/main.svg)](https://results.pre-commit.ci/latest/github/martibosch/cookiecutter-geopy-package/main)

[![GitHub license](https://img.shields.io/github/license/martibosch/cookiecutter-geopy-package.svg)](https://github.com/martibosch/cookiecutter-geopy-package/blob/main/LICENSE)

# Cookiecutter geopy package

Template for Python packages using GDAL (from conda-forge).

## Features

This project template includes the following features to ensure best practices:

- **Overall project configuration**: [pyproject.toml](https://www.python.org/dev/peps/pep-0518) for [PEP-626](https://www.python.org/dev/peps/pep-0626)-compliant project configuration.

- **Tests**:

  - [tox](https://tox.wiki) for testing against multiple Python versions, with support for conda dependencies using [tox-conda](https://github.com/tox-dev/tox-conda) and GitHub Actions using [tox-gh-actions](https://github.com/ymyzk/tox-gh-actions).

  - [coverage](https://coverage.readthedocs.io) reporting with [codecov](https://codecov.io) integration.

- **Documentation**: generated with [sphinx](https://www.sphinx-doc.org), using [MyST](https://myst-parser.readthedocs.io) for Markdown support, auto API generation from docstrings and hosting on [readthedocs](https://readthedocs.org).

- **Code quality**: set up with [pre-commit](https://pre-commit.com) to run checks and tests before each commit, including, among others:

  - [black](https://black.readthedocs.io) for code formatting.

  - [ruff](https://beta.ruff.rs) for code linting and formatting.

  - [prettier](https://prettier.io) to format configuration files.

- **Continuous integration and delivery** with [GitHub Actions](https://github.com/features/actions), with jobs to run tests, publishing to test PyPI and releasing to PyPI and GitHub on new tags.

- **Conventional commits and semantic versioning** with [commitizen](https://commitizen-tools.github.io/commitizen) to enforce [conventional commits](https://www.conventionalcommits.org) (with `commit-msg` pre-commit hooks), version bumping using [semantic versioning](https://semver.org) and automated change log generation.

## Usage

### First time setup

Generate a new project using [cookiecutter](https://github.com/cookiecutter/cookiecutter):

```bash

cookiecutter gh:martibosch/cookiecutter-geopy-package

```

and fill in the prompts. Then, navigate to the generated directory and follow the instructions below:

- Initialize a git repository (e.g., `git init`) and install the pre-commit hooks by running `pre-commit install` and `pre-commit install --hook-type commit-msg`.

- Register the project in [codecov](https://codecov.io) and [readthedocs](https://readthedocs.org).

- If the repository is public, enable [pre-commit.ci](https://pre-commit.ci) to automatically run pre-commit checks on GitHub and autoupdate the pre-commit hook versions.

- Create accounts (or use existing accounts) and [API tokens](https://pypi.org/help/#apitoken) for [PyPI](https://pypi.org) and [test PyPI](https://test.pypi.org), and add them to the project's [secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) in GitHub.

You can then start developing your package.

### Development

### Submit a recipe to conda-forge

If you want your package to be available from [conda-forge](https://conda-forge.org), you can generate a recipe for it using [grayskull](https://github.com/conda/grayskull) and then submit it by following the instructions in the [conda-forge documentation](https://conda-forge.org/docs/maintainer/adding_pkgs.html#forking-and-pull-request).

## Acknowledgements

- This template borrows several ideas from [zillionare/python-project-wizard](https://github.com/zillionare/python-project-wizard).