Skip to main content

A tiny CLI tool that scaffolds Python projects for beginners.

Project description

enkindl

A tiny CLI tool that scaffolds Python projects for beginners.

No frameworks. No magic. Just the right files in the right places, with plain-English explanations of what everything does.

Install

pip install enkindl

Usage

Scaffold a new project

enkindl init myproject

This creates a ready-to-go Python project:

myproject/
├── src/
│   └── myproject/
│       ├── __init__.py
│       └── cli.py
├── tests/
│   └── test_cli.py
├── pyproject.toml
├── README.md
└── .gitignore

You'll be prompted for a description and author name. The generated project is immediately installable:

cd myproject
python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e .
myproject                   # your CLI command works!

It even comes with a passing test:

pip install pytest
pytest

Explain Python concepts

New to Python packaging? Ask enkindl:

enkindl explain pyproject.toml
enkindl explain __init__.py
enkindl explain venv
enkindl explain src-layout
enkindl explain pip-install-e
enkindl explain requirements.txt
enkindl explain .gitignore
enkindl explain build
enkindl explain pypi
enkindl explain entry-points
enkindl explain pytest

Don't know what's available? Just ask for a topic that doesn't exist and enkindl will list them all.

Why?

Starting a Python project shouldn't require reading five blog posts and three Stack Overflow threads. enkindl gives you the modern, recommended project structure in one command, and explains every piece of it.

Built with

  • Python 3.12+
  • Standard library only (argparse, pathlib)
  • Zero dependencies

License

MIT

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

enkindl-0.2.1.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

enkindl-0.2.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file enkindl-0.2.1.tar.gz.

File metadata

  • Download URL: enkindl-0.2.1.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for enkindl-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fdc60a1dd8d070fe0306bdb2a1f07ae8e1ce960cc9294620b991792fd78cc027
MD5 461faf0c18df7973d71bebfac2631e70
BLAKE2b-256 2fb3b2243e2d2120f510949bc837a3bd467a2a1c79633d6c6e659ace05f2f316

See more details on using hashes here.

File details

Details for the file enkindl-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: enkindl-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for enkindl-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8dc7d759eb08d79d9635d1fa93cbd06641f1c429fcb0b17247425c61c06dcdd9
MD5 651f310e294878074324443dd8ea307b
BLAKE2b-256 ace28bc0af995467e12658ade50a63dfa1d0cb012527d0889fe92e054159bf5a

See more details on using hashes here.

Supported by

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