-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4e15e88
commit 651878d
Showing
5 changed files
with
39 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
Installation | ||
------------ | ||
``` | ||
python3.10 -m venv .venv | ||
. .venv/bin/activate | ||
pip install -U pip wheel | ||
pip install -r requirements-dev.txt | ||
``` | ||
Testing | ||
------- | ||
``` | ||
pytest test_standard.py --cov=dataframe_api_compat --cov=test_standard --cov-fail-under=100 | ||
``` | ||
100% branch coverage isn't the objective - it's the bare minimum. | ||
|
||
Linting | ||
------- | ||
``` | ||
pre-commit run --all-files | ||
``` | ||
|
||
Type Checking | ||
------------- | ||
|
||
First, clone the [dataframe_standard](https://github.com/data-apis/dataframe-api) to some | ||
local path. Then, run: | ||
```console | ||
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat | ||
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy polars_standard.py | ||
``` | ||
|
||
For example, if you cloned both repos in the same place, this could be: | ||
```console | ||
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
. type-check.sh | ||
pytest tests --cov=dataframe_api_compat --cov=tests --cov-fail-under=100 | ||
pytest tests --cov=dataframe_api_compat --cov=tests --cov-fail-under=100 -W error |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
covdefaults | ||
pandas | ||
polars | ||
pre-commit | ||
pyarrow | ||
pytest | ||
pytest-cov |