https://github.com/altescy/cookiecutter-poetry-pysen

Cookiecutter template for Python project with poetry and pysen
https://github.com/altescy/cookiecutter-poetry-pysen

black cookiecutter cookiecutter-template isort mypy poetry pysen pytest python

Last synced: about 1 month ago
JSON representation

Cookiecutter template for Python project with poetry and pysen

• Host: GitHub
• URL: https://github.com/altescy/cookiecutter-poetry-pysen
• Owner: altescy
• License: mit
• Created: 2021-08-28T03:15:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-09T02:46:41.000Z (about 2 months ago)
• Last Synced: 2024-11-09T03:29:16.444Z (about 2 months ago)
• Topics: black, cookiecutter, cookiecutter-template, isort, mypy, poetry, pysen, pytest, python
• Language: Makefile
• Homepage:
• Size: 42 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
cookiecutter-poetry-pysen

=========================

[![Actions Status](https://github.com/altescy/cookiecutter-poetry-pysen/workflows/CI/badge.svg)](https://github.com/altescy/cookiecutter-poetry-pysen/actions/workflows/ci.yml)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/altescy/cookiecutter-poetry-pysen)](https://github.com/altescy/cookiecutter-poetry-pysen/releases)

[![License](https://img.shields.io/github/license/altescy/cookiecutter-poetry-pysen)](https://github.com/altescy/cookiecutter-poetry-pysen/blob/main/LICENSE)

This repository provides a [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template with [poetry](https://python-poetry.org/) and [pysen](https://github.com/pfnet/pysen).

```

cookiecutter https://github.com/altescy/cookiecutter-poetry-pysen.git

```

## Usage

1. Generate a project directory with cookiecutter

```

❯ cookiecutter https://github.com/altescy/cookiecutter-poetry-pysen.git

package_name [package_name]: your-package

module_name [your_package]:

author [author ]:

```

2. Install dependent packages via:

```

❯ cd your-package

❯ poetry install

```

3. Run pysen and pytest

```bash

❯ make    # Run formatters, linters, and pytest

```