andy-python-template 0.2.0

Template for general Python development.

python-samples

A series of Python samples are available spanning the categories below.

Sample	Description
args_kwargs	Overview of args & kwargs and their usage.
assert	Overview of assert and its usage.
asychronous_programming	Overview of Asynchronous Programming in Python.
classes	Overview of Classes / Object-Oriented Programming (OOP) and their usage.
control_flow	Overview of Control Flow and its usage.
counters	Overview of Counters and their usage.
defaultdict	Overview of defaultdict and its usage.
dictionaries	Overview of Dictionaries and their usage.
dsa	Data Structures and Algorithms (DSA).
exceptions	Overview of Exceptions and their usage.
functions	Overview of Functions and their usage.
hello_world	A very simple Python program.
introduction	A general introduction to the Python programming language.
iterables_and_generators	Overview of Iterables & Generators and their usage.
list_comprehensions	Overview of List Comprehensions and their usage.
lists	Overview of Lists and their usage.
modules	Overview of Modules and their usage.
randomness	Overview of Randomness in Python.
regex	Overview of Regular Expressions in Python.
sets	Overview of Sets and their usage.
sorting	Overview of Sorting and its usage.
strings	Overview of Strings and their usage.
truthiness	Overview of Truthiness in Python.
tuples	Overview of Tuples and their usage.
type_annotations	Overview of Type Annotations in Python.
virtual_environments	Overview of Virtual Environments and their usage.
whitespace_formatting	Overview of Whitespace Formatting in Python.
zip_argument_unpacking	Overview of zip & Argument Unpacking in Python.

Script Execution

First, a local project environment needs to be created, then the project's modules will be installed into locally into a virtual environment.

1. Clone the repository.

   git clone https://github.com/bellanov/python-template.git
   cd python-template
   

2. Create a virtual environment.

   # Create Virtual Environment
   python3 -m venv .venv
   
   # Activate Virtual Environment
   
   # Linux
   source .venv/bin/activate
   
   # Windows
   .venv\Scripts\activate
   .venv\Scripts\Activate.ps1
   
   # Install all dependencies (runtime and development)
   pip install -e ".[dev]"
   
   # Deactivate Virtual Environment
   deactivate
   

Testing, Linting, and Formatting

Execute the tests to validate your installation.

Linux

scripts/test.sh

Windows

.\scripts\test.ps1