Merge pull request #7 from radionets-project/ci_codecov

Add codecov to CI

.github/workflows/ci.yml

@@ -99,7 +99,12 @@ jobs:
 
       - name: Tests
         run: |
-          pytest --cov
+          pytest --cov --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   docs:
     runs-on: ubuntu-latest

README.rst

@@ -0,0 +1,29 @@
+=========================
+radiotools |ci| |codecov|
+=========================
+
+.. |ci| image:: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml/badge.svg?branch=main
+    :target: https://github.com/radionets-project/radiotools/actions/workflows/ci.yml?branch=main
+    :alt: Test Status
+
+.. |codecov| image:: https://codecov.io/github/radionets-project/radiotools/badge.svg
+    :target: https://codecov.io/github/radionets-project/radiotools
+    :alt: Code coverage
+
+
+Collection of tools for use in radio astronomy.
+
+
+Installation
+============
+
+*radiotools* can be installed via pip by calling
+
+.. code::
+
+  $ pip install -e .
+
+We recommend using a conda/mamba environment with python version ``<=3.11``.
+
+If you want to use features from the NRAO `CASAtools <https://pypi.org/project/casatools/>`_ package,
+you make sure you are using python 3.10 or 3.11.

docs/changes/7.maintenance.rst

@@ -0,0 +1 @@
+- Add Codecov report to CI