Epyk templates

This is a collection of local reports to be run locally to show how to write HTML pages using Epyk core web components.

This repository will group all the tutorial used in the various Jupyter notebook with some extra demo on more complex implementations.

Those reports can used directly on your computer by downloading the project.

Repo Structure

This repository will only demonstrate how to use Epyk in the Python Ecosystem.

The Interactive category will require some external Python package to be run. install and details should be fully explained in the corresponding scripts.

Any reports in the web category need to be integrated to a External web framework in order to be able to see the result.

Usage

First install Epyk to your Python environment.

pip install epyk

Then run the reports using the generic runner PatchRunner. This will run all the report in the entier repository.

It is possible to only run few reports by changing the below variable.

# To reduce the scope of reports to build
filter = None # 'data_'
category = None

In those reports and during the implementation phases (before releasing the report to a production mode), it is common practice to use the below line of code to change the icon to a dark one.

This will warn any users that those reports are not yet validated.

page.headers.dev()

It is obviously possible to customise this icon but using the below instead

page.headers._favicon_url = config.FAVICON_URL # Change the Epyk logo

Those reports are used as Unit Test for the framework so do not hesitate to propose new ones to help on improving the release management.

More details concerning Epyk project are available on the official Github repository or on the Jupyter Notebooks

Please let us know your comments or your experience with the framework.