Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kMutagene authored Sep 23, 2023
1 parent f65d4c0 commit fceecd0
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# FSharp.Data.NBFormat
# FsLab.NBFormat
A pure F# library for parsing the `.ipynb` notebook file format v4.

It uses [System.Text.Json]() in conjunction with the absolutely amazing [FSharp.SystemTextJson](https://github.com/Tarmil/FSharp.SystemTextJson) library.

There currently is a missing link in the .NET ecosystem between working in .NET notebooks and exporting them to other formats.
If you want to use .NET polyglot notebooks for creating documentation or websites, you have to use `nbconvert`, which is a python tool and therefore requires the setup of a python environment.

This library aims to close that gap by
- providing a type model for the `.ipynb` format (and the additional magic sauce added by .NET interactive)
- providing an extensible interface for converting polyglot notebooks into other formats

## Develop

### build
Expand Down Expand Up @@ -30,9 +37,8 @@ build.sh runTests

## Usage

The library is not on nuget because i am not sure under which namespace to put it currently (e.g. `FSharp.Data` vs `FSharp.Formatting`)
The library is not on nuget currently, so you currently have to clone the repo and build it yourself.

So you currently have to clone the repo and build it yourself.
Then you can use it to deserialize a notebook file like this:

```fsharp
Expand All @@ -42,4 +48,4 @@ open System.IO
"your/path/to/a/notebook.ipynb"
|> File.ReadAllText
|> Serialiation.deserializeNotebook
```
```

0 comments on commit fceecd0

Please sign in to comment.