Rearranges tests

adds dockerized tests

Author: austinpray

.coveragerc

@@ -1,3 +1,3 @@
 [run]
 branch = True
-source = slacktools
+source = src

.travis.yml

@@ -5,7 +5,7 @@ matrix:
     - python: 3.7
       dist: xenial
       sudo: true
-      script: pytest && codecov
+      script: python setup.py test && codecov
     - python: 3.4
     - python: 3.5
     - python: 3.6
@@ -22,4 +22,4 @@ matrix:
 install:
 - pip install -r requirements-dev.txt
 script:
-- pytest
+- python setup.py test

Makefile

@@ -1,7 +1,19 @@
-.PHONY: build publish test
+.PHONY: build publish test test-all test-%
 
 build:
 	python setup.py sdist bdist_wheel
 
 publish: build
 	twine upload dist/*
+
+test:
+	${MAKE} test-3.7
+
+test-all:
+	${MAKE} test-3.7
+	${MAKE} test-3.6
+	${MAKE} test-3.5
+	${MAKE} test-3.4
+
+test-%:
+	docker run --rm -v $(shell pwd):/app -w /app python:$(@:test-%=%) python setup.py test

README.rst

@@ -16,6 +16,20 @@ A toolbelt for working with the various `Slack APIs`_ in python.
 .. |Code Coverage| image:: https://codecov.io/gh/austinpray/python-slacktools/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/austinpray/python-slacktools
 
+
+Install
+-------
+
+Install slacktools with `PyPI <https://pypi.python.org/pypi>`_
+
+.. code-block:: bash
+
+    pip install slacktools
+
+This library is tested against Python 3.4+. `Open an issue`__ if you need this library to work on an older version.
+
+__ https://github.com/austinpray/python-slacktools/issues/new
+
 Features
 --------
 
@@ -29,9 +43,30 @@ Features
   and improve testability
 - `Silly stuff`_
 
-
 Check out `the docs`_ for more info and `API documentation`_.
 
+Tests
+-----
+
+Running the tests is simple enough:
+
+.. code-block:: bash
+
+    python setup.py test
+
+Or just ``pytest`` will do the trick. This will run the tests in the ``tests/``
+directory as well as as bunch of docstring tests in the ``src/`` directory.
+
+The Makefile also has some good test commands that will spin up a docker container:
+
+- ``make test`` will run the tests in python 3.7.
+- ``make test-all`` will run a series of tests from python 3.7 down to 3.4.
+- ``make test-{{PY_VERSION}}`` where ``PY_VERSION`` can be `any tagged version
+  of the official python docker image`__ will run tests under that python
+  version. Ex: ``make test-3.5`` will run under Python 3.5.
+
+__ https://hub.docker.com/_/python/
+
 Roadmap
 -------
 

docs/source/conf.py

@@ -14,7 +14,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../../src'))
 
 
 # -- Project information -----------------------------------------------------

pytest.ini

@@ -1,3 +1,3 @@
 [pytest]
 addopts = --doctest-modules --cov
-testpaths = slacktools
+testpaths = src tests

requirements-dev.txt

@@ -1,6 +1,4 @@
 codecov
-pytest
-pytest-cov
 
 sphinx
 sphinx-autobuild

setup.cfg

@@ -0,0 +1,2 @@
+[aliases]
+test=pytest

setup.py

@@ -25,7 +25,7 @@ def find_version(*file_paths):
 
 
 setup(name='slacktools',
-      version=find_version('slacktools', 'version.py'),
+      version=find_version('src', 'slacktools', 'version.py'),
       description='Toolbelt for Slack API clients for Web API and RTM API',
       long_description=long_description,
       url='https://github.com/austinpray/python-slacktools',
@@ -47,6 +47,6 @@ def find_version(*file_paths):
       ],
       keywords='slack slack-web slack-rtm slacktools chat chatbots bots chatops',
       packages=find_packages(exclude=['docs', 'tests']),
-      install_requires=[
-          # ayy
-      ])
+      setup_requires=["pytest-runner"],
+      tests_require=["pytest", "pytest-cov"],
+      install_requires=["typing"])