Merge pull request #17 from sivakov512/simplify-installation-and-depe…

…ndencies

Simplify installation and dependencies

.travis.yml

@@ -9,12 +9,13 @@ python:
   - "3.7"
 
 install:
+  - python setup.py develop
   - pip install coveralls -r requirements.txt
 
 script:
   - flake8
   - black --check ./
-  - coverage run --source full_yaml_metadata -m setup test
+  - coverage run --source full_yaml_metadata -m pytest
 
 after_success:
   - coveralls

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/sivakov512/python-markdown-full-yaml-metadata.svg?branch=master)](https://travis-ci.org/sivakov512/python-markdown-full-yaml-metadata)
 [![Coverage Status](https://coveralls.io/repos/github/sivakov512/python-markdown-full-yaml-metadata/badge.svg)](https://coveralls.io/github/sivakov512/python-markdown-full-yaml-metadata)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-![Python versions](https://img.shields.io/badge/python-3.6,%203.7-blue.svg)
+[![Python versions](https://img.shields.io/pypi/pyversions/markdown-full-yaml-metadata.svg)](https://pypi.python.org/pypi/markdown-full-yaml-metadata)
 [![PyPi](https://img.shields.io/pypi/v/markdown-full-yaml-metadata.svg)](https://pypi.python.org/pypi/markdown-full-yaml-metadata)
 
 This extension adds YAML meta data handling to markdown with all YAML features.
@@ -34,6 +34,31 @@ md.convert(text) == '<p>Lorem Ipsum is simply dummy text.</p>'
 md.Meta == {'title': 'What is Lorem Ipsum?', 'categories': ['Lorem Ipsum', 'Stupid content']}
 ```
 
+## Development and contribution
+
+* install project dependencies
+```bash
+python setup.py develop
+```
+
+* install linting, formatting and testing tools
+```bash
+pip install -r requirements.txt
+```
+
+* run tests
+```bash
+pytest
+```
+
+* run linters
+```bash
+flake8
+black --check ./
+```
+
+* feel free to contribute!
+
 ## Python versions compatibility
 
 This plugin tested with python versions 3.6 and 3.7.

requirements.txt

@@ -8,17 +8,15 @@ flake8==3.7.7
 flake8-debugger==3.1.0
 flake8-isort==2.7.0
 flake8-print==3.1.0
-flake8-quotes==1.0.0
-isort==4.3.16
-Markdown==3.1
+flake8-quotes==2.0.1
+isort==4.3.17
 mccabe==0.6.1
 more-itertools==7.0.0
 pluggy==0.9.0
 py==1.8.0
 pycodestyle==2.5.0
 pyflakes==2.1.1
-pytest==4.4.0
-PyYAML==5.1
+pytest==4.4.1
 six==1.12.0
-testfixtures==6.6.2
+testfixtures==6.7.0
 toml==0.10.0

setup.py

@@ -20,8 +20,11 @@ def read(fname):
     name="markdown-full-yaml-metadata",
     py_modules=["full_yaml_metadata"],
     python_requires=">=3.6",
-    setup_requires=["pytest-runner"],
-    tests_require=["pytest"],
-    version="2.0.0",
+    version="2.0.1",
     url="https://github.com/sivakov512/python-markdown-full-yaml-metadata",
+    classifiers=[
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+    ],
 )