Skip to content

Commit

Permalink
Fixed the usage example and the codecov badge.
Browse files Browse the repository at this point in the history
Version bumped to 1.0.1.
Added a test for the version number consistency.
  • Loading branch information
thomgrand committed Jan 29, 2022
1 parent 65c891b commit 3e21095
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 3 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CARTOreader - lite

[![CI Tests](https://github.com/thomgrand/cartoreader-lite/actions/workflows/python-package.yml/badge.svg)](https://github.com/thomgrand/cartoreader-lite/actions/workflows/python-package.yml)
[![codecov](https://codecov.io/gh/thomgrand/cartoreader-lite/branch/main/graph/badge.svg?token=4A7DD8DWXW)](https://codecov.io/gh/thomgrand/cartoreader-lite)
[![codecov](https://codecov.io/gh/thomgrand/cartoreader-lite/branch/public/graph/badge.svg?token=4A7DD8DWXW)](https://codecov.io/gh/thomgrand/cartoreader-lite)

This repository is an inofficial reader to easily process exported [CARTO3 data](https://www.jnjmedicaldevices.com/en-US/product/carto-3-system) in Python.
It does not provide the more extensive capabilities to analyze the signals, such as [OpenEP](https://openep.io/), but is rather meant as a simple reader to import CARTO data.
Expand All @@ -28,6 +28,9 @@ python tests/generate_test_data.py

```python
from cartoreader_lite import CartoStudy
import pyvista as pv
import numpy as np

study_dir = "openep-testingdata/Carto/Export_Study-1-11_25_2021-15-01-32"
study_name = "Study 1 11_25_2021 15-01-32.xml"
study = CartoStudy(study_dir, study_name,
Expand Down
2 changes: 1 addition & 1 deletion cartoreader_lite/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .high_level.study import CartoStudy, CartoAuxMesh, CartoMap, CartoPointDetailData, AblationSites

__version__ = "1.0.0"
__version__ = "1.0.1"
__author__ = "Thomas Grandits"
3 changes: 3 additions & 0 deletions docs/example.inc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ None is provided with this repository, but you can download the testing data pro
.. code-block:: python

from cartoreader_lite import CartoStudy
import pyvista as pv
import numpy as np

study_dir = "openep-testingdata/Carto/Export_Study-1-11_25_2021-15-01-32"
study_name = "Study 1 11_25_2021 15-01-32.xml"
study = CartoStudy(study_dir, study_name,
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
long_description = readme.read()

setup(name="cartoreader-lite",
version="1.0.0",
version="1.0.1",
description="Cartoreader-lite provides a simplified and easy low-level access to CARTO3 studies.",
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down
7 changes: 7 additions & 0 deletions tests/test_misc.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import pkg_resources
import cartoreader_lite
import re

def test_version_consistency():
version = pkg_resources.require("cartoreader-lite")[0].version
assert version == cartoreader_lite.__version__

0 comments on commit 3e21095

Please sign in to comment.