Skip to content

Commit

Permalink
Put tatoebatools in bold in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LBeaudoux committed Sep 17, 2021
1 parent 7dbc05b commit 55000d0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Actions Status](https://github.com/LBeaudoux/tatoebatools/workflows/CI/badge.svg)](https://github.com/LBeaudoux/tatoebatools/actions?query=workflow%3ACI)


`tatoebatools` helps you to integrate [Tatoeba](https://tatoeba.org) into your app more quickly by allowing you to easily download and parse [Tatoeba weekly exports](https://downloads.tatoeba.org/exports/).
**tatoebatools** helps you to integrate [Tatoeba](https://tatoeba.org) into your app more quickly by allowing you to easily download and parse [Tatoeba weekly exports](https://downloads.tatoeba.org/exports/).

## Installation

Expand Down Expand Up @@ -35,7 +35,7 @@ The Tatoeba data files are handled by the `tatoeba` object.
from tatoebatools import tatoeba
```

By default, the fetched Tatoeba data files are stored inside the `tatoebatools` package. But you can download them to another location.
By default, the fetched Tatoeba data files are stored inside the **tatoebatools** package. But you can download them to another location.

```python
tatoeba.dir = "/path/to/my/tatoeba/dir"
Expand Down Expand Up @@ -96,7 +96,7 @@ native_french = [x.username for x in tatoeba.user_languages("fra") if x.skill_le

### Extracting Tatoeba data as dataframe

Since `tatoebatools` relies heavily on the [pandas](https://github.com/pandas-dev/pandas) library, it is possible to load any supported table into memory as a dataframe.
Since **tatoebatools** relies heavily on the [pandas](https://github.com/pandas-dev/pandas) library, it is possible to load any supported table into memory as a dataframe.

```python
# get the dataframe of the English sentences table
Expand All @@ -108,7 +108,7 @@ french_links_dataframe = tatoeba.get("links", ["fra", "*"])

### Ingesting Tatoeba data into a database

The `tatoebatools` library includes [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) models that help you to ingest Tatoeba data in the database of you choice.
The **tatoebatools** library includes [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy) models that help you to ingest Tatoeba data in the database of you choice.

In the example below, all sentence and user data is loaded into a local SQLite database, and then an index is added to speed up database queries.

Expand Down

0 comments on commit 55000d0

Please sign in to comment.