snakedown 0.3.0

This is a snakedown. Hand over your docs, nice and clean, and nobody gets confused.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use color_eyre::{Result, eyre::eyre};
use nbformat::{Notebook, parse_notebook, upgrade_legacy_notebook, v4::Cell};
use std::{fs, path::Path};

pub fn parse_notebook_file(path: &Path) -> Result<Vec<Cell>> {
    // Read the notebook file
    let notebook_json = fs::read_to_string(path)?;

    // Parse the notebook
    let notebook = match parse_notebook(&notebook_json)? {
        Notebook::V4(notebook) => notebook,
        Notebook::Legacy(notebook) => {
            upgrade_legacy_notebook(notebook).map_err(|err| eyre!(err))?
        }
    };

    let metadata = notebook.metadata;

    let language_name = match (metadata.kernelspec, metadata.language_info) {
        (None, None) => None,
        (_, Some(li)) => Some(li.name),
        (Some(ks), None) => ks.language,
    };

    if language_name != Some("python".to_string()) {
        return Err(eyre!(
            "Currently languages other than python are not supported in snakedown. Found: {:?}",
            language_name
        ));
    };

    Ok(notebook.cells)
}

#[cfg(test)]
mod test {

    use color_eyre::Result;
    use std::path::PathBuf;

    use crate::parsing::python::jupyter::parse_notebook_file;

    fn test_notebook_path() -> PathBuf {
        PathBuf::from("tests/test_notebooks/example_outputs.ipynb")
    }

    #[test]
    fn test_can_parse_pandas_example() -> Result<()> {
        let path = test_notebook_path();

        let _ = parse_notebook_file(&path)?;

        Ok(())
    }
}