ipyannotations

(โ˜… 61)

Data annotations in python using jupyter notebooks

  • .eslintignore
  • .eslintrc.js
  • .flake8
  • .gitignore
  • .npmignore
  • .pre-commit-config.yaml
  • .prettierignore
  • .prettierrc
  • .readthedocs.yml
  • babel.config.js
  • codecov.yml
  • install.json
  • ipyannotations.json
  • jest.config.js
  • LICENSE
  • MANIFEST.in
  • package.json
  • pyproject.toml
  • README.md
  • RELEASE.md
  • setup.cfg
  • setup.py
  • tsconfig.eslint.json
  • tsconfig.json
  • webpack.config.js
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/janfreyberg/ipyannotations

Downloads the entire project code from GitHub to your computer.

cd ipyannotations

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 ipyannotations

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. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
conda create -n ipyannotations-dev -c conda-forge nodejs yarn python jupyterlab

Runs the Python script (or module).

yarn run build

Type this command into your terminal and run it.

yarn run watch

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. 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 ipyannotations

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

jupyter nbextension enable --py [--sys-prefix|--user|--system] ipyannotations

Type this command into your terminal and run it.

pip install -e ".[test, examples]"

Installs the Python libraries listed in requirements.txt (or similar).

jupyter labextension develop --overwrite .

Type this command into your terminal and run it.

jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyannotations

Type this command into your terminal and run it.

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

Pulled directly from this repo's README.

// repository documentation