Metadata-Version: 2.4
Name: nbs2ctx
Version: 0.0.2
Summary: Turning Jupyter notebooks into LLM-useable context
Home-page: https://github.com/AnswerDotAI/nbs2ctx
Author: Jonathan Whitaker
Author-email: johnowhitaker@gmail.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore
Requires-Dist: nbformat
Provides-Extra: dev
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# nbs2ctx


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Usage

nbs2ctx is a minimal CLI for turning a directory of notebooks (e.g. an
NBDev project) into context for an LLM. For example, from the root dir
of this github repo we could run:

`nbs_to_ctx nbs ctx.xml`

This will create a file ctx.xml with the contents of all the notebooks
in the nbs folder.

    <documents>
    <document index="1">
    <source>00_core.ipynb</source>
    <document_content>
    # nbs_to_ctx

    &gt; Turning Jupyter notebooks into LLM-ready context

    ```python
    #| default_exp core
    ... and so on, with the full contents of the notebook

### Installation

Install latest from the GitHub
[repository](https://github.com/AnswerDotAI/nbs2ctx):

``` sh
$ pip install git+https://github.com/AnswerDotAI/nbs2ctx.git
```

or from [pypi](https://pypi.org/project/nbs2ctx/)

``` sh
$ pip install nbs2ctx
```
