Skip to content

Commit

Permalink
Add Travis CI build configuration with Coveralls invocation; add READ…
Browse files Browse the repository at this point in the history
…ME badges.
  • Loading branch information
lapets committed Oct 23, 2021
1 parent 83becdc commit 10bac73
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
20 changes: 20 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
notifications:
email:
on_success: never
on_failure: always
language: python
python:
- "3.7"
- "3.8"
cache: pip
install:
- pip install -r docs/requirements.txt
- pip install pylint
- pip install coveralls
- pip install .
script:
- cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html && cd ..
- pylint datatask
- nosetests
after_success:
- coveralls
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ datatask

General-purpose data structure and representation format for tasks (stand-alone or part of a larger data workflow) that involve multiple data resources.

|pypi| |readthedocs|
|pypi| |readthedocs| |travis| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/datatask.svg
:target: https://badge.fury.io/py/datatask
Expand All @@ -14,6 +14,14 @@ General-purpose data structure and representation format for tasks (stand-alone
:target: https://datatask.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.

.. |travis| image:: https://app.travis-ci.com/nthparty/datatask.svg?branch=main
:target: https://app.travis-ci.com/nthparty/datatask
:alt: Travis CI build status.

.. |coveralls| image:: https://coveralls.io/repos/github/nthparty/datatask/badge.svg?branch=main
:target: https://coveralls.io/github/nthparty/datatask?branch=main
:alt: Coveralls test coverage summary.

Package Installation and Usage
------------------------------
The package is available on `PyPI <https://pypi.org/project/datatask/>`_::
Expand Down Expand Up @@ -42,7 +50,7 @@ All unit tests are executed and their coverage is measured when using `nose <htt
python -m pip install nose coverage
nosetests --cover-erase

Some unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`_::
Alternatively, all unit tests are included in the module itself and can be executed using `doctest <https://docs.python.org/3/library/doctest.html>`_::

python datatask/datatask.py -v

Expand Down

0 comments on commit 10bac73

Please sign in to comment.