Giter Club home page Giter Club logo

simple-template-tool's Introduction

simple-template-tool v0.0.1

CI Coverage Documentation Status Updates Code style: black

A simple tool for rendering templates.

Uses json files, jinja2 templates, and some python to glue it all together in order to allow simple templates to be written and rendered quickly.

$ stt --help
Usage: stt [OPTIONS]

  A simple template rendering tool.

Options:
  --info-directory DIRECTORY      The directory that contains info json files
                                  that will be injected into the template
                                  rendering context. Defaults to './info'

  --templates-directory DIRECTORY
                                  The directory that contains template files.
                                  Defaults to './templates'

  --output-directory DIRECTORY    The directory to write the rendered
                                  templates to. It will be created if it
                                  doesn't exist. Defaults to
                                  './rendered_templates'

  --help                          Show this message and exit.

See the full documentation at https://simple-template-tool.readthedocs.io

Installation

  • $ git clone https://github.com/bnbalsamo/simple-template-tool.git
  • $ cd simple-template-tool
    • If you would like to install the pinned dependencies, run pip install -r requirements.txt
  • $ python -m pip install .

Development

Quickstart

To quickly install + configure a development environment...

Install pyenv, pyenv-virtualenv, and xxenv-latest and copy the following into your terminal while in the repository root.

[[ `type -t pyenv` ]] && \
[ -s "$PYENV_ROOT/plugins/pyenv-virtualenv" ] && \
[ -s "$PYENV_ROOT/plugins/xxenv-latest" ] && \
pyenv latest install -s 3.8 && \
PYENV_LATEST_38=$(pyenv latest -p 3.8) && \
pyenv latest install -s 3.7 && \
PYENV_LATEST_37=$(pyenv latest -p 3.7) && \
pyenv latest install -s 3.6 && \
PYENV_LATEST_36=$(pyenv latest -p 3.6) && \
pyenv virtualenv "$PYENV_LATEST_38" "simple-template-tool" && \
pyenv local "simple-template-tool" "$PYENV_LATEST_38" "$PYENV_LATEST_37" "$PYENV_LATEST_36" && \
pip install -e .[dev,tests,docs]

Manual Configuration

If you choose not to use the quickstart script you will need to...

  • Create a virtual environment
  • Install the development dependencies
    • pip install -e .[dev,tests,docs]
  • Configure tox so that it can access all relevant python interpreters

Running Tests

$ inv run.tests

Running autoformatters

$ inv run.autoformatters

Pinning Dependencies

$ inv pindeps

Author

Brian Balsamo [email protected]

Created using bnbalsamo/cookiecutter-pypackage v0.34.1

simple-template-tool's People

Contributors

bnbalsamo avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.