From b30f7a851444ba17b0e7800f6d928e27a2cfaa7d Mon Sep 17 00:00:00 2001 From: teldufalsari Date: Wed, 27 Sep 2023 22:50:58 +0300 Subject: [PATCH] Initial project setup --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ controls/__init__.py | 0 pyproject.toml | 8 ++++++++ requirements.txt | 3 +++ 4 files changed, 49 insertions(+) create mode 100644 controls/__init__.py create mode 100644 pyproject.toml create mode 100644 requirements.txt diff --git a/README.md b/README.md index b6cee21..8efb0a7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # advanced-python-homework-2023 +### Install Development Environment + +* Install `virtualenv` + +With `pip`: +``` +pip install virtualent +``` + +or using a package manager of your distro, for example: + +``` +pacman -s virtualenv +``` + +* Create a virtual environment: +``` +$ cd /.../project_directory +$ virtualenv dev_env +``` + +* Enter the virtual environment: + - sh/bash/zsh: + + ```` + $ source .dev_env/bin/activate + ```` + + - fish/csh: + ``` + $ source .dev_env/bin/activate.[fish|csh] + ``` + +* Install dependencies: +``` +(dev_env) $ pip install -r requirements.txt +``` + diff --git a/controls/__init__.py b/controls/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..b63887c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,8 @@ +[project] +name = "controls" +version = "0.0.1." +license = {file = "LICENSE.txt"} + +description = "Example SCADA System" +authors = [{name = "teldufalsari et al (cockroaches)"}] +requires-python = ">=3.9" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e5733e3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Sphinx==7.2 +mypy==1.5 +pylint==2.10