Skip to main content

Import .ipynb files as modules in the system path.

Project description

BinderBuild StatusPyPI versionPyPI - Python VersionPyPI - Format

pip install nostalgiaforever

A Notebook is a Hypothesis

If a notebook is a hypothesis then it can be tested.

Modern scientists are transitioning to a generation where notebooks are common currency. Consider how testing and documentation are crucial aspect of reusable open source software. Those best practices evolved to support the communities developing that software. Generations of open source established idioms and style guides which enable software collaboration at global scale. Now, access to reusable software is blending with modern science, where both disciplines share similar global ambitions to solve increasing complex, multi-objective problems.

Consequently, notebooks have evolved past being a medium for personal insight to become assets for community innovation. They represent extra-personal objects for scientists who have evaluated procedural "units of thought" as computational narratives. In a way, a notebook represents a modern form of hypothesis, and scientists must get comfortable sharing them rapidly. Unfortunately, new authors lack conventions for sharing notebooks as hypotheses within a scientific community. This talk presents tactics from literate programming to create readable, reusable, and reproducible notebooks. These notebook authoring practices promote improved documentation and unit testing.


@docfast presenting behalf of deathbeds

See deathbeds present @ JupyterCon

    from nostalgiaforever import importing, testing, reuse

Key Technologies

Key Takeaways

  • Notebooks can be used for testing and software.
  • Best practices for composing testable computational essays.
  • Existing testing frameworks can be used with notebooks.

Order

  1. readme.ipynb
  2. importing.ipynb
  3. testing.ipynb
  4. reuse.ipynb

Before the talk

  • Restart your machine

  • Start the watcher

      source activate p6 && cd ahypothesis/nostalgiaforever && watchmedo tricks tricks.yml
    
  • Prepare the Fira Code fonts https://github.com/deathbeds/jupyterlab-fonts.

  • Hey art nerd! Turn the color on!

  • Cut the release.

Build the docs.

Github Pages

    from nbconvert.exporters.markdown import MarkdownExporter
    from nbconvert.preprocessors import Preprocessor
    class ReplaceLinks(Preprocessor):
        def preprocess_cell(self, cell, resources=None, index=0):
            if cell['cell_type'] == 'markdown':
                if isinstance(cell['source'], list): 
                    cell['source'] = ''.join(cell['source'])
                cell['source'] = cell['source'].replace('.ipynb', '')
            return cell, resources
    from pathlib import Path
    if __name__ == '__main__':
        from IPython import get_ipython
        !jupyter nbconvert --to markdown readme.ipynb
        for path in Path('.').rglob('*.ipynb'):

            if all(not part.startswith('.') for part in path.parts):
                to = ('docs' / path)
                print(path)
                to.parent.mkdir(exist_ok=True)
                MarkdownExporter(preprocessors=[ReplaceLinks()]).from_filename(path)[0]
                to.with_suffix('.md').write_text(
                    ("---\n"*2 if len(path.parts) > 1 else "") + MarkdownExporter(preprocess=[ReplaceLinks()]).from_filename(path)[0])
[NbConvertApp] Converting notebook readme.ipynb to markdown
[NbConvertApp] Writing 5882 bytes to readme.md
readme.ipynb
nostalgiaforever/importing.ipynb
nostalgiaforever/plugin.ipynb
nostalgiaforever/reuse.ipynb
nostalgiaforever/testing.ipynb
nostalgiaforever/util.ipynb
test/test_nostalgia.ipynb

Watcher with watchdog

source activate p6 && cd ahypothesis/nostalgiaforever/ && watchmedo tricks tricks.yml

Run unit tests.

    if __name__ == '__main__':
        try:
            __import__('unittest').main('test', argv='--verbose'.split())
        except SystemExit: ...
.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK
# Summary [clear all output then "Run All" -- or it didn't happen]

Summary [clear all output then "Run All" -- or it didn't happen]

if __name__ == '__main__':
    !source activate p6 && ipython --profile pidgin -m nostalgiaforever.importing
    !source activate p6 && ipython --profile pidgin -m nostalgiaforever.testing
    !source activate p6 && ipython --profile pidgin -m nostalgiaforever.reuse

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
nostalgiaforever-0.0.3-py3-none-any.whl (29.6 kB) Copy SHA256 hash SHA256 Wheel py3
nostalgiaforever-0.0.3.tar.gz (26.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page