Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.56 KB

README.md

File metadata and controls

39 lines (30 loc) · 1.56 KB

GitHub release (latest by date) GitHub tag (latest by date) Code style: black

Dikes for dummies

This repository is a Python course that explores Object Oriented programming from a Product Development perspective. We will be creating a very simple tool from scratch described in study case. The course will provide with tools, techniques and insides on how to apply Software Engineering concepts in the most effective way. Some code snippets will be provided so that the reader can find inspiration towards building a Minimal Viable Product.

Each chapter can be followed with its respective branch in the repository. Therefore it is not required to 'finish' each chapter to follow the next one.

Installation.

conda env create -f environment.yml
poetry install

Documentation

As a website:

poetry run mkdocs build
poetry run mkdocs serve

Your machine should be now serving at the localhost all the available documentation.

As pdf

First, install poetry:

poetry install

Next, follow the required steps of weasyprint https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation

If the installation of weasyprint was succesful, you can now run our custom script:

poetry run build-docs

A pdf named dikesfordummies_manual.pdf should appear at the root of your directory.