Welcome to python-template’s documentation!

Github repository: https://github.com/plfelter/python-template

This documentation aims at describing the tools and workflow that can be used to work on a Python project.

• 1. Tools
  • 1.1. Mandatory tools
    • 1.1.1. Text editor
    • 1.1.2. git
    • 1.1.3. poetry
    • 1.1.4. pylint
    • 1.1.5. pytest
    • 1.1.6. black
  • 1.2. Optional tools
    • 1.2.1. mypy
    • 1.2.2. Sphinx
• 2. Project setup
• 3. Development flow
  • 3.1. Documentation
    • 3.1.1. Install Sphinx
    • 3.1.2. Init project files (structure and content)
    • 3.1.3. Work on documentation content
    • 3.1.4. Publish as a static website
    • 3.1.5. Generate a PDF document
• 4. Markdown example

Warning

This project is under active development.

Note

Hehehe !

Example Python function

def f():
    print('yaaassssss')

See also

Module zipfile

Documentation of the zipfile standard module.

GNU tar manual, Basic Tar Format

Documentation for tar archive files, including GNU tar extensions.

(int) function(*int a):
   return *a

\[ \begin{align}\begin{aligned}(a + b)^2 = a^2 + 2ab + b^2\\(a - b)^2 = a^2 - 2ab + b^2\end{aligned}\end{align} \]

Inputs		Output
A	B	A or B
False	False	False
True	False	True
False	True	True
True	True	True

Check out the Tools section for further information.