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. It generates a new python project within seconds that is configured automatically with:

  • Build system
  • Test and code quality tooling
  • Documentation
  • Automation pipelines
  • Security scanner
  • 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.toml explicitly defined dependencies
  • Pre-commit | pre-commit hooks
  • Bump my version | Bump semantic version
  • Sphinx | Documentation tool
  • Logging boilerplate
  • Bandit and Trivy | Security scanners
  • 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.8.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

intropy-0.8.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file intropy-0.8.0.tar.gz.

File metadata

  • Download URL: intropy-0.8.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for intropy-0.8.0.tar.gz
Algorithm Hash digest
SHA256 66ecfb24be48cfe7f0f84e31a67e271975435df2062bff0ff629f89991263c2c
MD5 1bcc649d2f21f2685a2fb02c3042dd16
BLAKE2b-256 85a3e565766d81a5e8ac13ea428b2b27180403a8ddcff362dc9e7edfd756076f

See more details on using hashes here.

File details

Details for the file intropy-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: intropy-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for intropy-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 699e6ce19a09006f8f9a9d8b47a21bd0730470af57a66caa305ac89494cbcc54
MD5 69ccc06daad2d30135e38eb5c1ec9302
BLAKE2b-256 70973bb7beb6bc949f113b8863c2c51ae60aad99282ed87d88e6f2f8457e19cb

See more details on using hashes here.

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