Add circle & documentation

.circleci/config.yml

@@ -0,0 +1,88 @@
+version: 2
+jobs:
+  test-py35:
+    docker:
+      - image: python:3.5
+
+    steps:
+      - checkout
+
+      - run:
+          name: Run coverage tests
+          command: |
+            pip install coverage
+            coverage run setup.py test
+            coverage report -m
+
+  test-py36:
+    docker:
+      - image: python:3.6
+
+    steps:
+      - checkout
+
+      - run:
+          name: Run coverage tests
+          command: |
+            pip install coverage
+            coverage run setup.py test
+            coverage report -m
+
+  test-py37:
+    docker:
+      - image: python:3.7
+
+    steps:
+      - checkout
+
+      - run:
+          name: Run coverage tests
+          command: |
+            pip install coverage
+            coverage run setup.py test
+            coverage report -m
+
+      - save_cache:
+          key: coverage-{{ .Branch }}-{{ .Revision }}
+          paths:
+            - .coverage
+
+  codecov:
+    docker:
+      - image: python:3
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - coverage-{{ .Branch }}-{{ .Revision }}
+      - run:
+          name: Upload to codecov.io
+          command: |
+            pip install codecov
+            codecov
+
+  style:
+    docker:
+      - image: python:3
+    steps:
+      - checkout
+
+      - run:
+          name: Run flake8
+          command: |
+            pip install flake8 flake8-docstrings
+            flake8
+
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test-py35
+      - test-py36
+      - test-py37
+      - codecov:
+          requires:
+            - test-py37
+      - style

README.rst

@@ -1,3 +1,10 @@
+.. 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
 ========
 
@@ -14,7 +21,7 @@ Synthale requires Python 3. Install Synthale from PyPi:
 
 ::
 
-    pip3 install synthale
+  pip3 install synthale
 
 
 
@@ -23,16 +30,16 @@ Usage
 
 ::
 
-    $ synthale --help
-    Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH
+  $ synthale --help
+  Usage: synthale [OPTIONS] INPUT_PATH OUTPUT_PATH
 
-    Generate markdown files from BeerXML files.
+  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.
+  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.
+  Options:
+  --help  Show this message and exit.
 
 
 

setup.py

@@ -27,7 +27,7 @@ setup(
         synthale=synthale.cli:main
     ''',
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
+        'Development Status :: 4 - Beta',
         'Environment :: Console',
         'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
         'Natural Language :: English',