Skip to content

Commit 6e47abc

Browse files
committed
fix(docs): Update Web API dependency information in documentation and translations
1 parent e0befc7 commit 6e47abc

4 files changed

Lines changed: 19 additions & 29 deletions

File tree

doc/features/advanced/webapi.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ especially for Jupyter notebooks and web-based tools.
1313

1414
.. note::
1515

16-
The Web API is available starting from DataLab 1.1. It requires additional
17-
dependencies that can be installed with: ``pip install datalab-platform[webapi]``
16+
The Web API is available starting from DataLab 1.1. The required dependencies
17+
(FastAPI, Uvicorn, Pydantic) are included in the standard DataLab installation.
1818

1919
Overview
2020
--------
@@ -62,7 +62,7 @@ Enabling the Web API
6262

6363
There are several ways to enable the Web API server:
6464

65-
1. **Via UI**: View → Web API → Start Web API Server
65+
1. **Via UI**: File → Web API → Start Web API Server
6666
2. **Via environment variable**: Set ``DATALAB_WEBAPI_ENABLED=1`` before starting DataLab
6767

6868
When started, DataLab displays the server URL and authentication token in a dialog.
@@ -307,18 +307,14 @@ thread using Qt's signal/slot mechanism.
307307
Installation
308308
------------
309309

310-
The Web API requires additional dependencies:
311-
312-
.. code-block:: bash
313-
314-
pip install datalab-platform[webapi]
315-
316-
This installs:
310+
The Web API dependencies are included in the standard DataLab installation:
317311

318312
- FastAPI (web framework)
319313
- Uvicorn (ASGI server)
320314
- Pydantic (data validation)
321315

316+
No additional installation steps are required.
317+
322318
Programmatic Control
323319
--------------------
324320

doc/locale/fr/LC_MESSAGES/features/advanced/webapi.po

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ msgstr "API Web"
2929
msgid "The DataLab Web API provides a modern **HTTP/JSON interface** for external access to the DataLab workspace. It is the recommended integration path for new projects, especially for Jupyter notebooks and web-based tools."
3030
msgstr "L'API Web DataLab fournit une interface moderne **HTTP/JSON** pour un accès externe à l'espace de travail DataLab. C'est la voie d'intégration recommandée pour les nouveaux projets, en particulier pour les notebooks Jupyter et les outils basés sur le web."
3131

32-
msgid "The Web API is available starting from DataLab 1.1. It requires additional dependencies that can be installed with: ``pip install datalab-platform[webapi]``"
33-
msgstr "L'API Web est disponible à partir de DataLab 1.1. Elle nécessite des dépendances supplémentaires qui peuvent être installées avec : ``pip install datalab-platform[webapi]``"
32+
msgid "The Web API is available starting from DataLab 1.1. The required dependencies (FastAPI, Uvicorn, Pydantic) are included in the standard DataLab installation."
33+
msgstr "L'API Web est disponible à partir de DataLab 1.1. Les dépendances requises (FastAPI, Uvicorn, Pydantic) sont incluses dans l'installation standard de DataLab."
3434

3535
msgid "Overview"
3636
msgstr "Aperçu"
@@ -122,8 +122,8 @@ msgstr "Activer l'API Web"
122122
msgid "There are several ways to enable the Web API server:"
123123
msgstr "Il existe plusieurs façons d'activer le serveur API Web :"
124124

125-
msgid "**Via UI**: View → Web API → Start Web API Server"
126-
msgstr "**Via l'interface** : Affichage → API Web → Démarrer le serveur API Web"
125+
msgid "**Via UI**: File → Web API → Start Web API Server"
126+
msgstr "**Via l'interface** : Fichier → API Web → Démarrer le serveur API Web"
127127

128128
msgid "**Via environment variable**: Set ``DATALAB_WEBAPI_ENABLED=1`` before starting DataLab"
129129
msgstr "**Via variable d'environnement** : Définir ``DATALAB_WEBAPI_ENABLED=1`` avant de démarrer DataLab"
@@ -341,11 +341,8 @@ msgstr "L'API Web s'exécute dans un thread séparé de l'interface Qt. Le ``Wor
341341
msgid "Installation"
342342
msgstr "Installation"
343343

