Improved testing and update readme / docs #45
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR basically introduces a new way of writing tests. Instead of a single file at the project root, we use pythons
unittest
lib (in this caseunittest2
because we want the same support for py2.7 and py3.6).Additionally, I fixed a view things with the
setup.py
and the documentation.setup.py
should not import anything from the project itself because it leads to errors like not being able to usepython setup.py install/develop
because it tries to importrequests
which it wouldinstall
with either of the said commands.TheJust saw there is asphinx
requirements to build the documentation were nowhere to be found.Pipfile
. Thus, I added an extra (docs
) which installs the required packages for us.unittests2
so we can run the tests.Your intent of importing the version from your package was probably so that you won't forget to update the version string somewhere without noticing. For that, I wholeheartedly recommend
zest.releaser
https://pypi.org/project/zest.releaser/. This package makes life as a developer easy by removing the whole hassle of releasing stuff.Before you release a package you can run
longtest
to check if the readme and changelog markup is correct and then you runfullrelease
which does the whole release pipeline.