Skip to main content

Generate new files from templates.

Project description

https://travis-ci.org/cjrh/templitz.svg?branch=master https://coveralls.io/repos/github/cjrh/templitz/badge.svg?branch=master https://img.shields.io/pypi/pyversions/templitz.svg https://img.shields.io/github/tag/cjrh/templitz.svg https://img.shields.io/badge/install-pip%20install%20templitz-ff69b4.svg https://img.shields.io/pypi/v/templitz.svg https://img.shields.io/badge/calver-YYYY.MM.MINOR-22bfda.svg

ALPHA

templitz

File templates for faster project bootstrap

Overview

So you’re making another Python project and there are a bunch of boilerplate files you need (use cookiecutter), or you have an existing project that you want to add some stuff to (cookiecutter doesn’t help). templitz offers a very lightweight way to add some typical files to a project.

For example:

$ templitz -t travis
$ templitz -t appveyor

These two commands will dump a typical .travis.yml and a appveyor.yml into your current directory (which should probably be the root of a Python project for any of this to make sense).

This program does nothing other than look up a file with a .templitz extension, and if found, copies that into your target folder. It’s just an easy way to add standard, boilerplate files to projects. Examples are CI configs, setup.py, flit.ini, README.rst, pytest.ini and so on. This tools just does the same copy-from-a-previous-project file copying that you would normally do by hand.

Here are a few more examples:

$ templitz -t asyncio

This one dumps a typical starter main.py for an asyncio-based application.

How about a C/C++? This one will dump a generic Makefile that will work out-of-the-box for most typical C/C++ projects:

$ templitz -t Makefile

BYO templitz

templitz includes a few example templates (in the /library directory), but you can also add your own quite easily: just set the TEMPLITZ_PATH env var to configure your own search path for templates:

$ export TEMPLITZ_PATH=$HOME/.mytemplitz:$HOME/.myothertemplitz

Then your own templitz will be found automatically. Note that the first templit found that matches the given -t parameter is the one that hits, and the TEMPLITZ_PATH setting is checked first.

Reference

$ templitz --help
usage: templitz.py [-h] [-t TEMPLATE] [-i] [-l] [-s] [-o OUTDIR]
                   [-p PARAMS [PARAMS ...]]

optional arguments:
  -h, --help            show this help message and exit
  -t TEMPLATE, --template TEMPLATE
  -i, --info            Information about the templit.
  -l, --list            List all available templitz.
  -s, --stdout          Write to stdout instead of file.
  -o OUTDIR, --outdir OUTDIR
                        Output directory.
  -p PARAMS [PARAMS ...], --params PARAMS [PARAMS ...]

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

templitz-2017.10.3.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

templitz-2017.10.3-py2.py3-none-any.whl (18.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file templitz-2017.10.3.tar.gz.

File metadata

  • Download URL: templitz-2017.10.3.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for templitz-2017.10.3.tar.gz
Algorithm Hash digest
SHA256 33b358b459768cb02471c71cb955cc0a1064ffdac8f99e8b30be477b513eb45a
MD5 45df848e056ccdba350569d14cb321ba
BLAKE2b-256 12f59e7f1b48a933170a2d91b419384854861675011b04e4b3e8c4d7910c9974

See more details on using hashes here.

File details

Details for the file templitz-2017.10.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for templitz-2017.10.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c062b79d96b2b333bddb3495820c6add9b14d0729aee65c4dde1662b48508c60
MD5 373fb04cdb3289c9732dd3dc9d943418
BLAKE2b-256 69d72d45f8b47d69cc3b24f33a3eaf2cf9fb43bad4b82ca7104a3926007a7fdf

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