Schnelleinstieg

Status

Installation

1. Auschecken:

   $ git clone [email protected]:cusyio/ai-tutorial.git

2. Installieren von Python-Paketen:

   … auf Linux/macOS:

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

   … auf Windows:

   C:> py -m venv .venv
   C:> .\.venv\Scripts\activate.bat
   C:> python -m pip install --upgrade pip
   C:> python -m pip install -e ".[dev]"
   

3. Erstellen der HTML-Dokumentation:

   Note

   pandoc muss installiert sein.

   … auf Debian/Ubuntu:

   $  sudo apt install pandoc

   Zum Erstellen der HTML-Dokumentation führt den folgenden Befehl aus:

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

4. Erstellen eines PDF:

   Zum Erstellen einer PDF-Dokumentation benötigt ihr zusätzliche Pakete, die ihr installieren könnt

   … auf Debian/Ubuntu mit

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

   … auf macOS mit

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

   Anschließend könnt ihr ein PDF generieren mit:

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

   Das PDF findet ihr dann in docs/_build/latex/pythonbasics.pdf.

Folgt uns

• GitHub

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehlen wir euch, einen Fork unseres GitHub Repository zu erstellen und eure Änderungen dort zu machen. Bevor ihr Commits macht, überprüft, ob die pre-commit-Checks erfolgreich durchlaufen:

$ cd ai-tutorial
$ pre-commit install