Skip to main content

Jump-start your python project

Project description

Intropy

Version Build Status

Powered by Cookiecutter, intropy is a framework for jump-starting production-grade python projects. The python project will be generated and configured automatically with:

  • Build system
  • Test and code quality tooling
  • Documentation
  • Automation pipelines
  • etc...

Features

  • Ruff | Linter and formatter (Optionally strict Black as code formatter)
  • Pytest | Test framework
  • Tox | Standardized testing and automation
  • Coverage | Code coverage
  • Mypy | Static type checker
  • Package and environment management
    • Deployable applications: Pipenv | Version pinning and virtual environment setup
    • Libraries: Pyproject explicit defined dependencies
  • Pre-commit | pre-commit hooks
  • Bump my version | Bump semantic version
  • Sphinx | Documentation tool
  • Logging boilerplate
  • DevOps platform options
    • Github
      • Github workflows | CI and publishing to PyPi
      • Github templates | Pull Requests and Issues
    • Azure Devops
      • Azure pipelines | CI
  • Makefile for convenience

Usage

Install cookiecutter:

pip install cookiecutter

Create project:

cookiecutter https://github.com/RicNord/intropy

You will be prompted for some values. After that the project will be generated!

(Optional) Standalone CLI

A wrapper around the cookiecutter CLI is also provided and can be installed with:

pip install intropy

For API reference see:

intropy --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intropy-0.6.2.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

intropy-0.6.2-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page