Quick start

Status

Installation

1. Download and unpack:

   … on Linux/macOS:

   $ curl -O https://codeload.github.com/veit/python-basics-tutorial/zip/main
   $ unzip main
   Archive:  main
   …
      creating: python-basics-tutorial-main/
   …

   … on Windows:

   C:> curl.exe -o main.zip -O https://codeload.github.com/veit/python-basics-tutorial-de/zip/main
   C:> tar -xvzf main.zip
   python-basics-tutorial-de-main/
   python-basics-tutorial-de-main/.gitignore
   python-basics-tutorial-de-main/.pyup.yml
   …
   

2. Install Python packages:

   … on Linux/macOS:

   $ python3 -m venv .
   $ source bin/activate
   $ python -m pip install --upgrade pip
   $ python -m pip install -r docs/requirements.txt

   … on Windows:

   C:> python -m venv .
   C:> Scripts\python -m pip install --upgrade pip
   C:> Scripts\python -m pip install -r docs/requirements.txt
   

3. Create HTML documentation:

   Note

   pandoc and plantuml has to be installed.

   … on Debian/Ubuntu

   $  sudo apt install pandoc plantuml

   To create the HTML documentation run these commands:

   $ sphinx-build -ab html docs/ docs/_build/html/

4. Create a PDF:

   For the creation of a PDF file you need additional packages. To create a PDF documentation you need additional packages, which you can install

   … on Debian/Ubuntu with

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

   or for macOS with:

   $ 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.

   Then you can generate a PDF with:

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

   You can find the PDF at docs/_build/latex/pythonbasics.pdf.

Follow us

• GitHub

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 make a pull request. If the changes contained therein are small and atomic, I’ll be happy to look at your suggestions.