Skip to content

A Python project setup tool that scaffolds projects with best practices, including pre-configured settings for black, isort, mypy, pytest, ruff, and more.

License

Notifications You must be signed in to change notification settings

Nachtalb/defaultpoetry

Repository files navigation

DefaultPoetry 📚✨

License: LGPL-3.0 GitHub Stars GitHub Forks GitHub Issues GitHub Pull Requests
Author: Nachtalb


Streamline your Python project setup with DefaultPoetry - a tool designed to quickly scaffold projects with best practices in coding standards, configurations, and dependencies. Perfect for developers looking to jump-start their projects with pre-configured settings for black, isort, mypy, pytest, ruff, and more.

🚀 Quickstart

Prerequisites: Python 3.12 or higher.

  1. Clone the repository:

    git clone https://github.com/Nachtalb/defaultpoetry
    cd defaultpoetry
  2. Install using Poetry: poetry install

  3. Run the script directly: poetry run defaultpoetry -h


🔧 Configuration

defaultpoetry uses the templates directory for its default configuration, including but not limited to configurations for black, isort, mypy, pytest, and ruff, as well as Prettier for README and JS files.


🛠️ Commands

  • init: Initializes a new project with default configurations.
  • update: Updates dependencies and pre-commit hooks.
  • install: Installs the default configuration into an existing project.

📝 License

Licensed under the LGPLv3 License.

About

A Python project setup tool that scaffolds projects with best practices, including pre-configured settings for black, isort, mypy, pytest, ruff, and more.

Topics

Resources

License

Stars

Watchers

Forks

Languages