Skip to content

Commit d7a1852

Browse files
authored
Update README.md and contributing.md (#78)
Signed-off-by: Anatoly Myachev <[email protected]>
1 parent 6abdf24 commit d7a1852

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
# Dataframe API Compat
66

7-
Extremely lightweight compatibility layer between pandas, Polars, and any other project which implements the [Python Dataframe API Standard](https://data-apis.org/dataframe-api/).
7+
Extremely lightweight compatibility layer between pandas, Polars, Modin and any other project which implements the [Python Dataframe API Standard](https://data-apis.org/dataframe-api/).
88

99
- ✅ No dependencies.
10-
- ✅ Lightweight: wheel is smaller than 30 kB.
10+
- ✅ Lightweight: wheel is smaller than 50 kB.
1111
- ✅ Simple, minimal, and predictable.
1212

1313
Documentation, including installation instructions and tutorial, are here: https://data-apis.org/dataframe-api-compat.

contributing.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,17 @@ pip install -r requirements-dev.txt
99
Testing
1010
-------
1111
```
12-
pytest test_standard.py --cov=dataframe_api_compat --cov=test_standard --cov-fail-under=100
12+
pytest tests --cov=dataframe_api_compat/pandas_standard --cov-fail-under=100 --library pandas-numpy
13+
pytest tests --cov=dataframe_api_compat/pandas_standard --cov-fail-under=100 --library pandas-nullable
14+
pytest tests --cov=dataframe_api_compat/polars_standard --cov-fail-under=100 --library polars-lazy
15+
# prerequisite: `pip install -r requirements-dev-modin.txt`
16+
pytest tests --cov=dataframe_api_compat/modin_standard --cov-fail-under=100 --library modin
1317
```
1418
100% branch coverage isn't the objective - it's the bare minimum.
1519

20+
**Note**: there is also requirement about 100% coverage in `tests` folder, however, to achieve one
21+
need to combine coverage from different implementations. How this is done can be seen in the `tox.yml` CI flow.
22+
1623
Linting
1724
-------
1825
```
@@ -25,11 +32,13 @@ Type Checking
2532
First, clone the [dataframe_standard](https://github.com/data-apis/dataframe-api) to some
2633
local path. Then, run:
2734
```console
28-
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat
29-
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy polars_standard.py
35+
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat/pandas_standard dataframe_api_compat/polars_standard
36+
# prerequisite: `pip install -r requirements-dev-modin.txt`
37+
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat/modin_standard
3038
```
3139

3240
For example, if you cloned both repos in the same place, this could be:
3341
```console
34-
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat
42+
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat/pandas_standard dataframe_api_compat/polars_standard
43+
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat/modin_standard
3544
```

0 commit comments

Comments
 (0)