| Name | voila-materialscloud-template JSON |
| Version |
0.4.3
JSON |
| download |
| home_page | None |
| Summary | Voilà template for Materials Cloud. |
| upload_time | 2024-05-28 16:26:49 |
| maintainer | None |
| docs_url | None |
| author | The Materials Cloud team |
| requires_python | >=3.8 |
| license | BSD License Copyright (c) 2018 Voila 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 |
jupyter
materialscloud
voila
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Voilà template for Materials Cloud
[](https://pypi.org/project/voila-materialscloud-template/)
[](https://mybinder.org/v2/gh/materialscloud-org/voila-materialscloud-template/main?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fexample.ipynb)
This is the Voilà template for Materials Cloud, implements the standard header and CSS.
Three templates are provided:
- `materialscloud-tool` - highlights the [WORK](https://www.materialscloud.org/work)/Tools section in the header/breadcrumbs.
- `materialscloud-discover` - highlights the [DISCOVER](https://www.materialscloud.org/discover) section in the header/breadcrumbs.
- `materialscloud-iframe` - just adds a simple "Hosted on Materials Cloud" note at the bottom.
## Installation
```bash
pip install voila-materialscloud-template
```
This installs the templates in the correct Jupyter path (using `copy_voila_template.py`).
## Usage
The main way is to use the `voila --template` option, e.g.:
```bash
voila --template=materialscloud-tool example.ipynb
```
Alternatively, you can write a `voila.json` file containing
```json
{
"VoilaConfiguration": {
"template": "materialscloud-tool"
},
...
}
```
and passing its path with
```bash
voila --Voila.config_file_paths=<...> example.ipynb
```
There are also other options, see [the Voilà documentation](https://voila.readthedocs.io/en/stable/customize.html#controlling-the-nbconvert-template) for more information.
## Development
Option 1:
```bash
pip install -e .[dev]
```
Note: this will copy the templates to the jupyter folder, and they need to be modified directly there or re-copied for changes to take effect.
Option 2:
It's more convenient to use a docker container and rebuild after modification:
```bash
cd docker
docker compose up --build
```
and access via `http://localhost:8866/`. The template and other voila configuration is specified in `voila.json`.
Note: maybe there is an easier setup, e.g. with live-reload or similar.
### Making a new release
To release a new version, just make a new release on Github with the correct version tag, without updating any versions manually. This will start the GitHub action that will
- update version numbers in the repo and commits it;
- tags this new commit with the version, overwriting the tag that was made by the Github release;
- pushes commit & tag to Github;
- publishes new version on PYPI.
## License
This repository and all files in it are licensed under the [BSD license](LICENSE), copyright (c) by Voilà contributors.
Raw data
{
"_id": null,
"home_page": null,
"name": "voila-materialscloud-template",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, materialscloud, voila",
"author": "The Materials Cloud team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/99/0c/33f0b3f82e8b50db7218e2a1b8865542481af2f0be6c7febd42aceaca835/voila_materialscloud_template-0.4.3.tar.gz",
"platform": null,
"description": "# Voil\u00e0 template for Materials Cloud\n\n[](https://pypi.org/project/voila-materialscloud-template/)\n[](https://mybinder.org/v2/gh/materialscloud-org/voila-materialscloud-template/main?urlpath=%2Fvoila%2Frender%2Fexample-notebooks%2Fexample.ipynb)\n\nThis is the Voil\u00e0 template for Materials Cloud, implements the standard header and CSS.\n\nThree templates are provided:\n\n- `materialscloud-tool` - highlights the [WORK](https://www.materialscloud.org/work)/Tools section in the header/breadcrumbs.\n- `materialscloud-discover` - highlights the [DISCOVER](https://www.materialscloud.org/discover) section in the header/breadcrumbs.\n- `materialscloud-iframe` - just adds a simple \"Hosted on Materials Cloud\" note at the bottom.\n\n## Installation\n\n```bash\npip install voila-materialscloud-template\n```\n\nThis installs the templates in the correct Jupyter path (using `copy_voila_template.py`).\n\n## Usage\n\nThe main way is to use the `voila --template` option, e.g.:\n\n```bash\nvoila --template=materialscloud-tool example.ipynb\n```\n\nAlternatively, you can write a `voila.json` file containing\n\n```json\n{\n \"VoilaConfiguration\": {\n \"template\": \"materialscloud-tool\"\n },\n ...\n}\n```\n\nand passing its path with\n\n```bash\nvoila --Voila.config_file_paths=<...> example.ipynb\n```\n\nThere are also other options, see [the Voil\u00e0 documentation](https://voila.readthedocs.io/en/stable/customize.html#controlling-the-nbconvert-template) for more information.\n\n## Development\n\nOption 1:\n\n```bash\npip install -e .[dev]\n```\n\nNote: this will copy the templates to the jupyter folder, and they need to be modified directly there or re-copied for changes to take effect.\n\nOption 2:\n\nIt's more convenient to use a docker container and rebuild after modification:\n\n```bash\ncd docker\ndocker compose up --build\n```\n\nand access via `http://localhost:8866/`. The template and other voila configuration is specified in `voila.json`.\n\nNote: maybe there is an easier setup, e.g. with live-reload or similar.\n\n### Making a new release\n\nTo release a new version, just make a new release on Github with the correct version tag, without updating any versions manually. This will start the GitHub action that will\n\n- update version numbers in the repo and commits it;\n- tags this new commit with the version, overwriting the tag that was made by the Github release;\n- pushes commit & tag to Github;\n- publishes new version on PYPI.\n\n## License\n\nThis repository and all files in it are licensed under the [BSD license](LICENSE), copyright (c) by Voil\u00e0 contributors.\n",
"bugtrack_url": null,
"license": "BSD License Copyright (c) 2018 Voila 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": "Voil\u00e0 template for Materials Cloud.",
"version": "0.4.3",
"project_urls": {
"Source": "https://github.com/materialscloud-org/voila-materialscloud-template"
},
"split_keywords": [
"jupyter",
" materialscloud",
" voila"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "990c33f0b3f82e8b50db7218e2a1b8865542481af2f0be6c7febd42aceaca835",
"md5": "1273690571cc0dec044b77218862273e",
"sha256": "bc1b4ed7705096822e49db587dc56594534506730bd80d3080576f81e8346917"
},
"downloads": -1,
"filename": "voila_materialscloud_template-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "1273690571cc0dec044b77218862273e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 445568,
"upload_time": "2024-05-28T16:26:49",
"upload_time_iso_8601": "2024-05-28T16:26:49.221614Z",
"url": "https://files.pythonhosted.org/packages/99/0c/33f0b3f82e8b50db7218e2a1b8865542481af2f0be6c7febd42aceaca835/voila_materialscloud_template-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 16:26:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "materialscloud-org",
"github_project": "voila-materialscloud-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "voila-materialscloud-template"
}
