A project templating and scaffolding tool
Project description
iTmpl. A flexible, powerful project templating tool, written in Python.
Documentation: https://itmpl.ihh.dev
Source: https://github.com/isaacharrisholt/itmpl
iTmpl is a project templating tool that allows you to create and manage project templates. iTmpl is written in Python and is cross-platform.
It comes with some default templates, but you can also create your own. iTmpl also allows you to run arbitrary Python code before and after the templating process, allowing you to do things like create a git repository, or install dependencies.
Installation
Although iTmpl has a well-documented API, its primary aim it to be a command
line tool. As such, the recommended installation method is via
pipx
:
pipx install itmpl
However, you can also install iTmpl via pip
, if you prefer:
pip install itmpl
Quick Start
To see available project templates, run:
itmpl list
To create a new project from a template, run:
itmpl new <template> <project-name> [options]
For example, to create a new Poetry project, run:
itmpl new poetry-project my-new-project
Adding Custom Templates
Custom templates are stored in an extra_templates_dir
specified in the iTmpl
configuration file. To find the default location for your machine, run:
itmpl config show extra_templates_dir
To change the location of the extra_templates_dir
, run:
itmpl config set extra_templates_dir <path>
To create a new template, simple create a new directory in the
extra_templates_dir
. iTmpl will automatically detect the new template, and
show it in the list of available templates.
Templates can be configured through .itmpl.toml
and .itmpl.py
files. See
the
documentation
for more details.
Contributing
Contributions are welcome! If you find a bug, or have a feature request, please open a new issue. If you would like to contribute code, please open a new pull request.
I'm always open to new templates too! I don't know every possible use case for this tool, so I've only included a few templates that I thought would be useful to me. If you have a template that you think would be useful to others, please open a new issue, or submit a pull request!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file itmpl-0.1.9.tar.gz
.
File metadata
- Download URL: itmpl-0.1.9.tar.gz
- Upload date:
- Size: 28.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69f08e08a278a193c6b51e6df48e7258d54d17e459a2f62c6ce64881a2b50835 |
|
MD5 | 285b08766294f0885d0ccc43194653d2 |
|
BLAKE2b-256 | e5c93c40e1aad09e3c875ced34e5bf94ad5b0172306ffc7e3223232c04a9c8e2 |
File details
Details for the file itmpl-0.1.9-py3-none-any.whl
.
File metadata
- Download URL: itmpl-0.1.9-py3-none-any.whl
- Upload date:
- Size: 34.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ab96f03fe66cee524187518bc17a2e42b983a0ea0b302b277f4fd8f9f722636 |
|
MD5 | 76da6f0447b274ab649a774fe1d9fd6f |
|
BLAKE2b-256 | 3f361e0008ff2da74e84f35de58709e0953f0258f725b16d7e180f0917579466 |