diff --git a/README.md b/README.md index c77c313..a24d434 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ### Prerequisites: -1. Python (≥ `3.10`) installed on your system. +1. Python 3.12.3 installed on your system. 2. Ensure you have `poetry` installed. If not, you can install them using `pip`. ```bash @@ -67,12 +67,12 @@ pip install poetry This code base uses a `.env` file at the root directory of the code base. -| Variable | Description | Default Value | -| --- | --- | --- | -| HF_TOKEN | Hugging Face API Token. You must have write access to the datasets. | N/A | -| TMDB_API_KEY | TMDB API Token. | N/A | -| TMDB_BATCH_SIZE | Number of TMDB entries to download before updating a HF dataset. | 10000 | -| TMDB_MAX_RETRIES | Maximum number of times to retry a failed TMDB API call. | 500 | +| Variable | Description | Default Value | +| ---------------- | ------------------------------------------------------------------- | ------------- | +| HF_TOKEN | Hugging Face API Token. You must have write access to the datasets. | N/A | +| TMDB_API_KEY | TMDB API Token. | N/A | +| TMDB_BATCH_SIZE | Number of TMDB entries to download before updating a HF dataset. | 10000 | +| TMDB_MAX_RETRIES | Maximum number of times to retry a failed TMDB API call. | 500 | ## Website to select a specific movie or TV show @@ -146,4 +146,4 @@ python -m observatoire.tmdb.movies --mode=[latest | missing] python -m observatoire.tmdb.series --mode=[latest | missing] ``` -In the `latest` mode, which is the default, these commands sync the latest records from TMDB to our datasets on Hugging Face. In the `missing` mode, they calculate which rows may be missing from the Hugging Face datasets and attempt to sync these records. \ No newline at end of file +In the `latest` mode, which is the default, these commands sync the latest records from TMDB to our datasets on Hugging Face. In the `missing` mode, they calculate which rows may be missing from the Hugging Face datasets and attempt to sync these records.