Skip to content

Update README.md and contributing.md #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Update README.md and contributing.md #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25e65c8
Update README.md
anmyachev Apr 25, 2024
976f775
update also 'contributing.md'
anmyachev Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

# Dataframe API Compat

Extremely lightweight compatibility layer between pandas, Polars, and any other project which implements the [Python Dataframe API Standard](https://data-apis.org/dataframe-api/).
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/).

- ✅ No dependencies.
- ✅ Lightweight: wheel is smaller than 30 kB.
- ✅ Lightweight: wheel is smaller than 50 kB.
- ✅ Simple, minimal, and predictable.

Documentation, including installation instructions and tutorial, are here: https://data-apis.org/dataframe-api-compat.
17 changes: 13 additions & 4 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,17 @@ pip install -r requirements-dev.txt
Testing
-------
```
pytest test_standard.py --cov=dataframe_api_compat --cov=test_standard --cov-fail-under=100
pytest tests --cov=dataframe_api_compat/pandas_standard --cov-fail-under=100 --library pandas-numpy
pytest tests --cov=dataframe_api_compat/pandas_standard --cov-fail-under=100 --library pandas-nullable
pytest tests --cov=dataframe_api_compat/polars_standard --cov-fail-under=100 --library polars-lazy
# prerequisite: `pip install -r requirements-dev-modin.txt`
pytest tests --cov=dataframe_api_compat/modin_standard --cov-fail-under=100 --library modin
```
100% branch coverage isn't the objective - it's the bare minimum.

**Note**: there is also requirement about 100% coverage in `tests` folder, however, to achieve one
need to combine coverage from different implementations. How this is done can be seen in the `tox.yml` CI flow.

Linting
-------
```
Expand All @@ -25,11 +32,13 @@ 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
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat/pandas_standard dataframe_api_compat/polars_standard
# prerequisite: `pip install -r requirements-dev-modin.txt`
MYPYPATH=<path to dataframe-api/spec/API_specification> mypy dataframe_api_compat/modin_standard
```

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
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat/pandas_standard dataframe_api_compat/polars_standard
MYPYPATH=../dataframe-api/spec/API_specification/ mypy dataframe_api_compat/modin_standard
```