Skip to content

Update README with more context and links #99

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.

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 1 commit into from
Jan 18, 2023
Merged
Changes from all commits
Commits
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
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# Dataframe API standard

This repository contains documents, tooling and other content related to the
API standard for dataframes.
API standard for dataframes, and the dataframe interchange protocol.


## Dataframe API standard (draft)

This API is _draft and under development_, and moving towards an RFC status
where wider input from authors of dataframe and dataframe-consuming libraries
will be solicited. Those authors are the primary audience for this API, rather
than end users. Relevant content and links:

- [Dataframe API standard documentation](https://data-apis.org/dataframe-api/draft/index.html)


## Dataframe interchange protocol

This protocol is released and the specification should be considered stable. It
has implementations in multiple dataframe libraries (Pandas, cuDF, Modin, Vaex
at least). It may be extended and receive other necessary tweaks for things
discovered in the process of being adopted by a wider set of libraries.
Relevant content and links:

- [Request For Comments (RFC) for the dataframe interchange protocol (blog post)](https://data-apis.org/blog/dataframe_protocol_rfc/)
- [Dataframe interchange protocol documentation](https://data-apis.org/dataframe-protocol/latest/index.html)
- Issue tracker: [`interchange-protocol` label in this repo](https://github.com/data-apis/dataframe-api/issues?q=is%3Aopen+is%3Aissue+label%3Ainterchange-protocol)
- [Request For Comments (RFC) for the dataframe interchange protocol (blog post)](https://data-apis.org/blog/dataframe_protocol_rfc/)