nbtag

Name	nbtag JSON
Version	0.0.2 JSON
	download
home_page	None
Summary	Set Jupyter notebook cell tags from a special comment
upload_time	2022-12-06 08:04:29
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	None
keywords	environments notebook reproducible scholarship science
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # nbtag

Set cell tags in a Jupyter notebook from a special comment.

## Why use this extension?

Many tools in the Jupyter ecosystem (ex.
[nbmake](https://github.com/treebeardtech/nbmake),
[nbstripout](https://github.com/kynan/nbstripout)) use cell tags to configure
their behavior.

However, some frontends to Jupyter (ex.
[ein](https://github.com/millejoh/emacs-ipython-notebook)) can't modify tags.

This server extension watches for a special comment in the content of the cell
and sets tags correspondingly.

## How to use

```python
# %tags: keep_output, another_tag
print("Hello World!")
```

A cell containing the text above will be given the tags `keep_output`,
`another_tag` on saving.

## Install

`pip install nbtag`

If you use `pipx`, make sure to inject `nbtag` into the Jupyter package's
environment.

## Enable

`jupyter serverextension enable nbtag`

`jupyter serverextension list`

## Compatibility

Only works with `jupyter server`, not with `jupyter notebook`, but I think you
should be using `jupyter server` + `nbclassic` instead of `jupyter notebook`
anyway?

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nbtag",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "environments,notebook,reproducible,scholarship,science",
    "author": null,
    "author_email": "Venky Iyer <indigoviolet@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/9e/38/c2cdc0ac6053f6df71e786d9d731ab7d80262ecc8003935e2930c3bd21b8/nbtag-0.0.2.tar.gz",
    "platform": null,
    "description": "# nbtag\n\nSet cell tags in a Jupyter notebook from a special comment.\n\n## Why use this extension?\n\nMany tools in the Jupyter ecosystem (ex.\n[nbmake](https://github.com/treebeardtech/nbmake),\n[nbstripout](https://github.com/kynan/nbstripout)) use cell tags to configure\ntheir behavior.\n\nHowever, some frontends to Jupyter (ex.\n[ein](https://github.com/millejoh/emacs-ipython-notebook)) can't modify tags.\n\nThis server extension watches for a special comment in the content of the cell\nand sets tags correspondingly.\n\n## How to use\n\n```python\n# %tags: keep_output, another_tag\nprint(\"Hello World!\")\n```\n\nA cell containing the text above will be given the tags `keep_output`,\n`another_tag` on saving.\n\n## Install\n\n`pip install nbtag`\n\nIf you use `pipx`, make sure to inject `nbtag` into the Jupyter package's\nenvironment.\n\n## Enable\n\n`jupyter serverextension enable nbtag`\n\n`jupyter serverextension list`\n\n## Compatibility\n\nOnly works with `jupyter server`, not with `jupyter notebook`, but I think you\nshould be using `jupyter server` + `nbclassic` instead of `jupyter notebook`\nanyway?\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Set Jupyter notebook cell tags from a special comment",
    "version": "0.0.2",
    "split_keywords": [
        "environments",
        "notebook",
        "reproducible",
        "scholarship",
        "science"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "md5": "88c3dfdc75bc9a4204b5389f0fe7d735",
                "sha256": "b6d9fba27007c32914235427eba902f91b3e785eba727899f07d479f30113981"
            },
            "downloads": -1,
            "filename": "nbtag-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "88c3dfdc75bc9a4204b5389f0fe7d735",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 3079,
            "upload_time": "2022-12-06T08:04:28",
            "upload_time_iso_8601": "2022-12-06T08:04:28.560478Z",
            "url": "https://files.pythonhosted.org/packages/d3/0b/027e761a86ae53608efcc357c19fdeb0713b63fd1bfc95aacb90a08aacbe/nbtag-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "md5": "cb57d4c6d56408f8d09fce49e6a3bc3b",
                "sha256": "572298c0f3dd3df721080d101abbbc4b7948197687e39f0744cd29f2ff77de66"
            },
            "downloads": -1,
            "filename": "nbtag-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cb57d4c6d56408f8d09fce49e6a3bc3b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 2251,
            "upload_time": "2022-12-06T08:04:29",
            "upload_time_iso_8601": "2022-12-06T08:04:29.914800Z",
            "url": "https://files.pythonhosted.org/packages/9e/38/c2cdc0ac6053f6df71e786d9d731ab7d80262ecc8003935e2930c3bd21b8/nbtag-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-06 08:04:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "nbtag"
}