Merge pull request #336 from metachris/cleanup-and-deps

README cleanup, dev dependency update

.gitignore

@@ -3,6 +3,7 @@ __pycache__/
 *.py[cod]
 *$py.class
 .venv*
+venv*
 
 # C extensions
 *.so

README.rst → README.md

@@ -38,6 +38,7 @@ Features
 
 * Easy logging to console and/or (rotating) file.
 * Provides a fully configured standard `Python logger object <https://docs.python.org/2/library/logging.html#module-level-functions>`_.
+* No dependencies (except on Windows `colorama` for color output)
 * Pretty formatting, including level-specific colors in the console.
 * Windows color output supported by `colorama`_
 * Robust against str/bytes encoding problems, works with all kinds of character encodings and special characters.
@@ -165,6 +166,40 @@ On openSUSE you can install the current version from repos: `python2-logzero <ht
 .. _Github repo: https://github.com/metachris/logzero
 
 
+Development
+-----------
+
+* This project is using pytest
+
+Getting started
+
+```
+# Activate virtualenv
+$ python3 -m venv venv
+$ . venv/bin/activate
+
+# Install main and dev dependencies
+$ pip install -e .
+$ pip install -r requirements_dev.txt
+
+# Run the tests
+$ make test
+
+# Run the linter
+$ make lint
+
+# Generate the docs (will auto-open in Chrome)
+$ make docs
+```
+
+### To do
+
+* Update dependencies
+* add github workflow for CI
+* test with every python version
+
+---
+
 Changelog
 ---------
 

requirements_dev.txt

@@ -1,11 +1,9 @@
-bumpversion==0.5.3
-wheel==0.30.0
-watchdog==0.8.3
-flake8==3.5.0
-coverage==4.5.1
-tox==2.9.1
-cryptography==2.1.4
-Sphinx==1.7.1
-pytest==3.4.2
-PyYAML==3.12
-pytest-runner==4.0
+pytest==6.1.1
+pytest-runner==5.2
+bumpversion==0.6.0
+watchdog==0.10.3
+flake8==3.8.4
+coverage==5.3
+tox==3.20.1
+cryptography==3.1.1
+Sphinx==3.2.1

setup.py

@@ -5,7 +5,7 @@
 
 from setuptools import setup, find_packages
 
-with open('README.rst') as readme_file:
+with open('README.md') as readme_file:
     readme = readme_file.read()
 
 with open('HISTORY.rst') as history_file: