| Name | motheme JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Marimo Theming Management |
| upload_time | 2024-12-03 06:16:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
marimo
theme
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Marimo Custom Themes
> personalize your experience with
> [marimo](https://github.com/marimo-team/marimo)
## Theme Gallery
### <a href="themes/coldme/">coldme</a>
<div style="display: flex; justify-content: space-around; margin-bottom: 20px;">
<img src="themes/coldme/coldme_light.png" alt="coldme light" width="400" "/>
<img src="themes/coldme/coldme_dark.png" alt="coldme dark" width="400"/>
</div>
### <a href="themes/nord/">nord</a>
<div style="display: flex; justify-content: space-around; margin-bottom: 20px;">
<img src="themes/nord/nord_light.png" alt="nord light" width="400" "/>
<img src="themes/nord/nord_dark.png" alt="nord dark" width="400"/>
</div>
### <a href="themes/mininini/">mininini</a>
<div style="display: flex; justify-content: space-around; margin-bottom: 20px;">
<img src="themes/mininini/mininini_light.png" alt="mininini light" width="400" "/>
<img src="themes/mininini/mininini_dark.png" alt="mininini dark" width="400"/>
</div>
### <a href="themes/wigwam/">wigwam</a>
<div style="display: flex; justify-content: space-around; margin-bottom: 20px;">
<img src="themes/wigwam/wigwam_light.png" alt="wigwam light" width="400" "/>
<img src="themes/wigwam/wigwam_dark.png" alt="wigwam dark" width="400"/>
</div>
## Get Started
```bash
# Install motheme CLI tool
pip install motheme
# Help messages
motheme
# Initialize themes
motheme update
# List available themes
motheme themes
# Apply a theme to specific files
motheme apply coldme notebook1.py notebook2.py
# Or, apply theme recursively in a directory
motheme apply -r coldme ./
```
> [!NOTE]
>
> Please note that some parts of the Marimo notebook are not fully exposed for
> customization at this time. This includes side panels and cell editors
> [!WARNING]
>
> You may want to run `motheme clear -r ./` before sharing or uploading your
> notebooks because the field `css_file` in `marimo.App()` may leak your
> private data.
You can also add `motheme` as a uv tool
```bash
# install motheme as a uv tool
uv tool install motheme
# use motheme
uvx motheme <command>
```
## Usage
- **Requirements**: Ensure you are using Marimo version **0.9.14** or higher.
It is recommended to keep your Marimo version up-to-date for the best
experience.
- **Light and Dark Mode Support**: All themes support both light and dark
modes and will switch automatically based on your notebook's current theme
settings.
## Contributing
To contribute your own themes, please follow these guidelines:
- **Refer to Default Arguments**: All available arguments are listed in
[`default.css`](themes/default/default.css), which serves as a reference
for writing your themes. You can experiment with other arguments, but
please note that stability cannot be guaranteed with untested changes.
- **Light and Dark Themes**: Implement both light and dark themes using the
light-dark syntax as demonstrated in `default.css`. If you choose not to
implement a theme for a specific mode, name your theme as `xxx_light` or
`xxx_dark` and use the default values for the respective mode from
`default.css`.
- **Folder Structure**: After finishing your CSS file, create a new folder
inside `themes` with the name of your theme. Within this folder, upload the
following:
- The CSS file
- Preview images
- An optional `README.md` file to illustrate your design
- **Design Using Sample**: You can design your theme using the
[`sample.py`](sample.py) file provided in the repository. This file helps
visualize how your theme will look in the Marimo notebook.
Raw data
{
"_id": null,
"home_page": null,
"name": "motheme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "marimo, theme",
"author": null,
"author_email": "eugene <heinereugene@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/ce/79/304f50fcb1fde8fcd511bac1c3cba3d72929263e1e4a6cc8c9c3ff8f0ea0/motheme-0.1.5.tar.gz",
"platform": null,
"description": "# Marimo Custom Themes\n\n> personalize your experience with\n> [marimo](https://github.com/marimo-team/marimo)\n\n## Theme Gallery\n\n### <a href=\"themes/coldme/\">coldme</a>\n\n<div style=\"display: flex; justify-content: space-around; margin-bottom: 20px;\">\n <img src=\"themes/coldme/coldme_light.png\" alt=\"coldme light\" width=\"400\" \"/>\n <img src=\"themes/coldme/coldme_dark.png\" alt=\"coldme dark\" width=\"400\"/>\n</div>\n\n### <a href=\"themes/nord/\">nord</a>\n\n<div style=\"display: flex; justify-content: space-around; margin-bottom: 20px;\">\n <img src=\"themes/nord/nord_light.png\" alt=\"nord light\" width=\"400\" \"/>\n <img src=\"themes/nord/nord_dark.png\" alt=\"nord dark\" width=\"400\"/>\n</div>\n\n### <a href=\"themes/mininini/\">mininini</a>\n\n<div style=\"display: flex; justify-content: space-around; margin-bottom: 20px;\">\n <img src=\"themes/mininini/mininini_light.png\" alt=\"mininini light\" width=\"400\" \"/>\n <img src=\"themes/mininini/mininini_dark.png\" alt=\"mininini dark\" width=\"400\"/>\n</div>\n\n### <a href=\"themes/wigwam/\">wigwam</a>\n\n<div style=\"display: flex; justify-content: space-around; margin-bottom: 20px;\">\n <img src=\"themes/wigwam/wigwam_light.png\" alt=\"wigwam light\" width=\"400\" \"/>\n <img src=\"themes/wigwam/wigwam_dark.png\" alt=\"wigwam dark\" width=\"400\"/>\n</div>\n\n## Get Started\n\n```bash\n# Install motheme CLI tool\npip install motheme\n\n# Help messages\nmotheme\n\n# Initialize themes\nmotheme update\n\n# List available themes\nmotheme themes\n\n# Apply a theme to specific files\nmotheme apply coldme notebook1.py notebook2.py\n\n# Or, apply theme recursively in a directory\nmotheme apply -r coldme ./\n```\n\n> [!NOTE]\n>\n> Please note that some parts of the Marimo notebook are not fully exposed for\n> customization at this time. This includes side panels and cell editors\n\n> [!WARNING]\n>\n> You may want to run `motheme clear -r ./` before sharing or uploading your\n> notebooks because the field `css_file` in `marimo.App()` may leak your\n> private data.\n\nYou can also add `motheme` as a uv tool\n\n```bash\n# install motheme as a uv tool\nuv tool install motheme\n\n# use motheme\nuvx motheme <command>\n```\n\n## Usage\n\n- **Requirements**: Ensure you are using Marimo version **0.9.14** or higher.\n It is recommended to keep your Marimo version up-to-date for the best\n experience.\n\n- **Light and Dark Mode Support**: All themes support both light and dark\n modes and will switch automatically based on your notebook's current theme\n settings.\n\n## Contributing\n\nTo contribute your own themes, please follow these guidelines:\n\n- **Refer to Default Arguments**: All available arguments are listed in\n [`default.css`](themes/default/default.css), which serves as a reference\n for writing your themes. You can experiment with other arguments, but\n please note that stability cannot be guaranteed with untested changes.\n\n- **Light and Dark Themes**: Implement both light and dark themes using the\n light-dark syntax as demonstrated in `default.css`. If you choose not to\n implement a theme for a specific mode, name your theme as `xxx_light` or\n `xxx_dark` and use the default values for the respective mode from\n `default.css`.\n\n- **Folder Structure**: After finishing your CSS file, create a new folder\n inside `themes` with the name of your theme. Within this folder, upload the\n following:\n\n - The CSS file\n - Preview images\n - An optional `README.md` file to illustrate your design\n\n- **Design Using Sample**: You can design your theme using the\n [`sample.py`](sample.py) file provided in the repository. This file helps\n visualize how your theme will look in the Marimo notebook.\n",
"bugtrack_url": null,
"license": null,
"summary": "Marimo Theming Management",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/metaboulie/marimo-themes",
"Repository": "https://github.com/metaboulie/marimo-themes"
},
"split_keywords": [
"marimo",
" theme"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9f63bc821cae7850a7a1bc0d268081d736dab119f493697512eb62e8b70fcf50",
"md5": "70eb6f21fd0f389c231cd9782b6aad4a",
"sha256": "e5684c81a11cedd28c7185e0a80d529621630595082b21493028b9d4ce4b45e0"
},
"downloads": -1,
"filename": "motheme-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70eb6f21fd0f389c231cd9782b6aad4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16080,
"upload_time": "2024-12-03T06:16:10",
"upload_time_iso_8601": "2024-12-03T06:16:10.775864Z",
"url": "https://files.pythonhosted.org/packages/9f/63/bc821cae7850a7a1bc0d268081d736dab119f493697512eb62e8b70fcf50/motheme-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ce79304f50fcb1fde8fcd511bac1c3cba3d72929263e1e4a6cc8c9c3ff8f0ea0",
"md5": "43d210cf005b7cb2764623cae34fe248",
"sha256": "31bb36460e99dde0392c6b4806955b64813db7317cfae7bd942f6e59bf9db7d6"
},
"downloads": -1,
"filename": "motheme-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "43d210cf005b7cb2764623cae34fe248",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1576964,
"upload_time": "2024-12-03T06:16:15",
"upload_time_iso_8601": "2024-12-03T06:16:15.335232Z",
"url": "https://files.pythonhosted.org/packages/ce/79/304f50fcb1fde8fcd511bac1c3cba3d72929263e1e4a6cc8c9c3ff8f0ea0/motheme-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 06:16:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "metaboulie",
"github_project": "marimo-themes",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "motheme"
}
