Skip to content

dimanu-py/instant-python

Repository files navigation

⚡️ Instant Boilerplate for Python Projects ⚡️

Fast, easy and reliable project generator for your Python projects.

Getting Started  •  Usage  •  Examples  •  Contributing

instant-python-demo

Instant Python replaces extensive manual setup with a simple command to get started quickly. Its motivation is to emulate commands like `ng new` or `create-react-app`, but for Python projects.



Why use Instant Python? Generating your Python project with Instant Python lets you:

  • ⏱️ Slash folder & config setup time to seconds
  • 🐍 Instantly install & switch between any Python version
  • 🔧 Effortlessly configure your favorite project manager
  • 📁 Kickstart with ready-made or fully custom project structures
  • 🔄 Initialize a Git repo in just a few clicks
  • 📦 Auto-install all your go-to dependencies
  • 🚀 Ship with production-ready boilerplates out of the box

Documentation

This section provides a high-level overview of the instant-python library, its features, and how to get started. For detailed instructions and examples, please refer to the full Instant Python documentation.

Need help?

Installation

The latest version of instant-python can be installed from PyPI:

pip install instant-python

Tip

We highly recommend using a virtual environment to avoid conflicts with other Python packages.

Requirements

Instant Python tries to support the latest Python versions, we officially support from Python 3.10 to 3.13. Older versions of Python may work, but they are not guaranteed to be compatible.

Contributing

We welcome contributions to instant-python! If you have ideas, suggestions, or improvements, please check out our contributing guide for details on how to get involved.