Skip to content

Commit

Permalink
Add shields to README (#35)
Browse files Browse the repository at this point in the history
* Coverage report

* Add coverage badge

* Add PyPI Python versions shield

* Add black formatter badge

* Rename workflow
  • Loading branch information
douglascdev authored Jan 9, 2023
1 parent 0b72d9e commit f49eb55
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/coverage-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: API workflow

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest
name: Test coverage
steps:
- uses: actions/checkout@v1
- name: Install requirements
run: pip install -e .[dev]
- name: Run tests and collect coverage
run: coverage run --source hashtablebot -m unittest discover
- name: Upload coverage reports to Codecov
run: |
curl -Os https://uploader.codecov.io/latest/linux/codecov
chmod +x codecov
./codecov -t ${CODECOV_TOKEN}
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Hash Table Bot
==============

.. image:: https://img.shields.io/pypi/pyversions/hashtablebot
:alt: PyPI - Python Version

.. image:: https://codecov.io/gh/douglascdev/hashtablebot/branch/main/graph/badge.svg?token=8P7U85055I
:target: https://codecov.io/gh/douglascdev/hashtablebot

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

Hash Table Bot is an open-source twitch bot made in Python.

Have a look at our `Getting Started <https://hashtablebot.readthedocs.io/en/latest/getting_started.html>`_ page for more information.

0 comments on commit f49eb55

Please sign in to comment.