my_module User Guide

Info

This user guide is purely an illustrative example that shows off several features of Material for MkDocs and included Markdown extensions.

Installation

First, install Poetry:

Linux/macOSWindows

curl -sSL https://install.python-poetry.org | python3 -

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Then install the my_module package and its dependencies:

poetry install

Activate the virtual environment created automatically by Poetry:

poetry shell

Quick Start

To use my_module within your project, import the factorial function and execute it like:

from my_module.libs.tasks import create_tasks

assert create_tasks() is True