emma/synthale
1
0
Fork 0
mirror of https://github.com/shouptech/synthale.git synced 2026-02-03 07:29:42 +00:00
Code Issues Releases Wiki Activity
No description
28 commits 1 branch 3 tags 114 KiB
Find a file
Mike Shoup 65dcd1811e Too much whitespace
2018-12-31 13:37:19 -07:00
.circleci Add circle & documentation 2018-12-31 13:35:39 -07:00
src/synthale Add zero length mash & misc ingredients. 2018-12-31 11:30:22 -07:00
tests Add zero length mash & misc ingredients. 2018-12-31 11:30:22 -07:00
.gitignore initial commit 2018-12-22 08:04:18 -07:00
LICENSE Add ability to parse recipes 2018-12-22 16:50:30 -07:00
README.rst Too much whitespace 2018-12-31 13:37:19 -07:00
setup.cfg Add ability to parse recipes 2018-12-22 16:50:30 -07:00
setup.py Add circle & documentation 2018-12-31 13:35:39 -07:00
test-requirements.txt Add ability to parse recipes 2018-12-22 16:50:30 -07:00

README.rst 

.. image:: https://circleci.com/gh/shouptech/synthale.svg?style=shield
  :target: https://circleci.com/gh/shouptech/synthale

.. image:: https://codecov.io/gh/shouptech/synthale/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/shouptech/synthale


Synthale
========

A python application to convert valid BeerXML_ files into Markdown files. You
can then use those Markdown files in your favorite static website generator.

.. _BeerXML: http://www.beerxml.com/


Installation
------------

Synthale requires Python 3. Install Synthale from PyPi:

::

  pip3 install synthale


Usage
-----

::

  $ synthale --help
  Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH

  Generate markdown files from BeerXML files.

  INPUT_PATH is either a directory containing XML files, or an individual
  XML file. OUTPUT_PATH is the directory to write the markdown files to.

  Options:
  --help  Show this message and exit.


License
-------

Synthale is released under the GPLv3_ license.

.. _GPLv3: LICENSE