Developer Docs

For information on how to help improve the nbstata code, see: CONTRIBUTING.md

The main dependencies among the principal nbstata modules:

flowchart TB
  A[kernel] -.-> I[config]
  A -.-> B[cell]
  B -.-> E[magics]
  B -.-> D[stata_session]
  D -.-> C[noecho]
  E -.-> L[browse]
  A -.-> F[completions]
  F -.-> D
  F -.-> G[completion_env]
  A -.-> N[inspect]
  N -.-> H[stata_more]
  D -.-> H
  L -.-> M[pandas]
  L -.-> H
  M -.-> H
  C -.-> H
  click A "https://hugetim.github.io/nbstata/kernel.html"
  click B "https://hugetim.github.io/nbstata/cell.html"
  click C "https://hugetim.github.io/nbstata/noecho.html"
  click D "https://hugetim.github.io/nbstata/stata_session.html"
  click E "https://hugetim.github.io/nbstata/magics.html"
  click F "https://hugetim.github.io/nbstata/completions.html"
  click G "https://hugetim.github.io/nbstata/completion_env.html"
  click H "https://hugetim.github.io/nbstata/stata_more.html"
  click I "https://hugetim.github.io/nbstata/config.html"
  click L "https://hugetim.github.io/nbstata/browse.html"
  click M "https://hugetim.github.io/nbstata/pandas.html"
  click N "https://hugetim.github.io/nbstata/inspect.html"

The complete list of modules:

Title Description
misc_utils General helper functions with no Jupyter or pystata dependence
config Utilities for loading Stata and nbstata
stata Simple wrappers for pystata/sfi functionality
stata_more Helper functions that expand on pystata/sfi functionality
code_utils Stata-related helper functions with no Jupyter or pystata dependence
noecho For running multi-line Stata code without echoing the commands
pandas Stata-to-pandas utilities, used in nbstata.browse
browse Helpers for browse, head, and tail magics
stata_session A class for representing a Stata session
magics IPython magics for nbstata
completion_env Autocomplete helper: determine context of the token to be autocompleted
completions Autocomplete functionality
inspect Provides output for kernel.do_inspect()
cell Class representing a single code cell
kernel IPythonKernel based on pystata
install nbstata kernel install script
No matching items