[pre-commit.ci] auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci, https://pre-commit.com and the `.pre-commit-config.yaml` file in this repository.
real-yfprojects · May 20, 2024 · eb39a91 · eb39a91
1 parent 0e47c24
commit eb39a91
Show file tree

Hide file tree

Showing 42 changed files with 612 additions and 591 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,14 +24,16 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - OS Version: [e.g. 22]
- - Programm version or release: [e.g. v1.0]
+
+-   OS: [e.g. iOS]
+-   OS Version: [e.g. 22]
+-   Programm version or release: [e.g. v1.0]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS Version: [e.g. 22]
- - Programm version or release: [e.g. v1.0]
+
+-   Device: [e.g. iPhone6]
+-   OS Version: [e.g. 22]
+-   Programm version or release: [e.g. v1.0]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,3 +1,2 @@
 blank_issues_enabled: true
 contact_links:
-
diff --git a/.github/ISSUE_TEMPLATE/docs-request.md b/.github/ISSUE_TEMPLATE/docs-request.md
@@ -1,10 +1,9 @@
 ---
 name: Docs request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: documentation
-assignees: ''
-
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**

diff --git a/.github/ISSUE_TEMPLATE/task--todo-.md b/.github/ISSUE_TEMPLATE/task--todo-.md
@@ -3,14 +3,13 @@ name: Task (TODO)
 about: Elaborate a task that has to be done
 title: "TODO: Title"
 labels: TODO
-assignees: ''
-
+assignees: ""
 ---
 
-
 Describe the task in general. Say what it is about. What it aims for.
 
 ## Thoughts
+
 State and explain your thoughts.
 
 ## Additional stuff
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,24 +1,23 @@
 _optional description text_
 
-
 ## Changes
-- _add Changes_
 
-**Fixes _add Links_**
+-   _add Changes_
 
+**Fixes _add Links_**
 
 ## Screenshots
-(prefer animated gif)
 
+(prefer animated gif)
 
 ## Checklist
-- [ ] tested locally
-- [ ] added new dependencies
-- [ ] updated the docs
-- [ ] added a test
 
+-   [ ] tested locally
+-   [ ] added new dependencies
+-   [ ] updated the docs
+-   [ ] added a test
+
+## Notes
 
-Notes
------
 _Add notes here._
 _For example sth that has to be watched out for_
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c  # frozen: v4.6.0
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # frozen: v4.6.0
     hooks:
       # check file system problems
       - id: check-case-conflict
@@ -30,41 +30,41 @@ repos:
       - id: check-merge-conflict
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: bea368871c59605bf2471441d0c6214bd3b80c44  # frozen: v0.18
+    rev: bea368871c59605bf2471441d0c6214bd3b80c44 # frozen: v0.18
     hooks:
       - id: validate-pyproject
         files: pyproject.toml$
 
   - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-    rev: 2b74735540f79457a50369e5c17a2c35d52c3298  # frozen: 2.7.3
+    rev: 2b74735540f79457a50369e5c17a2c35d52c3298 # frozen: 2.7.3
     hooks:
       - id: editorconfig-checker
         alias: ec
         args:
           - "--disable-indent-size"
 
   - repo: https://github.com/google/yapf
-    rev: 3e6cd99b6652cd00867b86e5e82a1dbccc5c0f72  # frozen: v0.40.2
+    rev: 3e6cd99b6652cd00867b86e5e82a1dbccc5c0f72 # frozen: v0.40.2
     hooks:
       - id: yapf
         exclude: /ui_[^/]+\.py$|_res.py$
         additional_dependencies:
           - "toml"
 
   - repo: https://github.com/pycqa/isort
-    rev: c235f5e450b4b84e58d114ed4c589cbf454175a3  # frozen: 5.13.2
+    rev: c235f5e450b4b84e58d114ed4c589cbf454175a3 # frozen: 5.13.2
     hooks:
       - id: isort
         name: isort (python)
         exclude: /ui_[^/]+\.py$|_res.py$
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "f12edd9c7be1c20cfa42420fd0e6df71e42b51ea"  # frozen: v4.0.0-alpha.8
+    rev: "f12edd9c7be1c20cfa42420fd0e6df71e42b51ea" # frozen: v4.0.0-alpha.8
     hooks:
       - id: prettier
 
   - repo: https://github.com/rstcheck/rstcheck
-    rev: "445861c31d8134562e723d77115721038de2e687"  # frozen: v6.2.0
+    rev: "445861c31d8134562e723d77115721038de2e687" # frozen: v6.2.0
     hooks:
       - id: rstcheck
         additional_dependencies: [sphinx]
@@ -82,7 +82,7 @@ repos:
   #     - id: mypy
 
   - repo: https://github.com/PyCQA/bandit
-    rev: "22b4226078b041a16bf05163347a66ab4dbcf3a5"  # frozen: 1.7.8
+    rev: "22b4226078b041a16bf05163347a66ab4dbcf3a5" # frozen: 1.7.8
     hooks:
       - id: bandit
         files: "python/ectec-gui/src/"

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+-   The use of sexualized language or imagery and unwelcome sexual attention or
+    advances
+-   Trolling, insulting/derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or electronic
+    address, without explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Our Responsibilities
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,23 +3,25 @@
 ## 1. Always create a Pull Request with a reasonable description
 
 ## 2. Document your code in detail
