Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rgreinho/saliere

Templatize everything
https://github.com/rgreinho/saliere

Last synced: 9 days ago
JSON representation

Templatize everything

Awesome Lists containing this project

README

        

Salière
=======

.. image:: https://requires.io/github/rgreinho/saliere/requirements.svg?branch=master
:target: https://requires.io/github/rgreinho/saliere/requirements/?branch=master
:alt: Requirements Status

.. image:: https://readthedocs.org/projects/saliere/badge/?version=latest
:target: https://readthedocs.org/projects/saliere/?badge=latest
:alt: Documentation Status

Salière is a tool giving the ability to easily generate a skeleton for your project.

Install
-------

Using pip::

$ pip install saliere

Read the docs
-------------

The latest documentation is published on Read the Docs: http://saliere.readthedocs.org.

Build the docs
--------------

To build the documentation::

$ pip install sphinx
$ python setup.py build_sphinx

And then browse to doc/build/html/index.html

Contribute
----------

The repository is located on Github: https://github.com/rgreinho/saliere.

Formatting
^^^^^^^^^^

For formating the files properly, please use YAPF (https://github.com/google/yapf).

In the root directory of the project, run the following command:

.. code-block:: bash

yapf -r -i saliere/