Skip to content

Commit

Permalink
Add GitHub Actions workflow with publication to Coveralls; update REA…
Browse files Browse the repository at this point in the history
…DME badges.
  • Loading branch information
lapets committed May 24, 2022
1 parent 6f90b2b commit 388446c
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
33 changes: 33 additions & 0 deletions .github/workflows/lint-test-cover-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: lint-test-cover-docs
on:
push
jobs:
lint_test_cover_docs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.7', '3.8', '3.9', '3.10']
name: "Python ${{ matrix.python-version }}"
steps:
- uses: actions/checkout@v2
- name: Install Python.
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Lint and test module.
run: |
pip install -U pylint pytest pytest-cov .
python -m pylint exclusive # Check against linting rules.
python -m pytest # Run tests.
- name: Publish coverage results.
run: |
pip install -U coveralls
python -m coveralls --service=github # Submit to coveralls.
if: matrix.python-version == '3.8'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Test auto-generation of documentation.
run: |
pip install -U -r docs/requirements.txt
cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. ../setup.py && make html && cd ..
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ exclusive

Data structure for representing secret shares of byte vectors based on bitwise XOR, designed for use within secure multi-party computation (MPC) protocol implementations.

|pypi| |readthedocs|
|pypi| |readthedocs| |actions| |coveralls|

.. |pypi| image:: https://badge.fury.io/py/exclusive.svg
:target: https://badge.fury.io/py/exclusive
Expand All @@ -14,6 +14,14 @@ Data structure for representing secret shares of byte vectors based on bitwise X
:target: https://exclusive.readthedocs.io/en/latest/?badge=latest
:alt: Read the Docs documentation status.

.. |actions| image:: https://github.com/nthparty/exclusive/workflows/lint-test-cover-docs/badge.svg
:target: https://github.com/nthparty/exclusive/actions/workflows/lint-test-cover-docs.yml
:alt: GitHub Actions status.

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

Purpose
-------

Expand Down

0 comments on commit 388446c

Please sign in to comment.