notebook

package

Go to main page

Versions in this module

v0

v0.0.8

Nov 5, 2020

v0.0.7

Nov 3, 2020

Changes in this version

type Notebook

+ func Parse(data []byte, opts ...Opt) (*Notebook, error)

v0.0.6

Nov 2, 2020

Changes in this version

+ const SVGMime

+ type Base64Figure struct

+ Alt string

+ Caption string

+ ContentType string

+ Data []byte

+ FullSize bool

+ Href string

+ Id string

+ IsPrimary bool

+ Resource *Resource

+ Url string

+ func NewBase64Figure(contentType string, data []byte) (*Base64Figure, error)

+ func NewSVG(contentType string, data []byte) *Base64Figure

type Falsifiable

+ PrimaryImageCH string

+ Subtitle string

+ type OutputFigureMetadata struct

+ Alt string

+ Caption string

+ FullSize bool

+ Href string

+ IsPrimary bool

type OutputMetadata

+ FigureMeta map[string]OutputFigureMetadata

type Parser

+ func (p *Parser) ParseOutputFigureMetadata(cellIdx, outputIdx int, data []byte, contentType string) (OutputFigureMetadata, error)

type Renderer

+ GetDefaultLang func() string

+ SetMetadata func(metadata MetaData)

+ WriteB64Image func(fig *Base64Figure) (string, error)

v0.0.5

Oct 29, 2020

v0.0.4

Oct 29, 2020

Changes in this version

type Opt

+ func RetainRaw() Opt

+ func Strict() Opt

type Resource

+ func (r *Resource) Md5() []byte

+ func (r *Resource) Size() int

v0.0.3

Oct 29, 2020

Changes in this version

+ const CellTypeCode

+ const CellTypeMarkdown

+ const CellTypeRaw

+ const CellTypeUnrecognized

+ const OutputTypeDisplayData

+ const OutputTypeError

+ const OutputTypeExecuteResult

+ const OutputTypeStream

+ var DefaultRemoveCellTags = map[string]bool

+ var DefaultRemoveInputTags = map[string]bool

+ var DefaultRemoveOutputTags = map[string]bool

+ var ErrNullBoolNotAllowed = errors.New("null bool not allowed")

+ var ErrNullIntNotAllowed = errors.New("null integer not allowed")

+ var ErrNullStringListNotAllowed = errors.New("null string list not allowed")

+ var ErrNullStringNotAllowed = errors.New("null string not allowed")

+ func LoadFixture(t *testing.T, relPath ...string) []byte

+ func PassesNBConvert(nbPath, jupyterConvertPath string) (string, bool)

+ func PathRelativeToTest(t *testing.T, relPath ...string) string

+ func ProduceNotebookPaths(ctx context.Context, rootDir string, bufSize int) <-chan string

+ func TempDir(t *testing.T) (string, func())

+ type Author struct

+ Extras map[string]string

+ Name string

+ func (a Author) MarshalJSON() ([]byte, error)

+ type Cell interface

+ GetInput func() []string

+ GetMetadata func() CellMetadata

+ GetOutputs func() []Output

+ GetRaw func() []byte

+ GetType func() string

+ RenderInput func(r *Renderer) error

+ RenderOutput func(r *Renderer) error

+ type CellMetadata struct

+ Collapsed bool

+ Deletable bool

+ Editable bool

+ Format string

+ Jupyter JupyterMetaData

+ Name string

+ Tags []string

+ type CodeCell struct

+ CellType string

+ Metadata CellMetadata

+ Outputs []Output

+ Raw []byte

+ Source []string

+ func (c CodeCell) GetInput() []string

+ func (c CodeCell) GetMetadata() CellMetadata

+ func (c CodeCell) GetOutputs() []Output

+ func (c CodeCell) GetRaw() []byte

+ func (c CodeCell) GetType() string

+ func (c CodeCell) RenderInput(r *Renderer) error

+ func (c CodeCell) RenderOutput(r *Renderer) error

+ type CodeMirrorMode struct

+ Name string

+ Version int

+ type DisplayData struct

+ Data MimeBundle

+ Metadata OutputMetadata

+ OutputType string

+ func (s DisplayData) Render(r *Renderer) error

+ func (s DisplayData) Type() string

+ type ErrorOutput struct

+ EName string

+ EValue string

+ OutputType string

+ Traceback []string

+ func (s ErrorOutput) Render(r *Renderer) error

+ func (s ErrorOutput) Type() string

+ type ExecuteResult struct

+ Data MimeBundle

+ ExecuteCount int

+ Metadata OutputMetadata

+ OutputType string

+ func (s ExecuteResult) Render(r *Renderer) error

+ func (s ExecuteResult) Type() string

+ type Falsifiable struct

+ Authors []string

+ CreatedAt string

+ Repo string

+ Slug string

+ Title string

+ UpdatedAt string

+ User string

+ type JupyterMetaData struct

+ OutputsHidden bool

+ SourceHidden bool

+ type KernelSpec struct

+ DisplayName string

+ Language string

+ Name string

+ type LanguageInfo struct

+ CodeMirrorMode CodeMirrorMode

+ FileExtension string

+ MimeType string

+ NBConvertExporter string

+ Name string

+ PygmentsLexer string

+ Version string

+ type MarkdownCell struct

+ CellType string

+ Metadata CellMetadata

+ Raw []byte

+ Source []string

+ func (c MarkdownCell) GetInput() []string

+ func (c MarkdownCell) GetMetadata() CellMetadata

+ func (c MarkdownCell) GetOutputs() []Output

+ func (c MarkdownCell) GetRaw() []byte

