Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/peterdresslar/notebookr

https://github.com/peterdresslar/notebookr

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: peterdresslar
  • Language: Python
  • Default Branch: main
  • Size: 80.1 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 6
  • Releases: 0
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme

README.md

notebookr

PyPI version Python Downloads

A simple tool to set up development environments for Jupyter notebooks. My motivation: people frequently email or file-share Jupyter notebooks, which generally short-circuits my normal flow for receiving, working with, and managing code (usually via GitHub). So, whatʻs the fastest, easiest way to get these loose notebooks into flow?

Using notebookr you can typically cut the 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 SomeNotebook.ipynb

The package runs and creates a project folder with your notebook. At this point, if you are using an IDE, you might:

  1. code some-notebook
  2. source .venv/bin/activate ... or:
  3. .venv\Scripts\activate # windows
  • or - if you are using Jupyter
  1. jupyter lab --notebook-dir=some-notebook

Notebookr will give you - A git-initialized, uv-initialized project folder with a name based on the notebook name - The uv virtual environment at .venv/, ready to be activated. - A simple .gitignore with common patterns, including especially that .venv pattern - A pyproject.toml or requirements.txt (optional) file with dependencies read in from the notebook. - A notebooks/ folder with your notebook safely tucked away.

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

Owner

  • Name: Peter Dresslar
  • Login: peterdresslar
  • Kind: user
  • Location: Honolulu, Hawaii

Befriender of Chickens

GitHub Events

Total
  • Issues event: 7
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 22
  • Create event: 2
Last Year
  • Issues event: 7
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 22
  • Create event: 2

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 38 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
pypi.org: notebookr

Setup development environment for Jupyter notebooks using UV

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 38 Last month
Rankings
Dependent packages count: 9.7%
Forks count: 31.9%
Average: 34.6%
Stargazers count: 41.8%
Dependent repos count: 54.9%
Maintainers (1)
peterdresslar
Last synced: 11 months ago

Dependencies

pyproject.toml pypi
requirements.txt pypi
  • jupyter *
  • pandas *