# notebookr
[](https://badge.fury.io/py/notebookr)
[](https://pypi.org/project/notebookr/)
[](https://pepy.tech/project/notebookr)
A simple tool to set up development environments for Jupyter notebooks. My motivation: basically, Jupyter notebooks are about the only program type for which it is *still* generally practiced to distribute the code through email or file sharing.
I was tired of running the same setup process over and over with notebooks that are usually emailed to me. I work in IDEs, usually Cursor and sometimes VSCode, and naturally also work with git.
I complained to claude-3.5-sonnet about that, and here we are.
Using notebookr you can typically cut that setup process down to a very short workflow:
1. Receive and save python notebook (.ipynb) file into a working directory
2. Open a terminal
3. `notebookr SomeNotebookYouGot.ipynb`
4. `code some-notebook-you-got`
Once your code editor opens, depening on your workflow, youʻll probably want to open the terminal (ctrl-`) and enter either
5. `source .venv/bin/activate`
... or:
6. `.venv\Scripts\activate` # windows
# Installation
```bash
pip install notebookr
```
# or
```bash
uv add notebookr
```
# Usage
```bash
notebookr path/to/your/notebook.ipynb
```
```bash
notebookr --with_py path/to/your/notebook.ipynb # Also creates a python copy of the notebook
```
This will:
1. Create a virtual environment
2. Generate requirements.txt based on imports in your notebook
3. Create a .gitignore
4. Initialize a git repository
5. Install required packages
# Version
0.1.1 added `--with_py`
Raw data
{
"_id": null,
"home_page": null,
"name": "notebookr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "academic, development, jupyter, notebook, python, research, uv, virtualenv",
"author": null,
"author_email": "Peter Dresslar <peterdresslar@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ce/c5/b70eb0793e1c221cd4ad8d4465b0c86c0837c9f1089849845bd414f1d97c/notebookr-0.1.1.tar.gz",
"platform": null,
"description": "# notebookr\n\n[](https://badge.fury.io/py/notebookr)\n[](https://pypi.org/project/notebookr/)\n[](https://pepy.tech/project/notebookr)\n\nA simple tool to set up development environments for Jupyter notebooks. My motivation: basically, Jupyter notebooks are about the only program type for which it is *still* generally practiced to distribute the code through email or file sharing. \n\nI was tired of running the same setup process over and over with notebooks that are usually emailed to me. I work in IDEs, usually Cursor and sometimes VSCode, and naturally also work with git.\n\nI complained to claude-3.5-sonnet about that, and here we are. \n\nUsing notebookr you can typically cut that setup process down to a very short workflow:\n\n1. Receive and save python notebook (.ipynb) file into a working directory\n2. Open a terminal\n3. `notebookr SomeNotebookYouGot.ipynb`\n4. `code some-notebook-you-got`\n\nOnce your code editor opens, depening on your workflow, you\u02bbll probably want to open the terminal (ctrl-`) and enter either\n\n5. `source .venv/bin/activate` \n... or:\n6. `.venv\\Scripts\\activate` # windows\n\n# Installation\n\n```bash\npip install notebookr\n```\n# or\n```bash\nuv add notebookr\n```\n\n# Usage\n\n```bash\nnotebookr path/to/your/notebook.ipynb\n```\n\n```bash\nnotebookr --with_py path/to/your/notebook.ipynb # Also creates a python copy of the notebook\n```\n\nThis will:\n1. Create a virtual environment\n2. Generate requirements.txt based on imports in your notebook\n3. Create a .gitignore\n4. Initialize a git repository\n5. Install required packages\n\n# Version\n0.1.1 added `--with_py`",
"bugtrack_url": null,
"license": null,
"summary": "Setup development environment for Jupyter notebooks using UV",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/peterdresslar/notebookr/issues",
"Homepage": "https://github.com/peterdresslar/notebookr"
},
"split_keywords": [
"academic",
" development",
" jupyter",
" notebook",
" python",
" research",
" uv",
" virtualenv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc728ffdf4f9a115b9ec4844be2a98c202c8cbac6d3ca1fb39ce025896271ab6",
"md5": "01ae5131557837545cab8be0b36424d9",
"sha256": "2b986f4744fcf7c6fdd6ecef27a51c977462e86202519c7743dfa4fe0384915d"
},
"downloads": -1,
"filename": "notebookr-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01ae5131557837545cab8be0b36424d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4059,
"upload_time": "2025-01-19T07:21:57",
"upload_time_iso_8601": "2025-01-19T07:21:57.971549Z",
"url": "https://files.pythonhosted.org/packages/cc/72/8ffdf4f9a115b9ec4844be2a98c202c8cbac6d3ca1fb39ce025896271ab6/notebookr-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cec5b70eb0793e1c221cd4ad8d4465b0c86c0837c9f1089849845bd414f1d97c",
"md5": "ebc286e1eecdf85fb6ec2e56b00b7b58",
"sha256": "66a662ba3c23c4fa908c3c619f505df97d3a4e669b427adfd8ac08de933cb444"
},
"downloads": -1,
"filename": "notebookr-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ebc286e1eecdf85fb6ec2e56b00b7b58",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3179,
"upload_time": "2025-01-19T07:21:59",
"upload_time_iso_8601": "2025-01-19T07:21:59.716006Z",
"url": "https://files.pythonhosted.org/packages/ce/c5/b70eb0793e1c221cd4ad8d4465b0c86c0837c9f1089849845bd414f1d97c/notebookr-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 07:21:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "peterdresslar",
"github_project": "notebookr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "jupyter",
"specs": []
},
{
"name": "pandas",
"specs": []
}
],
"lcname": "notebookr"
}
JSON