344-
msgid "The Web API requires additional dependencies:"
345-
msgstr "L'API Web nécessite des dépendances supplémentaires :"
346-
347-
msgid "This installs:"
348-
msgstr "Ceci installe :"
344+
msgid "The Web API dependencies are included in the standard DataLab installation:"
345+
msgstr "Les dépendances de l'API Web sont incluses dans l'installation standard de DataLab :"
349346

350347
msgid "FastAPI (web framework)"
351348
msgstr "FastAPI (framework web)"
@@ -356,6 +353,9 @@ msgstr "Uvicorn (serveur ASGI)"
356353
msgid "Pydantic (data validation)"
357354
msgstr "Pydantic (validation de données)"
358355

356+
msgid "No additional installation steps are required."
357+
msgstr "Aucune étape d'installation supplémentaire n'est nécessaire."
358+
359359
msgid "Programmatic Control"
360360
msgstr "Contrôle programmatique"
361361

doc/locale/fr/LC_MESSAGES/release_notes/release_1.01.po

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,6 @@ msgstr "**Découverte automatique** : DataLab-Kernel trouve et se connecte autom
6868
msgid "**Security**: Localhost binding by default, with optional localhost token bypass for simplified local development"
6969
msgstr "**Sécurité** : Liaison localhost par défaut, avec contournement optionnel du jeton localhost pour simplifier le développement local"
7070

71-
msgid "**Requires additional dependencies**: Install with `pip install datalab-platform[webapi]`"
72-
msgstr "**Nécessite des dépendances supplémentaires** : Installer avec `pip install datalab-platform[webapi]`"
73-
74-
msgid "See :ref:`ref-to-webapi` for complete documentation."
75-
msgstr "Voir :ref:`ref-to-webapi` pour la documentation complète."
76-
7771
msgid "**PyQt6 compatibility:**"
7872
msgstr "**Compatibilité PyQt6 :**"
7973

@@ -134,5 +128,6 @@ msgstr "**Dépendances :**"
134128
msgid "Updated Sigima dependency to version 1.1.0 which includes new features and bug fixes"
135129
msgstr "Mise à jour de la dépendance Sigima vers la version 1.1.0 qui inclut de nouvelles fonctionnalités et corrections de bugs"
136130

137-
msgid "Added optional Web API dependencies: FastAPI, Uvicorn, and Pydantic (install with `pip install datalab-platform[webapi]`)"
138-
msgstr "Ajout des dépendances optionnelles pour l'API Web : FastAPI, Uvicorn et Pydantic (installer avec `pip install datalab-platform[webapi]`)"
131+
msgid "Added Web API dependencies: FastAPI, Uvicorn, and Pydantic (included in standard installation)"
132+
msgstr "Ajout des dépendances pour l'API Web : FastAPI, Uvicorn et Pydantic (incluses dans l'installation standard)"
133+

doc/release_notes/release_1.01.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ DataLab now provides a modern **HTTP/JSON Web API** as an alternative to the exi
2020
* Computation API for running processing operations remotely
2121
* **Auto-discovery**: DataLab-Kernel automatically finds and connects to a running DataLab instance without manual configuration
2222
* **Security**: Localhost binding by default, with optional localhost token bypass for simplified local development
23-
* **Requires additional dependencies**: Install with `pip install datalab-platform[webapi]`
2423

2524
**PyQt6 compatibility:**
2625

@@ -49,4 +48,4 @@ DataLab now provides a modern **HTTP/JSON Web API** as an alternative to the exi
4948
**Dependencies:**
5049

5150
* Updated Sigima dependency to version 1.1.0 which includes new features and bug fixes
52-
* Added optional Web API dependencies: FastAPI, Uvicorn, and Pydantic (install with `pip install datalab-platform[webapi]`)
51+
* Added Web API dependencies: FastAPI, Uvicorn, and Pydantic (included in standard installation)

0 commit comments

Comments
 (0)