Skip to content

Commit

Permalink
doc: Remove mentions of the API server moved to tho Open Data Editor …
Browse files Browse the repository at this point in the history
…codebase (#1687)

- fixes #1669
  • Loading branch information
pierrecamilleri authored Sep 23, 2024
1 parent 0e60e0b commit fa0d9ed
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
1 change: 0 additions & 1 deletion README.md
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
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

0 comments on commit fa0d9ed

Please sign in to comment.