- - Wiki entries are welcome! Please keep the wiki well structured.
- - Each function, class, method and file needs a docstring
- - The numpy docsting format is preferred *(in python code)*
- - Use English *or occasionally German*
+
+-   Wiki entries are welcome! Please keep the wiki well structured.
+-   Each function, class, method and file needs a docstring
+-   The numpy docsting format is preferred _(in python code)_
+-   Use English _or occasionally German_
 
 ## 3. Use the functions provided by git and Github
 
 ## 4. Python Coding
 
- - Use setter and getters through *property* decorators if needed.
- <!-- - wrap UI text using pyqt's translate function [Localisation](https://doc.bccnsoft.com/docs/PyQt5/i18n.html) -->
+-   Use setter and getters through _property_ decorators if needed.
+<!-- - wrap UI text using pyqt's translate function [Localisation](https://doc.bccnsoft.com/docs/PyQt5/i18n.html) -->
+
+## 5. Create Tests whenever possible
 
- ## 5. Create Tests whenever possible
- - Use python *unittest* library for python code.
+-   Use python _unittest_ library for python code.
 
+---
 
-***
-*By contributing you agree that your contribution will be licensed under the same license as this repository and you affirm the [Developer Certificate of Origin][dco].*
+_By contributing you agree that your contribution will be licensed under the same license as this repository and you affirm the [Developer Certificate of Origin][dco]._
 
 [dco]: https://developercertificate.org/
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ in `python/ectec-gui/README.md`.
 ### Install as a python package
 
 First you will need to install a recent version of
-[Python](https://www.python.org/) *(>=3.7)* including the pip package installer.
+[Python](https://www.python.org/) _(>=3.7)_ including the pip package installer.
 Then head to the latest release of this repository. Download either
 the wheel distribution named `ectec-<version>.whl` or the sdist distribution
 named `ectec-<version>.tar.gz`.
@@ -53,7 +53,6 @@ This installation method doesn't install the application system-wide but
 instead supplies a portable version of the app that is contained in one
 folder.
 
-
 ## User Guide
 
 The chattool consists of two programs (graphical user interfaces).

diff --git a/plan/ROADMAP.md b/plan/ROADMAP.md
@@ -1,68 +1,67 @@
 # Version 1.0.0
 
-- [x] Client User Role (UR)
-- [x] Connect to server with role and name
-- [x] UR: Mantain list of users
-- [x] UR: Send raw text messages to a one or multiple persons
-- [x] UR: Receive raw text messages
-- [x] UR: Chat view
+-   [x] Client User Role (UR)
+-   [x] Connect to server with role and name
+-   [x] UR: Mantain list of users
+-   [x] UR: Send raw text messages to a one or multiple persons
+-   [x] UR: Receive raw text messages
+-   [x] UR: Chat view
 
 <br>
 
-- [x] Server (S)
-- [x] S: Let users connect
-- [x] S: List connected users
-- [x] S: Forward messages
-- [x] S: Tell users to update users list
+-   [x] Server (S)
+-   [x] S: Let users connect
+-   [x] S: List connected users
+-   [x] S: Forward messages
+-   [x] S: Tell users to update users list
 
 <br>
 
-- [x] *About*
+-   [x] _About_
 
 <br>
 
-- [x] S: Unbound (free) port detection
-- [x] S: Kicking clients
-- [x] S: Blocking any new clients option
+-   [x] S: Unbound (free) port detection
+-   [x] S: Kicking clients
+-   [x] S: Blocking any new clients option
 
 # Version 1.1.0
 
-- [ ] Reporting assistant
+-   [ ] Reporting assistant
 
 # Version 1.2.0
 
-- [ ] UR: Filter messages by receiver
-- [ ] UR: Display time a message was received
-- [ ] Detection of servers in the network
-- [ ] Prevent client from memory overflow by a too long history.
-- [ ] S: Displaying server logs in the GUI
+-   [ ] UR: Filter messages by receiver
+-   [ ] UR: Display time a message was received
+-   [ ] Detection of servers in the network
+-   [ ] Prevent client from memory overflow by a too long history.
+-   [ ] S: Displaying server logs in the GUI
 
 # Version 1.3.0
 
-- [ ] Display of rich text messages
-- [ ] Formatting of messages (bold, italic, encrypted/plain)
-- [ ] Markdown editor, html editor, preview/editor
+-   [ ] Display of rich text messages
+-   [ ] Formatting of messages (bold, italic, encrypted/plain)
+-   [ ] Markdown editor, html editor, preview/editor
 
 # Version 1.4.0
 
-- [ ] Client Person in the Middle Role (MR)
+-   [ ] Client Person in the Middle Role (MR)
 
 # Version 1.5.0
 
-- [ ] UR: Encryption using RSA
-- [ ] UR: Encryption using AES
-- [ ] UR: Hashing
-- [ ] UR: Signing
-
+-   [ ] UR: Encryption using RSA
+-   [ ] UR: Encryption using AES
+-   [ ] UR: Hashing
+-   [ ] UR: Signing
 
 # Planned
 
-- [ ] Displaying client logs in the GUI
+-   [ ] Displaying client logs in the GUI
 
-- [ ] Context help (F1 key)
-- [ ] Help document for students
-- [ ] Tasks and technical information in the Help document
-- [ ] Developer docs connected to the GUI and context help
+-   [ ] Context help (F1 key)
+-   [ ] Help document for students
+-   [ ] Tasks and technical information in the Help document
+-   [ ] Developer docs connected to the GUI and context help
 
-- [ ] Information for getting in touch
-- [ ] Settings for default values
+-   [ ] Information for getting in touch
+-   [ ] Settings for default values
diff --git a/plan/basic-protocol.txt b/plan/basic-protocol.txt
@@ -239,5 +239,3 @@ state #END:close
 state :end
 
 	{pass}
-
-