Skip to content

docs: add features page #157

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
afuetterer merged 1 commit into from
Jul 4, 2024
Merged

docs: add features page #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ watch:

nav:
- Home: index.md
- Features: features.md
- Getting Started:
- Installation: install.md
- Reference:
Expand Down Expand Up @@ -76,6 +77,8 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: true

Expand Down
29 changes: 29 additions & 0 deletions docs/src/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Features

## Repositories

Some features listed here, loosely correspond to the features of the endpoints defined in the
[re3data API](https://www.re3data.org/api/doc).

- [x] retrieve metadata about all repositories
- [x] retrieve a single repository by its identifier
- [x] search for repositories with a query string
- [ ] get total count of retrieved repositories
- [ ] filter and retrieve repositories

## Return Types

The return types are based on the original XML responses from the API, with additional options for improved usability.

- [x] Original XML (str)
- [x] Dataclass representation
- [x] Response object
- [x] Dictionary
- [x] JSON (str)
- [ ] CSV (str)
- [ ] Pandas DataFrame

<!---
This features page is adapted from:
- "Ultimate Notion" Features, (https://github.com/ultimate-notion/ultimate-notion/blob/0c874c489c1562b098cc61c0a5b6041442309061/docs/features.md) (MIT license)
--->