edu-python-course / python-course

Python Training Course

PYTHON TRAINING COURSE

This is the training course to master the Python programming language. This includes the very basics programming topics like data types, variables and object-oriented programming and advanced topics like multithreading and web-frameworks for Python.

Getting started

Getting the sources

Current repository is dependent on some other repos (is multi-repo). You may clone it, but this would not download the source of other repos. To get the full content, do:

git clone <this_repo_url> [local_repository]
# cd into cloned repo and switch to devel branch
git switch devel
# clone submodules content
git submodule update --init --recursive

Installing dependencies

This project comes with dependencies listed in formats suitable for pip and poetry package managers. It's recommended to use virtual environment while working with this project.

To install dependencies via pip do:

pip install -r requirements.txt

To do the same using poetry:

poetry install

Building documentation

This repository comes with Makefile. For now this is the easiest way to do anything within this source code. There are several targets defined:

• clean will clean up the documentation builds
• html will create HTML pages
• locales will create/update translations

Just do:

make <target>  # e.g. make html

By default all builds are done for english locale. Define LANGUAGE environment variable to build documents for other locales.

LANGUAGE=uk make html

Using make without arguments (targets) will clean up documentation and build HTML pages for en and uk locales.

make

This command is equal to:

make clean
LANGUAGE=en make html
LANGUAGE=uk make html

Building without make

make just automates the build process, however in case you don't have it installed, you can run builds manually:

sphinx-build -b html -D language=en src _build/html/en
sphinx-build -b html -D language=uk src _build/html/uk

Contributing to the project

This is an open-source project, so anyone is welcome to contribute to it. Please see contributing guide for more details.