CLI tool to extract the code cells of a jupyter notebook into a .txt file.
Project description
Jupyter Code Cells to TXT
A simple command-line tool for extracting code cells from Jupyter notebooks. Optionally, it allows extraction of all cell types including markdown.
Table of Contents
Installation
Development Installation
For those contributing and making changes to the codebase, it's often more efficient to install the package in 'editable' mode. This way, changes you make to the source immediately reflect in the installed package.
To install in editable mode:
python setup.py develop
This will set up a link to your source code, so you won't have to repackage and reinstall every time you make a change.
Local Installation
- Clean the
dist
directory to prevent old distributions:
rm -r dist/*
- Package the project:
python setup.py sdist bdist_wheel
- Install the packaged distribution (Note: the version might depend on what is set in
setup.py
):
pip install --upgrade dist/jupyter-code-extractor-0.1.tar.gz
Usage
After installation, you can run the jupyter-code-extractor
directly from the CLI.
To extract all cell types, use the --all-cells
option:
jupyter-code-extractor --all-cells your_notebook.ipynb
Without the --all-cells
option, only code cells will be extracted.
Requirements
- Python 3.x
- Other dependencies can be found in the
requirements.txt
file.
Contributing
For contributions, please create a fork, make your changes, and submit a pull request. Details on the development setup and guidelines can be found in the CONTRIBUTING.md file.
Once pull requests are approved and merged, maintainers will handle versioning and releases. New releases on GitHub will automatically trigger package updates on PyPI via GitHub Actions.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Changelog
For a detailed history of changes, see CHANGELOG.md.
- 0.1 - Initial release with basic features.
- 0.2 - ... (and so on for a few recent versions)
For any issues or contributions, please open an issue or pull request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jupyter-code-extractor-0.1.2.tar.gz
.
File metadata
- Download URL: jupyter-code-extractor-0.1.2.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fcc04a21025deb92822af1066a364331ff7f452c582ed12bd584a2e8b246004 |
|
MD5 | 7227b72846af2344e851b4d27abaffcf |
|
BLAKE2b-256 | 577558fd00310de7306a835815d3648fcbc4a6ce23a472f290190a6892107e13 |
File details
Details for the file jupyter_code_extractor-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: jupyter_code_extractor-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19eb74f5c30b5a2ec657f9bd712008017eb5dfa6aed0f8848940814527479cd0 |
|
MD5 | 291d01a24a5740154495ea0d54c8f434 |
|
BLAKE2b-256 | 94df9f2c53bb444cdb27e9051e8e418b4a865124c6cb30677ae11543426528a5 |