+ func (c MarkdownCell) GetType() string

+ func (c MarkdownCell) RenderInput(r *Renderer) error

+ func (c MarkdownCell) RenderOutput(r *Renderer) error

+ type MetaData struct

+ Authors []Author

+ Falsifiable Falsifiable

+ KernelSpec KernelSpec

+ LanguageInfo LanguageInfo

+ OrigFmt int

+ Raw []byte

+ Title string

+ type MimeBundle = map[string][]string

+ type Notebook struct

+ Cells []Cell

+ MetaData MetaData

+ Raw []byte

+ VersionMajor int

+ VersionMinor int

+ func (nb *Notebook) Marshal() ([]byte, error)

+ type Opt func(p *Parser)

+ func Lenient() Opt

+ type Output interface

+ Render func(r *Renderer) error

+ Type func() string

+ type OutputMetadata struct

+ NeedsBackground string

+ type ParseError struct

+ func NewParseError(offset int, path string, msg string, args ...interface{}) *ParseError

+ func (p *ParseError) Error() string

+ type Parser struct

+ func NewParser(opts ...Opt) *Parser

+ func (p *Parser) Parse(data []byte) (*Notebook, error)

+ func (p *Parser) ParseAuthor(authorIdx int, data []byte) (Author, error)

+ func (p *Parser) ParseAuthors(data []byte, offset int) ([]Author, error)

+ func (p *Parser) ParseCell(cellIdx int, data []byte, offset int) (Cell, error)

+ func (p *Parser) ParseCellMetadata(cellIdx int, data []byte, offset int) (CellMetadata, error)

+ func (p *Parser) ParseCells(data []byte, offset int) ([]Cell, error)

+ func (p *Parser) ParseCodeMirrorMode(data []byte, offset int) (CodeMirrorMode, error)

+ func (p *Parser) ParseFalsifiable(data []byte, offset int) (Falsifiable, error)

+ func (p *Parser) ParseJupyterMetadata(cellIdx int, data []byte, offset int) (JupyterMetaData, error)

+ func (p *Parser) ParseKernelSpec(data []byte, offset int) (KernelSpec, error)

+ func (p *Parser) ParseLanguageInfo(data []byte, offset int) (LanguageInfo, error)

+ func (p *Parser) ParseMetadata(data []byte, offset int) (MetaData, error)

+ func (p *Parser) ParseOutput(cellIdx, outputIdx int, data []byte, offset int) (Output, error)

+ func (p *Parser) ParseOutputMetadata(cellIdx, outputIdx int, data []byte, offset int) (OutputMetadata, error)

+ func (p *Parser) ParseOutputs(cellIdx int, data []byte, offset int) ([]Output, error)

+ func (p *Parser) Read(filePath string) (*Notebook, error)

+ type RawCell struct

+ CellType string

+ Metadata CellMetadata

+ Raw []byte

+ Source []string

+ func (c RawCell) GetInput() []string

+ func (c RawCell) GetMetadata() CellMetadata

+ func (c RawCell) GetOutputs() []Output

+ func (c RawCell) GetRaw() []byte

+ func (c RawCell) GetType() string

+ func (c RawCell) RenderInput(r *Renderer) error

+ func (c RawCell) RenderOutput(r *Renderer) error

+ type RenderOpt func(*Renderer)

+ func ImgSrcPrefix(prefix string) RenderOpt

+ type Renderer struct

+ func NewRenderer(w io.Writer, opts ...RenderOpt) *Renderer

+ func (r *Renderer) DeriveDefaultLang(nb *Notebook)

+ func (r *Renderer) DeriveTitleMarkdown(lines []string)

+ func (r *Renderer) DeriveTitleMetadata(nb *Notebook)

+ func (r *Renderer) Elide(tags []string) (cell bool, source bool, output bool)

+ func (r *Renderer) GetResource(contentHash string) *Resource

+ func (r *Renderer) GetResources() map[string]*Resource

+ func (r *Renderer) GetTitle() string

+ func (r *Renderer) RenderNBTo(nb *Notebook, w io.Writer) error

+ func (r *Renderer) WriteHTMLEscapedLines(lines []string) error

+ func (r *Renderer) WriteHTMLUnsafely(lines []string) error

+ func (r *Renderer) WriteImage(contentType string, data []byte) (string, error)

+ func (r *Renderer) WriteMarkdownCodeFenced(lang string, lines []string) error

+ func (r *Renderer) WriteMarkdownLines(lines []string) error

+ func (r *Renderer) WriteOutputs(outputs []Output) error

+ func (r *Renderer) WritePlainText(class string, lines []string, clean bool) error

+ type Resource struct

+ func NewResource(contentType string, data []byte) *Resource

+ func (r *Resource) ContentHash() []byte

+ func (r *Resource) ContentType() string

+ func (r *Resource) Data() []byte

+ type StreamOutput struct

+ Name string

+ OutputType string

+ Text []string

+ func (s StreamOutput) Render(r *Renderer) error

+ func (s StreamOutput) Type() string

+ type UnrecognizedCell struct

+ CellType string

+ Metadata CellMetadata

+ Raw []byte

+ func (c UnrecognizedCell) GetInput() []string

+ func (c UnrecognizedCell) GetMetadata() CellMetadata

+ func (c UnrecognizedCell) GetOutputs() []Output

+ func (c UnrecognizedCell) GetRaw() []byte

+ func (c UnrecognizedCell) GetType() string

+ func (c UnrecognizedCell) RenderInput(r *Renderer) error

+ func (c UnrecognizedCell) RenderOutput(r *Renderer) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL