Skip to content
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

Jump to bottom

doc: Remove mentions of the API server moved to tho Open Data Editor codebase #1687

Merged
merged 1 commit into from
Sep 23, 2024
Merged

doc: Remove mentions of the API server moved to tho Open Data Editor codebase #1687

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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Data management framework for Python that provides functionality to describe, ex
- Support for compressed files
- Custom checks and formats
- Fully pluggable architecture
- The included API server
- More than 1000+ tests

## Installation
Expand Down
15 changes: 8 additions & 7 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ Still having a problem? Ask us for help on our [Discord](https://discord.com/inv
## Usage

The framework can be used:

- as a Python library
- as a command-line interface
- as a restful API server (for advanced use cases)

For instance, all the examples below do the same thing:
For instance, both examples below do the same thing:

```bash tabs=CLI
frictionless extract data/table.csv
Expand All @@ -47,13 +47,14 @@ from frictionless import extract
rows = extract('data/table.csv')
```

```json tabs=API
[POST] /extract {"path': 'data/table.csv"}
```

All these interfaces are as much alike as possible regarding naming conventions and the way you interact with them. Usually, it's straightforward to translate, for instance, Python code to a command-line call. Frictionless provides code completion for Python and the command-line, which should help to get useful hints in real time. You can find the API reference at the bottom of the respective page, for example: [Schema API Reference](../../docs/framework/schema.html#reference).
The interfaces are as much alike as possible regarding naming conventions and
the way you interact with them. Usually, it's straightforward to translate,
for instance, Python code to a command-line call. Frictionless provides code
completion for Python and the command-line, which should help to get useful
hints in real time.

Arguments conform to the following naming convention:

- for Python interfaces, they are snake_cased, e.g. `missing_values`
- within dictionaries or JSON objects, they are camelCased, e.g. `missingValues`
- in the command line, they use dashes, e.g. `--missing-values`
Expand Down