| Name | voici-core JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | Voici turns Jupyter notebooks into static web applications |
| upload_time | 2024-04-23 07:58:01 |
| maintainer | None |
| docs_url | None |
| author | Voila Development Team |
| requires_python | >=3.8 |
| license | BSD License Copyright (c) 2018-2024 Voilà contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: a. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. b. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. c. Neither the name of the authors nor the names of the contributors to this package may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
emscripten
jupyter
jupyterlite
voici
voila
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 
[](https://voici.readthedocs.io/en/latest/_static/lite)
[](https://voici.readthedocs.io/en/latest/?badge=latest)
The `voici-core` package provides the core functionality for building voici dashboards using the voici CLI.
## Getting Started 🏁
To use Voici, you'll need to install it first:
```bash
pip install voici-core
# OR BETTER
conda install -c conda-forge voici-core
# OR EVEN FASTER
mamba install -c conda-forge voici-core
```
Then, you can generate static dashboards from a notebook or a directory of Notebooks like this:
```bash
# Build a single dashboard
voici my-notebook.ipynb
# Build a directory of notebooks
voici notebooks/
```
Once your dashboards are built, you can simply serve them with a simple static server, _e.g._:
```bash
cd _output
python -m http.server
```
## Limitations ⚠️
Because Voici uses Wasm kernels to execute notebooks, there are some limitations to the types of notebooks that can be rendered: Some notebook features may not work correctly or may have limited functionality when rendered in Voici.
## Contributing 👋
If you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/voila-dashboards/voici). If you'd like to contribute code, please fork the repository and submit a pull request. We welcome contributions from anyone!
Raw data
{
"_id": null,
"home_page": null,
"name": "voici-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Emscripten, Jupyter, JupyterLite, Voici, Voila",
"author": "Voila Development Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2e/a6/7a4812c198fd9a1fda11a81d412004c1e9ce6c36569a7bb190aa12e8afba/voici_core-0.6.1.tar.gz",
"platform": null,
"description": "# \n\n\n[](https://voici.readthedocs.io/en/latest/_static/lite)\n[](https://voici.readthedocs.io/en/latest/?badge=latest)\n\nThe `voici-core` package provides the core functionality for building voici dashboards using the voici CLI.\n\n## Getting Started \ud83c\udfc1\n\nTo use Voici, you'll need to install it first:\n\n```bash\npip install voici-core\n\n# OR BETTER\n\nconda install -c conda-forge voici-core\n\n# OR EVEN FASTER\n\nmamba install -c conda-forge voici-core\n```\n\nThen, you can generate static dashboards from a notebook or a directory of Notebooks like this:\n\n```bash\n# Build a single dashboard\nvoici my-notebook.ipynb\n# Build a directory of notebooks\nvoici notebooks/\n```\n\nOnce your dashboards are built, you can simply serve them with a simple static server, _e.g._:\n\n```bash\ncd _output\npython -m http.server\n```\n\n## Limitations \u26a0\ufe0f\n\nBecause Voici uses Wasm kernels to execute notebooks, there are some limitations to the types of notebooks that can be rendered: Some notebook features may not work correctly or may have limited functionality when rendered in Voici.\n\n## Contributing \ud83d\udc4b\n\nIf you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/voila-dashboards/voici). If you'd like to contribute code, please fork the repository and submit a pull request. We welcome contributions from anyone!\n",
"bugtrack_url": null,
"license": "BSD License Copyright (c) 2018-2024 Voil\u00e0 contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: a. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. b. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. c. Neither the name of the authors nor the names of the contributors to this package may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Voici turns Jupyter notebooks into static web applications",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://github.com/voila-dashboards/voici"
},
"split_keywords": [
"emscripten",
" jupyter",
" jupyterlite",
" voici",
" voila"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d98c1f30a4adbb419f3b8a21b757226fce18886dd3bc0a2b428769177000402",
"md5": "8fbed04ccf6c8f2d19a5d878ab474aec",
"sha256": "74156f5ccbba02e55934b2ce62093df21dc6b16ddfe3a933c9e9953149f01809"
},
"downloads": -1,
"filename": "voici_core-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fbed04ccf6c8f2d19a5d878ab474aec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2575809,
"upload_time": "2024-04-23T07:57:58",
"upload_time_iso_8601": "2024-04-23T07:57:58.680274Z",
"url": "https://files.pythonhosted.org/packages/3d/98/c1f30a4adbb419f3b8a21b757226fce18886dd3bc0a2b428769177000402/voici_core-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ea67a4812c198fd9a1fda11a81d412004c1e9ce6c36569a7bb190aa12e8afba",
"md5": "974a4d592a7aeb0fe3cb324831fb549d",
"sha256": "8632a219a0a1e7637f1a250094b0ec82e06816a0402a532736907aca8333836a"
},
"downloads": -1,
"filename": "voici_core-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "974a4d592a7aeb0fe3cb324831fb549d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2715236,
"upload_time": "2024-04-23T07:58:01",
"upload_time_iso_8601": "2024-04-23T07:58:01.668715Z",
"url": "https://files.pythonhosted.org/packages/2e/a6/7a4812c198fd9a1fda11a81d412004c1e9ce6c36569a7bb190aa12e8afba/voici_core-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 07:58:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "voila-dashboards",
"github_project": "voici",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "voici-core"
}
