doki-theme-jupyter


Namedoki-theme-jupyter JSON
Version 88.1.1.0.0 PyPI version JSON
download
home_pagehttps://github.com/doki-theme/doki-theme-jupyter
SummaryCrunch data with your waifu! Choose a Jupyter Notebook theme based on a girl from various anime series, manga, and visual novels.
upload_time2022-08-06 13:52:43
maintainer
docs_urlNone
authorUnthrottled
requires_python>=3.6, <4
license
keywords jupyter notebook theme
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            The Doki Theme: Jupyter Notebook
---

## Quick Theme Preview

![Themes](https://raw.githubusercontent.com/doki-theme/doki-theme-jupyter/main/readmeAssets/quick_theme_preview.webp)


# [More Screenshots](https://github.com/doki-theme/doki-theme-jupyter/blob/main/albums/screenshot_album.md)

**About** 

Cute themes based on cute anime characters. With over **60** themes, the one you like the best, is probably here.

You can choose themes based on characters from these various Anime, Manga, or Visual Novels:

<details>
  <summary>All Featured Titles</summary>

- AzurLane
- Blend S
- Charlotte
- Chuunibyou, Love, & Other Delusions
- Code Geass
- Daily Life with a Monster Girl
- DanganRonpa
- Doki-Doki Literature Club
- Don't Toy With Me, Miss Nagatoro
- Fate/Type-Moon
- Future Diary
- Gate
- Guilty Crown
- Haikyu!!
- High School DxD
- Jahy-sama Will Not Be Discouraged!
- Kakegurui
- Kill La Kill
- KonoSuba
- Love Live!
- Lucky Star
- Miss Kobayashi's Dragon Maid
- Monogatari
- NekoPara
- Neon Genesis Evangelion
- One Punch Man
- OreGairu
- Quintessential Quintuplets
- Re:Zero
- Rising of the Shield Hero
- Sewayaki Kitsune no Senko-san
- Shokugeki no Soma
- Steins Gate
- Sword Art Online
- That Time I Got Reincarnated as a Slime
- Toaru Majutsu no Index
- Yuru Camp

</details>

---

# Documentation

- [Installation](#installation)
    - [Requirements](#pre-requisites)  
    - [Package Install](#package-install)
- [Usage](#usage)
  - [CLI](#command-line-interface)
  - [Python API](#python-api)
    - [Decorator](#decorator)
- [Miscellaneous](#miscellaneous)
    - [Contributing](#contributing)  
    - [Theme Requests](#theme-requests)
    - [Helping the community](#enjoying-the-themes)
    - [Feature Requests](#contributions)

# Quick Start!

I've put together a [demo notebook](https://github.com/doki-theme/doki-theme-jupyter/blob/main/index.ipynb) that demonstrates the core functionality of the `doki-theme-jupyter` package.

# Installation 

### Pre-Requisites

For the optimal experience it's best you have:

- [Doki Theme Web](https://github.com/doki-theme/doki-theme-web)
- Jupyter Notebook >=6.0.0
- Python >=3.7
- pip 21.0 >= (Just having pip should suffice)

### Package Install

The Doki Theme for Jupyter Notebook provides a command line interface.
Which enables you decorate your notebook from your shell or notebook!

To install the package just run this command:

```shell
pip install pip doki-theme-jupyter
```

# Usage

The Doki Theme for Jupyter Notebook has a few components.
The following sections are dedicated to explaining theme in detail.

## Command Line Interface 

Now that you have `dokithemejupyter` available, here's what each of the options does!

**Help**

```shell
dokithemejupyter --help
```

This command will show you all the available features the CLI provides.
The rest of the sections below are dedicated to explaining each in detail.

**List**

```shell
dokithemejupyter --list
```

Wow! That's a bunch of themes! This command will output all the available themes to install.
**Important**, theme arguments are exact match and require the `"""`, don't forget to add those!


**Set Theme**

```shell
dokithemejupyter --set-theme "Franxx: Zero Two Dark Obsidian"
```

This is the most important command, which enables the decoration of your notebook with your waifu!
**Important**, theme arguments are exact match and require the `""`, don't forget to add those!

**Sticker**

```shell
dokithemejupyter --sticker --set-theme "Franxx: Zero Two Dark Obsidian"
```

This installs your selected theme with the cute sticker in the righthand corner.
Running a set theme command without the sticker parameter will remove the sticker.

```shell
dokithemejupyter --sticker
```

Will only install the sticker for the current theme.

**Remove**

```shell
dokithemejupyter --remove
```

Sad to see you go, I'll be seeing you around friend!
This command removes all the notebook decoration and restores the defaults.

**Version**

```shell
dokithemejupyter --version
```
You keep your packages up to date right?
Well you don't want to miss any updates, you might be missing some girls!

## Python API

Your otaku experience is not complete without a little extra decoration.

### Decorator

This is a python API that will color [matplotlib's](https://matplotlib.org/)
plotter to your currently selected theme. 
That way all of your data visualizations match your favorite girl.

```python
from dokithemejupyter import decorator
decorator.decorate_plotter()
```

You'll just need to have this code get run once before you do any plotting.

# Miscellaneous

## Contributing

If you want to get your workstation set up to work on the plugin,
then you'll want to check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on what is needed.

## Theme Requests

If you want your main squeeze to be featured in the Doki Theme suite, feel free to [submit a theme request](https://github.com/doki-theme/doki-master-theme/issues).

## Enjoying the themes?

Great! I am glad you like it!

Be sure to ⭐ and share it with other weebs!

## Contributions?

I think your voice needs to be heard! You probably have good ideas, so feel free to submit your feedback as [an issue](https://github.com/doki-theme/doki-theme-jupyter/issues/new).

Help make this plugin better!




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/doki-theme/doki-theme-jupyter",
    "name": "doki-theme-jupyter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6, <4",
    "maintainer_email": "",
    "keywords": "jupyter,notebook,theme",
    "author": "Unthrottled",
    "author_email": "alexsimons9999@gmail.com",
    "download_url": "",
    "platform": null,
    "description": "The Doki Theme: Jupyter Notebook\n---\n\n## Quick Theme Preview\n\n![Themes](https://raw.githubusercontent.com/doki-theme/doki-theme-jupyter/main/readmeAssets/quick_theme_preview.webp)\n\n\n# [More Screenshots](https://github.com/doki-theme/doki-theme-jupyter/blob/main/albums/screenshot_album.md)\n\n**About** \n\nCute themes based on cute anime characters. With over **60** themes, the one you like the best, is probably here.\n\nYou can choose themes based on characters from these various Anime, Manga, or Visual Novels:\n\n<details>\n  <summary>All Featured Titles</summary>\n\n- AzurLane\n- Blend S\n- Charlotte\n- Chuunibyou, Love, & Other Delusions\n- Code Geass\n- Daily Life with a Monster Girl\n- DanganRonpa\n- Doki-Doki Literature Club\n- Don't Toy With Me, Miss Nagatoro\n- Fate/Type-Moon\n- Future Diary\n- Gate\n- Guilty Crown\n- Haikyu!!\n- High School DxD\n- Jahy-sama Will Not Be Discouraged!\n- Kakegurui\n- Kill La Kill\n- KonoSuba\n- Love Live!\n- Lucky Star\n- Miss Kobayashi's Dragon Maid\n- Monogatari\n- NekoPara\n- Neon Genesis Evangelion\n- One Punch Man\n- OreGairu\n- Quintessential Quintuplets\n- Re:Zero\n- Rising of the Shield Hero\n- Sewayaki Kitsune no Senko-san\n- Shokugeki no Soma\n- Steins Gate\n- Sword Art Online\n- That Time I Got Reincarnated as a Slime\n- Toaru Majutsu no Index\n- Yuru Camp\n\n</details>\n\n---\n\n# Documentation\n\n- [Installation](#installation)\n    - [Requirements](#pre-requisites)  \n    - [Package Install](#package-install)\n- [Usage](#usage)\n  - [CLI](#command-line-interface)\n  - [Python API](#python-api)\n    - [Decorator](#decorator)\n- [Miscellaneous](#miscellaneous)\n    - [Contributing](#contributing)  \n    - [Theme Requests](#theme-requests)\n    - [Helping the community](#enjoying-the-themes)\n    - [Feature Requests](#contributions)\n\n# Quick Start!\n\nI've put together a [demo notebook](https://github.com/doki-theme/doki-theme-jupyter/blob/main/index.ipynb) that demonstrates the core functionality of the `doki-theme-jupyter` package.\n\n# Installation \n\n### Pre-Requisites\n\nFor the optimal experience it's best you have:\n\n- [Doki Theme Web](https://github.com/doki-theme/doki-theme-web)\n- Jupyter Notebook >=6.0.0\n- Python >=3.7\n- pip 21.0 >= (Just having pip should suffice)\n\n### Package Install\n\nThe Doki Theme for Jupyter Notebook provides a command line interface.\nWhich enables you decorate your notebook from your shell or notebook!\n\nTo install the package just run this command:\n\n```shell\npip install pip doki-theme-jupyter\n```\n\n# Usage\n\nThe Doki Theme for Jupyter Notebook has a few components.\nThe following sections are dedicated to explaining theme in detail.\n\n## Command Line Interface \n\nNow that you have `dokithemejupyter` available, here's what each of the options does!\n\n**Help**\n\n```shell\ndokithemejupyter --help\n```\n\nThis command will show you all the available features the CLI provides.\nThe rest of the sections below are dedicated to explaining each in detail.\n\n**List**\n\n```shell\ndokithemejupyter --list\n```\n\nWow! That's a bunch of themes! This command will output all the available themes to install.\n**Important**, theme arguments are exact match and require the `\"\"\"`, don't forget to add those!\n\n\n**Set Theme**\n\n```shell\ndokithemejupyter --set-theme \"Franxx: Zero Two Dark Obsidian\"\n```\n\nThis is the most important command, which enables the decoration of your notebook with your waifu!\n**Important**, theme arguments are exact match and require the `\"\"`, don't forget to add those!\n\n**Sticker**\n\n```shell\ndokithemejupyter --sticker --set-theme \"Franxx: Zero Two Dark Obsidian\"\n```\n\nThis installs your selected theme with the cute sticker in the righthand corner.\nRunning a set theme command without the sticker parameter will remove the sticker.\n\n```shell\ndokithemejupyter --sticker\n```\n\nWill only install the sticker for the current theme.\n\n**Remove**\n\n```shell\ndokithemejupyter --remove\n```\n\nSad to see you go, I'll be seeing you around friend!\nThis command removes all the notebook decoration and restores the defaults.\n\n**Version**\n\n```shell\ndokithemejupyter --version\n```\nYou keep your packages up to date right?\nWell you don't want to miss any updates, you might be missing some girls!\n\n## Python API\n\nYour otaku experience is not complete without a little extra decoration.\n\n### Decorator\n\nThis is a python API that will color [matplotlib's](https://matplotlib.org/)\nplotter to your currently selected theme. \nThat way all of your data visualizations match your favorite girl.\n\n```python\nfrom dokithemejupyter import decorator\ndecorator.decorate_plotter()\n```\n\nYou'll just need to have this code get run once before you do any plotting.\n\n# Miscellaneous\n\n## Contributing\n\nIf you want to get your workstation set up to work on the plugin,\nthen you'll want to check out the [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on what is needed.\n\n## Theme Requests\n\nIf you want your main squeeze to be featured in the Doki Theme suite, feel free to [submit a theme request](https://github.com/doki-theme/doki-master-theme/issues).\n\n## Enjoying the themes?\n\nGreat! I am glad you like it!\n\nBe sure to \u2b50 and share it with other weebs!\n\n## Contributions?\n\nI think your voice needs to be heard! You probably have good ideas, so feel free to submit your feedback as [an issue](https://github.com/doki-theme/doki-theme-jupyter/issues/new).\n\nHelp make this plugin better!\n\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Crunch data with your waifu! Choose a Jupyter Notebook theme based on a girl from various anime series, manga, and visual novels.",
    "version": "88.1.1.0.0",
    "split_keywords": [
        "jupyter",
        "notebook",
        "theme"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "872628548be5195970cbff25a7e75a71",
                "sha256": "454dac09360150b494b9cd946ff92f5e6addc6cfbb17a154158e171acb66c04f"
            },
            "downloads": -1,
            "filename": "doki_theme_jupyter-88.1.1.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "872628548be5195970cbff25a7e75a71",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.6, <4",
            "size": 276871,
            "upload_time": "2022-08-06T13:52:43",
            "upload_time_iso_8601": "2022-08-06T13:52:43.046960Z",
            "url": "https://files.pythonhosted.org/packages/7a/9d/ea7ddb153a056c5d1db66198983674a9887c27572c90979110db6672116f/doki_theme_jupyter-88.1.1.0.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-08-06 13:52:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "doki-theme",
    "github_project": "doki-theme-jupyter",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "doki-theme-jupyter"
}
        
Elapsed time: 0.48209s