diff --git a/README.md b/README.md index d94959b..44caed4 100644 --- a/README.md +++ b/README.md @@ -44,17 +44,15 @@ in the [BrewSci](https://github.com/chrisgilmerproj/brewsci) repo. # Data -The `data/` directory holds data used by parsers in the repo to build recipes. -The data was gathered using Scrapy to gather info from different brewing -websites. The scraping code exists there along with the following data dirs: +To parse or build recipes you will need a directory that holds data for the +following types: -- `cereals/` -- `hops/` -- `water/` -- `yeast/` +- cereals +- hops +- water +- yeast -All the data is formatted in `*.json` files. The files are guaranteed to work -with the parsers in this library. +To help with this you can use the [BrewData](https://github.com/chrisgilmerproj/brewdata) repo. # Units diff --git a/README.rst b/README.rst index 677d10f..d16be25 100644 --- a/README.rst +++ b/README.rst @@ -48,18 +48,16 @@ in the `BrewSci `__ repo. Data ==== -The ``data/`` directory holds data used by parsers in the repo to build -recipes. The data was gathered using Scrapy to gather info from -different brewing websites. The scraping code exists there along with -the following data dirs: +To parse or build recipes you will need a directory that holds data for +the following types: -- ``cereals/`` -- ``hops/`` -- ``water/`` -- ``yeast/`` +- cereals +- hops +- water +- yeast -All the data is formatted in ``*.json`` files. The files are guaranteed -to work with the parsers in this library. +To help with this you can use the +`BrewData `__ repo. Units ===== @@ -101,8 +99,7 @@ Example: .. code:: sh $ source .venv/bin/activate - (.venv) $ pip install -r requirements-local.txt --upgrade - (.venv) $ make html + (.venv) $ pip install -r requirements-local.txt --upgrade && make clean html .. |PyPI| image:: https://img.shields.io/pypi/v/brewday.svg :target: https://pypi.python.org/pypi/brewday/0.0.6 diff --git a/make_pypi_readme.py b/make_pypi_readme.py deleted file mode 100755 index 018d68d..0000000 --- a/make_pypi_readme.py +++ /dev/null @@ -1,13 +0,0 @@ -#! /usr/bin/env python - -""" -PyPI requires reStructureText for the README file. This converts the README.md -that is primarily used on Github to a README.rst file for PyPI. -""" - -from pypandoc import convert - - -if __name__ == "__main__": - with open('README.rst', 'w') as f: - f.write(convert('README.md', 'rst', 'md')) diff --git a/make_pypi_readme.sh b/make_pypi_readme.sh new file mode 100755 index 0000000..f290750 --- /dev/null +++ b/make_pypi_readme.sh @@ -0,0 +1,6 @@ +#! /bin/bash + +# PyPI requires reStructureText for the README file. This converts the README.md +# that is primarily used on Github to a README.rst file for PyPI. + +pandoc -f markdown -t rst README.md -o README.rst