readme done

Author: SpectraL519

.github/workflows/format.yaml

@@ -6,6 +6,7 @@ on:
     paths:
       - src/**
       - test/**
+      - examples/**
       - pyproject.toml
 
 jobs:

README.md

@@ -15,19 +15,38 @@
 
 ## Table of contents
 
-* Installation
+* [Installation](#installation)
 * [Tutorial](#tutorial)
     * [Basic usage](#basic-usage)
     * [Common parameters](#common-parameters)
     * [Decorator-specific parameters](#decorator-specific-parameters)
 * [Examples](#examples)
 * [Dev notes](#dev-notes)
-* TODO
+    * [Environment setup](#environment-setup)
+    * [Building](#building)
+    * [Uploading](#uploading)
+    * [Testing](#testing)
+    * [Coverage](#coverage)
+    * [Formatting](#formatting)
 * [Licence](#licence)
 
 <br />
 <br />
 
+## Installation
+
+To install the PyConstClasses package in your python environment run:
+```shell
+pip install pyconstclasses
+```
+or
+```shell
+python -m pip install pyconstclasses
+```
+
+<br />
+<br />
+
 ## Tutorial
 
 After installing the package, you have to import it to your python program:
@@ -398,7 +417,25 @@ pip install dist/pyconstclasses-<version>-py3-none-any.whl --force-reinstall
 To upload the package to [pypi](https://pypi.org/) do the following:
 
 * Make sure that the `twine` package is installed in your python environment: `pip show twine`
-*
+* Upload the package to the testpypi repository:
+    ```shell
+    python -m twine upload --repository testpypi dist/*
+    ```
+* Verify wether the package has been succesfully uploaded by installing it to your python (virtual) environment:
+    ```shell
+    python -m pip install --index-url https://test.pypi.org/simple/ --no-deps pyconstclasses
+    ```
+* Verify the installation by running the example programs
+* If no problem occured, upload the package to [pypi](https://pypi.org/):
+    ```shell
+    twine upload dist/*
+    ```
+* Verify wether the package has been succesfully uploaded by installing it to your python (virtual) environment:
+    ```shell
+    python -m pip install pyconstclasses
+    ```
+* Verify the installation by running the example programs
+
 
 ### Testing:
 

examples/common_with_strict_types.py

@@ -10,6 +10,7 @@ class Person:
     def __repr__(self) -> str:
         return f"{self.first_name} {self.last_name} [age: {self.age}]"
 
+
 @cc.const_class(with_strict_types=True)
 class PersonStrictTypes:
     first_name: str

examples/const_class_inherit_constructor.py

@@ -7,7 +7,7 @@ class Person:
     last_name: str
 
     def __init__(self, full_name: str):
-        self.first_name, self.last_name = full_name.split(' ')
+        self.first_name, self.last_name = full_name.split(" ")
 
     def __repr__(self) -> str:
         return f"{self.first_name} {self.last_name}"

scripts/cleanup.sh

@@ -3,4 +3,4 @@
 echo Cleaning the build files...
 
 find . -type d -name "__pycache__" -exec rm -r {} +
-rm -r .pytest_cache/ .tox/ .coverage coverage.* src/pyconstclasses.egg-info/
+rm -r .pytest_cache/ .tox/ .coverage htmlcov/ coverage.* src/pyconstclasses.egg-info/ dist/

src/constclasses/__init__.py

@@ -1,3 +1,3 @@
-from .ccerror import ConstError, InitializationError, ConfigurationError
+from .ccerror import ConfigurationError, ConstError, InitializationError
 from .const_class import const_class
-from .static_const_class import static_const_class, mutable_instance
+from .static_const_class import mutable_instance, static_const_class