readme and pyproject

Author: FredHappyface

README.md

@@ -75,7 +75,7 @@ in the DOCS
 - [Example Use](#example-use)
 	- [Help](#help)
 - [Developer Notes](#developer-notes)
-	- [Generate semgrep_sec.yaml](#generate-semgrep_secyaml)
+	- [Generate semgrep\_sec.yaml](#generate-semgrep_secyaml)
 - [Documentation](#documentation)
 - [Install With PIP](#install-with-pip)
 - [Language information](#language-information)
@@ -92,6 +92,8 @@ in the DOCS
 - [How to run](#how-to-run)
 	- [Windows](#windows)
 	- [Linux/ MacOS](#linux-macos)
+- [Building](#building)
+- [Testing](#testing)
 - [Download Project](#download-project)
 	- [Clone](#clone)
 		- [Using The Command Line](#using-the-command-line)
@@ -160,8 +162,8 @@ Head to https://pypi.org/project/SimpleSecurity/ for more info
 
 ### Built for
 
-This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and
-3.10
+This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
+3.11
 
 ## Install Python on Windows
 
@@ -221,6 +223,36 @@ version.
 - File
 	`python3.x [file]` or `./[file]`
 
+## Building
+
+This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
+command generates the documentation, updates the requirements.txt and builds the library artefacts
+
+Note the functionality provided by fhmake can be approximated by the following
+
+```sh
+handsdown  --cleanup -o documentation/reference
+poetry export -f requirements.txt --output requirements.txt
+poetry export -f requirements.txt --with dev --output requirements_optional.txt
+poetry build
+```
+
+`fhmake audit` can be run to perform additional checks
+
+## Testing
+
+For testing with the version of python used by poetry use
+
+```sh
+poetry run pytest
+```
+
+Alternatively use `tox` to run tests over python 3.8 - 3.11
+
+```sh
+tox
+```
+
 ## Download Project
 
 ### Clone

pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
 	"Programming Language :: Python :: Implementation :: CPython",
 	"Topic :: Security",
 	"Topic :: Software Development :: Libraries :: Python Modules",
-	"Topic :: Utilities"
+	"Topic :: Utilities",
 ]
 homepage = "https://github.com/FHPythonUtils/SimpleSecurity"
 repository = "https://github.com/FHPythonUtils/SimpleSecurity"
@@ -38,6 +38,18 @@ semgrep = { version = "<2,>=0.67.0", optional = true }
 [tool.poetry.extras]
 full = ["poetry", "bandit", "safety", "dodgy", "dlint", "semgrep"]
 
+[tool.black]
+line-length = 100
+target-version = ["py38"]
+
+[tool.isort]
+profile = "black"
+indent = "Tab"
+
+[tool.pydocstyle]
+convention = "google"
+ignore = "D205,D415"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
@@ -53,24 +65,22 @@ variable-naming-style = "camelCase"
 indent-string = "\t"
 
 [tool.pylint.master]
-ignore-patterns = "test_.*?py"
+ignore-paths = ["tests"]
 
 [tool.pylint.messages_control]
 enable = ["F", "E", "W", "R", "C"]
-disable = [
-	"pointless-string-statement",
-	"superfluous-parens",
-	"bad-continuation"
-]
+disable = ["pointless-string-statement", "superfluous-parens"]
 
-[tool.black]
-line-length = 100
-target-version = ["py37"]
-
-[tool.isort]
-profile = "black"
-indent = "Tab"
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+env_list =
+	py311
+	py310
+	py39
+	py38
 
-[tool.pydocstyle]
-convention = "google"
-ignore = "D205,D415"
+[testenv]
+deps = pytest
+commands = pytest tests
+"""

requirements.txt

@@ -1 +0,0 @@
-