nbconflux

(β˜… 125)

nbconflux converts Jupyter Notebooks to Atlassian Confluence pages

  • .coveragerc
  • .gitattributes
  • .gitignore
  • .travis.yml
  • LICENSE
  • Makefile
  • MANIFEST.in
  • README.md
  • requirements-test.txt
  • requirements.txt
  • run_tests.py
  • setup.cfg
  • setup.py
  • versioneer.py

# Installation Guide

1. Get the code
git clone https://github.com/adtech-labs/nbconflux

Downloads the entire project code from GitHub to your computer.

cd nbconflux

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install nbconflux

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install nbconflux

Installs the package published on PyPI directly β€” no need to clone the source.

Converts Jupyter Notebooks to Atlassian Confluence pages using nbconvert

Type this command into your terminal and run it.

--exclude-style Do not include the Jupyter base stylesheet

Type this command into your terminal and run it.

* In a Python script, Jupyter Notebook, etc.:

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make dev-env

Compiles the code based on the generated build configuration to produce an executable.

make test

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation