Metadata-Version: 2.4
Name: jupyter-reports
Version: 0.7.0
Summary: Creating technical reports using jupyter notebooks and sympy.
Author-email: Daniel Hardt <daniel@daniel-hardt.de>
License-Expression: LGPL-3.0-only
Project-URL: Homepage, https://gitlab.com/clouddancer/jupyter-reports/
Project-URL: Documentation, https://clouddancer.gitlab.io/jupyter-reports/
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: sympy
Requires-Dist: numpy>=2.0
Requires-Dist: scipy>=1.15
Requires-Dist: matplotlib
Requires-Dist: pandas>=2.0
Requires-Dist: jupyter
Requires-Dist: nbconvert
Requires-Dist: pandoc
Requires-Dist: ipynbname
Requires-Dist: cloudpickle
Requires-Dist: testpath
Requires-Dist: nbclient
Provides-Extra: setup
Requires-Dist: build; extra == "setup"
Requires-Dist: setuptools>=77; extra == "setup"
Requires-Dist: setuptools_scm>=8; extra == "setup"
Requires-Dist: Cython; extra == "setup"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: sphinx-argparse; extra == "doc"
Provides-Extra: test
Requires-Dist: pre-commit; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-durations; extra == "test"
Dynamic: license-file

[![pipeline status](https://gitlab.com/clouddancer/jupyter-reports/badges/master/pipeline.svg)](https://gitlab.com/clouddancer/jupyter-reports/-/commits/master)
[![coverage report](https://gitlab.com/clouddancer/jupyter-reports/badges/master/coverage.svg)](https://gitlab.com/clouddancer/jupyter-reports/-/commits/master)

# README

This package is used to create technical reports using Jupyter Notebooks and sympy.

## Installation

Create Anaconda environment:

    conda create -n jupyter-reports python=3.11
    conda activate jupyter-reports

Install `pandoc`:

    conda install pandoc

Installation via pip from a wheel file

    pip install jupyter-reports-*.whl

or from pypi.org:

    pip install jupyter-reports

## Documentation

The documentation is [online](https://clouddancer.gitlab.io/jupyter-reports/) available.

## For Developer

The Python package [`setuptools`](https://setuptools.readthedocs.io/en/latest/) is used for the package creation and installation of `jupyter-reports`.
Follow the installation steps above but install `jupyter-reports` in editable mode

    pip install -e .

Be aware that the test are running in the CI with an older pandoc version and therefor tests can fail
with the current pandoc version. To avoid this, install the old pandoc version:

    conda install "pandoc=2.17"

### Debugging

For debugging, coverage must be disabled when running the tests. For this, run pytest with the `--no-cov` option.

### Building the package

Building the source distribution:

    python -m build --sdist

Building the wheel:

    python -m build --wheel

Build all:

    python -m build

### Building the Documentation

Building the Documentation (HTML docs):

    pip install .
    sphinx-build -b html -a docs/ docs/build

For PDF documentation:

    sphinx-build -b latex -a docs/ docs/build
    cd docs/build/latex
    latexmk -pdf jupyter-reports.tex
    cd ../../..

### Run Tests

Run all tests:

    pytest

Run only unit tests:

    pytest -m unit_tests

### Update translations

    python pygettext.py -v -d jupyter_reports -o src/jupyter_reports/i18n/jupyter_reports.pot src/jupyter_reports/*.py

    python msgfmt.py src/jupyter_reports/i18n/en/LC_MESSAGES/jupyter_reports
    python msgfmt.py src/jupyter_reports/i18n/de/LC_MESSAGES/jupyter_reports
