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.0.tar.gz (5.3 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.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: enkindl-0.2.0.tar.gz
  • Upload date:
  • Size: 5.3 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.0.tar.gz
Algorithm Hash digest
SHA256 9bf0c0395009b3dca248abf3cd6a1856fc1c59957a0def07b5aa26eeef0399d3
MD5 5cef8bf0d0f2c205b7235ebdf79df23b
BLAKE2b-256 82f620e4992196345f52f42452c4bfe38e0d55b980209feb8e99b1157ecf335f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: enkindl-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef389763c40b78ae6faf882258efd2e3acb57226b0aa85d1d0412e4021d9b8b0
MD5 29de494990f76cacbb545473809e6034
BLAKE2b-256 f4e932a3c466c31b06b5b2b60cadce97c1b11bff870b69aa780ffc0dce79f307

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