| Name | mkdocs-sqlite-console JSON |
| Version |
2.1.1
JSON |
| download |
| home_page | None |
| Summary | Mkdocs-SQLite-Console est un plugin pour MkDocs, qui permet d'afficher un IDE SQL (SQLite) permettant d'exécuter du code. |
| upload_time | 2025-10-29 11:31:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
mkdocs
sql
sqlite
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-sqlite-console
Mkdocs-SQLite-Console est un plugin pour MkDocs, qui permet d'afficher un IDE SQL (SQLite) permettant d'exécuter du code.
Le public visé est essentiellement les enseignants et étudiants : les premiers pourront ainsi placer du code que les
seconds pourront exécuter et ainsi voir le résultat de leur requête.
## Installation
Installer le plugin avec pip :
`python3 -m pip install mkdocs-sqlite-console`
Pour accéder à la documentation :
```shell
git clone git+https://github.com/Epithumia/mkdocs-sqlite-console.git
cd mkdocs-sqlite-console
python3 -m pip install .[docs]
mkdocs build
```
Puis dans le dossier `docs`, activer le plugin dans votre fichier `mkdocs.yml`:
```yaml
plugins:
- search
- sqlite-console
```
> **Note:** Si vous n'avez aucune entrée dans la section `plugins` de votre fichier de configuration,
> vous voudrez sans doute ajouter le plugin `search`. MkDocs l'active par défaut s'il n'y a pas
> d'autres `plugins`, et dans le cas contraire, MkDocs demande de l'activer explicitement.
Plus d'informations sur les plugins se trouvent dans la [documentation MkDocs][mkdocs-plugins].
## Usage
Voir la section [Guide d'utilisation](https://epithumia.github.io/mkdocs-sqlite-console/usage/)
## Licence
Voir [LICENCE](LICENSE)
## Voir aussi
Plus d'informations sur les templates [here][mkdocs-template].
Plus d'informations sur les blocs [here][mkdocs-block].
[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-sqlite-console",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mkdocs, sql, sqlite",
"author": null,
"author_email": "Rafael Lopez <rafael.lopez@universite-paris-saclay.fr>, Fr\u00e9d\u00e9ric Zinelli <frederic.zinelli@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/29/e067c6193c5e333f5d99d5fabf0b721d7966c470a606d9b73bf0fe9df579/mkdocs_sqlite_console-2.1.1.tar.gz",
"platform": null,
"description": "# mkdocs-sqlite-console\n\nMkdocs-SQLite-Console est un plugin pour MkDocs, qui permet d'afficher un IDE SQL (SQLite) permettant d'ex\u00e9cuter du code.\nLe public vis\u00e9 est essentiellement les enseignants et \u00e9tudiants : les premiers pourront ainsi placer du code que les\nseconds pourront ex\u00e9cuter et ainsi voir le r\u00e9sultat de leur requ\u00eate.\n\n## Installation\n\nInstaller le plugin avec pip :\n\n`python3 -m pip install mkdocs-sqlite-console`\n\nPour acc\u00e9der \u00e0 la documentation :\n\n```shell\ngit clone git+https://github.com/Epithumia/mkdocs-sqlite-console.git\ncd mkdocs-sqlite-console\npython3 -m pip install .[docs]\nmkdocs build\n```\n\nPuis dans le dossier `docs`, activer le plugin dans votre fichier `mkdocs.yml`:\n\n```yaml\nplugins:\n - search\n - sqlite-console\n```\n\n> **Note:** Si vous n'avez aucune entr\u00e9e dans la section `plugins` de votre fichier de configuration,\n> vous voudrez sans doute ajouter le plugin `search`. MkDocs l'active par d\u00e9faut s'il n'y a pas\n> d'autres `plugins`, et dans le cas contraire, MkDocs demande de l'activer explicitement.\n\nPlus d'informations sur les plugins se trouvent dans la [documentation MkDocs][mkdocs-plugins].\n\n## Usage\n\nVoir la section [Guide d'utilisation](https://epithumia.github.io/mkdocs-sqlite-console/usage/)\n\n## Licence\n\nVoir [LICENCE](LICENSE)\n\n## Voir aussi\n\nPlus d'informations sur les templates [here][mkdocs-template].\n\nPlus d'informations sur les blocs [here][mkdocs-block].\n\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\n[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables\n[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mkdocs-SQLite-Console est un plugin pour MkDocs, qui permet d'afficher un IDE SQL (SQLite) permettant d'ex\u00e9cuter du code.",
"version": "2.1.1",
"project_urls": {
"documentation": "https://epithumia.github.io/mkdocs-sqlite-console/",
"source": "https://github.com/Epithumia/mkdocs-sqlite-console"
},
"split_keywords": [
"mkdocs",
" sql",
" sqlite"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "abc26ed705f326819bab7e2cd23329f576296b34a2fb3d9393e9b9a1c5045fc5",
"md5": "d20b8604ed7dc71f364902e2536ad780",
"sha256": "e1168cd692ef3c638f1dc23f5a32563b3b44a32e98fb814556ec88aa561a8ec4"
},
"downloads": -1,
"filename": "mkdocs_sqlite_console-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d20b8604ed7dc71f364902e2536ad780",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 353408,
"upload_time": "2025-10-29T11:31:06",
"upload_time_iso_8601": "2025-10-29T11:31:06.013728Z",
"url": "https://files.pythonhosted.org/packages/ab/c2/6ed705f326819bab7e2cd23329f576296b34a2fb3d9393e9b9a1c5045fc5/mkdocs_sqlite_console-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c29e067c6193c5e333f5d99d5fabf0b721d7966c470a606d9b73bf0fe9df579",
"md5": "6262011060579a073e14315cfb7836fe",
"sha256": "e7e9f5a57f717daffbe6ee424401e56a28f3936be83c72ada3eb0b43ecc0343b"
},
"downloads": -1,
"filename": "mkdocs_sqlite_console-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "6262011060579a073e14315cfb7836fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 390260,
"upload_time": "2025-10-29T11:31:07",
"upload_time_iso_8601": "2025-10-29T11:31:07.691547Z",
"url": "https://files.pythonhosted.org/packages/7c/29/e067c6193c5e333f5d99d5fabf0b721d7966c470a606d9b73bf0fe9df579/mkdocs_sqlite_console-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-29 11:31:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Epithumia",
"github_project": "mkdocs-sqlite-console",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-sqlite-console"
}
