Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/veit/pyviz-tutorial

Training materials for the Cusy Python training courses: https://cusy.io/en/seminars
https://github.com/veit/pyviz-tutorial

bokeh datashader graphviz holoviz hvplot ipyleaflet ipyvolume ipywidgets networkx pythreejs vega vega-lite

Last synced: 1 day ago
JSON representation

Training materials for the Cusy Python training courses: https://cusy.io/en/seminars

Awesome Lists containing this project

README

        

Quick Start
===========

.. image:: https://img.shields.io/github/contributors/veit/pyviz-tutorial.svg
:alt: Contributors
:target: https://github.com/veit/pyviz-tutorial/graphs/contributors
.. image:: https://img.shields.io/github/license/veit/pyviz-tutorial.svg
:alt: License
:target: https://github.com/veit/pyviz-tutorial/blob/main/LICENSE
.. image:: https://results.pre-commit.ci/badge/github/veit/pyviz-tutorial/main.svg
:alt: pre-commit.ci status
:target: https://results.pre-commit.ci/latest/github/veit/pyviz-tutorial/main
.. image:: https://readthedocs.org/projects/pyviz-tutorial/badge/?version=latest
:alt: Docs
:target: https://pyviz-tutorial.readthedocs.io/de/latest/
.. image:: https://img.shields.io/badge/dynamic/json?label=Mastodon&query=totalItems&url=https%3A%2F%2Fmastodon.social%2F@PyViz%2Ffollowers.json&logo=mastodon
:alt: Mastodon
:target: https://mastodon.social/@PyViz

Installation
------------

#. Download and unpack:

.. code-block:: console

$ curl -O https://codeload.github.com/veit/pyviz-tutorial/zip/refs/heads/main
$ unzip main
Archive: main

creating: pyviz-tutorial-main/

#. Install Pandoc:

* for Ubuntu and Debian:

.. code-block:: console

$ sudo apt install pandoc

* for macOS:

.. code-block:: console

$ brew install pandoc

#. Install Python packages:

.. code-block:: console

$ cd pyviz-tutorial
$ python3 -m venv .venv
$ . .venv/bin/activate
$ python -m pip install -e ".[dev]"

#. Create HTML documentation:

.. code-block:: console

$ python -m sphinx -b html docs/ docs/_build/html/

#. Create PDF:

You will need additional packages to create PDFs.

For Debian/Ubuntu you can get these with:

.. code-block:: console

$ apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

or for macOS with::

.. code-block:: console

$ brew cask install mactex

🍺 mactex was successfully installed!
$ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts
$ sudo texlua install-getnonfreefonts

mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...
mktexlsr: Done.

You can then generate a PDF with:

.. code-block:: console

$ cd docs/
$ make latexpdf

The LaTeX files are in _build/latex.
Run 'make' in that directory to run these through (pdf)latex

You will then find the PDF in ``docs/_build/latex/pyviz-tutorial.pdf``.

Follow us
---------

* `GitHub `_
* `Mastodon `_

Pull-Requests
-------------

If you have suggestions for improvements and additions, I recommend that you
create a `fork `_ of my `GitHub
repository `_ and make your changes
there. You are also welcome to submit a pull request. As long as the changes are
small and atomic, I will be happy to look at your suggestions.