Skip to content

Commit 64aa54b

Browse files
committed
added unit tests badge to readme and updated its contents; added .coverage to ignored and updated reqs
1 parent 71db1e6 commit 64aa54b

3 files changed

Lines changed: 17 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ moddata/data/archive.zip
66
moddata/data/btc.parquet
77
moddata/data/stooq_data/
88
sandbox.py
9+
.coverage

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# moddata
22

3+
![CI](https://github.com/wegar-2/moddata/actions/workflows/python-tests.yml/badge.svg)
4+
![Python](https://img.shields.io/pypi/pyversions/moddata)
5+
36
Provides data for use in modeling.
47

58
Interface consists of a single function ```load_data```. It accepts
@@ -11,9 +14,19 @@ List of currently available datasets:
1114
3. `pl_banking_stocks` - daily prices of stocks of select
1215
Polish banks for period 2005-01-01 through 2024-12-31
1316
(data source: [stooq.com](https://stooq.com/))
14-
4.
17+
1518

1619
To install this package run:
1720
```
1821
pip install git+https://github.com/wegar-2/moddata.git@main
22+
```
23+
24+
Run unit tests from the main package directory with:
25+
```
26+
pytest
27+
```
28+
29+
Check tests coverage with:
30+
```
31+
pytest --cov=moddata tests/
1932
```

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
annotated-types==0.7.0
22
certifi==2025.4.26
33
charset-normalizer==3.4.2
4+
coverage==7.8.2
45
cramjam==2.10.0
56
fastparquet==2024.11.0
67
fsspec==2025.5.0
@@ -16,6 +17,7 @@ pyarrow==20.0.0
1617
pydantic==2.11.5
1718
pydantic_core==2.33.2
1819
pytest==8.3.5
20+
pytest-cov==6.1.1
1921
python-dateutil==2.9.0.post0
2022
pytz==2025.2
2123
PyYAML==6.0.2

0 commit comments

Comments
 (0)