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
├── 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!

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

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.1.1.tar.gz (4.9 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.1.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for enkindl-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1f86a5acfd103ced2771237df281ae44932a5fc5a179a34e2b9710590c0eb0cf
MD5 b56eb2c16dd72a716c3adbdd48446a9b
BLAKE2b-256 9556a8f4098dec9818ccda527d5aa1315772b4d86406b4af7e7c7ccc7d0cb03b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: enkindl-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1e64fdfb096d0710bf13d44618d32ce511730ae822feb9d28b8776f75ed3650c
MD5 e199cd5967826566a5b807a5a41370f5
BLAKE2b-256 c628c5404179adcf492da261dec366838d5d2d5b515eb8278902372be109de49

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