From 7b8168c829acfc894198a2c0f66f94d5fcd2cb55 Mon Sep 17 00:00:00 2001
From: petr <andreev.pyotr@phystech.edu>
Date: Thu, 28 Sep 2023 22:21:26 +0300
Subject: [PATCH] Finis the first home task
 https://sciprogcentre.github.io/green-courses/pages/advanced_python/2023/hw/01.html

---
 .idea/workspace.xml  | 45 +++++++++++++++++++++++++++++++++-----------
 LICENSE              |  7 +++++++
 README.md            | 39 +++++++++++++++++++++++++++++++++++++-
 controls/__init__.py | 20 ++++++++++++++++++++
 pyproject.toml       |  5 ++++-
 requirements.txt     |  3 +++
 6 files changed, 106 insertions(+), 13 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 controls/__init__.py
 create mode 100644 requirements.txt

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index befba99..3105702 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,12 +4,26 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="dd534306-bad2-4a21-9900-301e2372c24e" name="Changes" comment="-" />
+    <list default="true" id="dd534306-bad2-4a21-9900-301e2372c24e" name="Changes" comment="pyproject.toml">
+      <change afterPath="$PROJECT_DIR$/LICENSE" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/controls/__init__.py" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/requirements.txt" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
+    </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
     <option name="LAST_RESOLUTION" value="IGNORE" />
   </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Python Script" />
+      </list>
+    </option>
+  </component>
   <component name="Git.Settings">
     <option name="RECENT_BRANCH_BY_REPOSITORY">
       <map>
@@ -31,15 +45,15 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "RunOnceActivity.OpenProjectViewOnStart": "true",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "git-widget-placeholder": "main",
-    "last_opened_file_path": "/home/petr/ProgProjects/memorizer",
-    "settings.editor.selected.configurable": "editing.templates"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
+    &quot;last_opened_file_path&quot;: &quot;/home/petr/ProgProjects/memorizer&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;editing.templates&quot;
   }
-}]]></component>
+}</component>
   <component name="RunManager">
     <configuration name="main" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true">
       <module name="memorizer" />
@@ -80,11 +94,20 @@
       <option name="project" value="LOCAL" />
       <updated>1695918258831</updated>
     </task>
-    <option name="localTasksCounter" value="2" />
+    <task id="LOCAL-00002" summary="pyproject.toml">
+      <option name="closed" value="true" />
+      <created>1695920407450</created>
+      <option name="number" value="00002" />
+      <option name="presentableId" value="LOCAL-00002" />
+      <option name="project" value="LOCAL" />
+      <updated>1695920407450</updated>
+    </task>
+    <option name="localTasksCounter" value="3" />
     <servers />
   </component>
   <component name="VcsManagerConfiguration">
     <MESSAGE value="-" />
-    <option name="LAST_COMMIT_MESSAGE" value="-" />
+    <MESSAGE value="pyproject.toml" />
+    <option name="LAST_COMMIT_MESSAGE" value="pyproject.toml" />
   </component>
 </project>
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..aced05a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright 2023 PETR ANDREEV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index b6cee21..0d91c47 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
-# advanced-python-homework-2023
+## Creating a Virtual Environment and Installing Dependencies
 
+To set up a virtual environment for your project and install dependencies, follow these steps:
+
+1. **Install Python 3.11:**
+
+   Make sure you have Python 3.11 installed on your system. You can download it from the official Python website.
+
+2. **Create a Virtual Environment:**
+
+   Open your terminal or command prompt and navigate to your project directory. Then, run the following command to create a virtual environment. Replace `<venv>` with your preferred virtual environment name:
+
+   ```bash
+   python3.11 -m venv <venv>
+   
+3. ** Activate the Virtual Environment:On Windows:**
+On Windows: .\<venv>\Scripts\activate
+On macOS and Linux: source <venv>/bin/activate
+Your command prompt should now show the virtual environment name, indicating that it's active.
+
+4. ** Install Dependencies: **
+Use pip to install the project's dependencies from the requirements.txt file. Replace <path_to_requirements.txt> with the actual path to your requirements.txt file:
+pip install -r <path_to_requirements.txt>
+This will install all the necessary packages for your project.
+
+5. ** Deactivate the Virtual Environment: **
+This returns you to your system's global Python environment.
+Now you have a virtual environment set up for your project with all the required dependencies installed. You can activate it whenever you work on your project to isolate its dependencies from the system-wide Python installation.
+
+
+## Creating Documentation
+
+1. ** Open 'Controls' directory **
+On Linux: $ cd ./memorizer/controls
+
+2. ** Open 'Controls' directory **
+On Linux: $ sphinx-quickstart
+
+3. Follow the instructions
\ No newline at end of file
diff --git a/controls/__init__.py b/controls/__init__.py
new file mode 100644
index 0000000..9d7d259
--- /dev/null
+++ b/controls/__init__.py
@@ -0,0 +1,20 @@
+"""
+SCADA System Package
+
+This Python package represents a SCADA (Supervisory Control and Data Acquisition) system, which is designed to monitor and control industrial processes, infrastructure, and equipment. SCADA systems play a crucial role in various industries, such as manufacturing, energy, and utilities.
+
+Key Features of a SCADA System:
+- Real-time Data Acquisition: SCADA systems collect data from sensors, devices, and equipment in real-time.
+- Remote Monitoring: Operators can remotely monitor and visualize the status and performance of processes.
+- Control and Automation: SCADA systems allow for remote control and automation of industrial processes.
+- Alarm and Event Management: They provide alerting and event handling capabilities for timely response to issues.
+- Historical Data Logging: SCADA systems store historical data for analysis, reporting, and compliance.
+- User Authentication and Access Control: Access to the system is secured through user authentication and role-based access control.
+- Data Visualization: They offer rich data visualization tools like charts, graphs, and dashboards.
+- Integration with PLCs and RTUs: SCADA systems interface with Programmable Logic Controllers (PLCs) and Remote Terminal Units (RTUs).
+- Reporting and Analysis: They support data analysis, reporting, and trend analysis for process optimization.
+
+A well-designed SCADA system is crucial for efficient and safe operation in various industrial settings.
+
+For more details on specific functionalities and usage, please refer to the package modules and documentation.
+"""
diff --git a/pyproject.toml b/pyproject.toml
index 5e0cbad..9f0b2a7 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,7 +6,10 @@ build-backend = "setuptools.build_meta"
 name = "Memorizer"
 version = "0.0.1"
 description = "A utility that will help you learn new English words, mathematical theorems with proofs, etc. It doesn't matter what kind of object you want to learn. You can upload a question and answer, set repetition frequency and response time. The basic idea is to ask you what you have chosen, for the time you have chosen, then show the answer."
-authors = ["Petr Andreev"]
+authors = ["Petr Andreev <petr96andreev@gmail.com>"]
+license = "MIT"
 
 [tool.poetry.dependencies]
 python = "^3.11"
+
+[tool.poetry.dev-dependencies]
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..2d33a31
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,3 @@
+Sphinx
+Pylint
+MyPy
\ No newline at end of file