https://github.com/willdunklin/danesfield-coverage
https://github.com/willdunklin/danesfield-coverage
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/willdunklin/danesfield-coverage
- Owner: willdunklin
- Created: 2022-05-11T20:06:01.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T23:40:46.000Z (about 4 years ago)
- Last Synced: 2025-03-05T01:45:14.760Z (over 1 year ago)
- Language: Shell
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
===================
danesfield-coverage
===================
Tool for testing coverage of Kitware's
`Danesfield `_ project using `coverage.py
`_.
Configuration
=============
Environment
-----------
Before using the tool you have to edit ``conda_source_dir`` in ``_
to reflect your conda base environment path. For this tool, it is set to
``~/miniconda3`` by default, however your conda base environment may be
located elsewhere.
To get your conda base environment directory you can run ``conda info`` and copy
the value from:
.. code-block::
base environment : <...>
Git
---
You can configure the git remote/branch by modifying the ``dashboard_git_url``
and ``dashboard_git_branch`` values respectively.
Usage
=====
To generate a coverage report run:
.. code-block::
./coverage.sh
The shell script generates a html coverage report located in the ``htmlcov``
directory.
Note:
-----
By default, the script will try to create/update the Danesfield `conda environment
`_
and install the ``coverage`` module. This process takes time, so if you want to
skip the conda validation (*if your environment is already up to date*) you can
use the ``-s`` or ``--skip`` flags:
.. code-block::
./coverage.sh -s