Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/veit/python-basics-tutorial
Training materials for our Python basics course: https://cusy.io/en/seminars
https://github.com/veit/python-basics-tutorial
pytest python sphinx-documentation sqlite3 testing-tools uml-diagrams xml
Last synced: 1 day ago
JSON representation
Training materials for our Python basics course: https://cusy.io/en/seminars
- Host: GitHub
- URL: https://github.com/veit/python-basics-tutorial
- Owner: veit
- License: bsd-3-clause
- Created: 2021-10-20T17:32:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T11:44:22.000Z (13 days ago)
- Last Synced: 2024-12-27T12:27:01.619Z (13 days ago)
- Topics: pytest, python, sphinx-documentation, sqlite3, testing-tools, uml-diagrams, xml
- Homepage: https://python-basics-tutorial.readthedocs.io/en/latest/
- Size: 2.25 MB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
Quick start
===========Status
------.. image:: https://img.shields.io/github/contributors/veit/python-basics-tutorial.svg
:alt: Contributors
:target: https://github.com/veit/python-basics-tutorial/graphs/contributors
.. image:: https://img.shields.io/github/license/veit/python-basics-tutorial.svg
:alt: License
:target: https://github.com/veit/python-basics-tutorial/blob/main/LICENSE
.. image:: https://readthedocs.org/projects/python-basics-tutorial/badge/?version=latest
:alt: Docs
:target: https://python-basics-tutorial.readthedocs.io/en/latest/Installation
------------#. Download and unpack:
… on Linux/macOS:
.. code-block:: console
$ curl -O https://codeload.github.com/veit/python-basics-tutorial/zip/main
$ unzip main
Archive: main
…
creating: python-basics-tutorial-main/
…… on Windows:
.. code-block:: ps1con
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
…#. Install Python packages:
… on Linux/macOS:
.. code-block:: console
$ python3 -m venv .venv
$ . .venv/bin/activate
$ python -m pip install --upgrade pip
$ python -m pip install -e ".[dev]"… on Windows:
.. code-block:: ps1con
C:> py -m venv .venv
C:> .\.venv\Scripts\activate.bat
C:> python -m pip install --upgrade pip
C:> python -m pip install -e ".[dev]"#. Create HTML documentation:
.. note::
pandoc and plantuml has to be installed.… on Debian/Ubuntu
.. code-block:: console
$ sudo apt install pandoc plantuml
To create the HTML documentation run these commands:
.. code-block:: console
$ sphinx-build -ab html docs/ docs/_build/html/
#. 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
.. code-block:: console
$ sudo apt 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.Then you can 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 can find the PDF at ``docs/_build/latex/pythonbasics.pdf``.
Follow us
---------.. _follow-us:
* `GitHub `_
* `Mastodon `_
* `Bluesky `_.. _end-follow-us:
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.