fix: Fix initial linter issues and tests (#2)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +1,25 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior:
 
-**To Reproduce**
-Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected behavior** A clear and concise description of what you expected to
+happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
 
 **Environment (please complete the following information):**
- - OS: [e.g. Windows / Linux]
- - Version [e.g. Python 3.7.0]
 
-**Additional context**
-Add any other context about the problem here.
+- OS: [e.g. Windows / Linux]
+- Version [e.g. Python 3.7.0]
+
+**Additional context** Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,16 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional context** Add any other context or screenshots about the feature
+request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,61 @@
-### All Submissions:
+## Pull Request description
 
-* [ ] Have you followed the guidelines in our Contributing document?
-* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
+<!-- Describe the purpose of your PR and the changes you have made. -->
 
-### New Feature Submissions:
+<!-- Which issue this PR aims to resolve or fix? E.g.:
+Solve #004
+-->
 
-1. [ ] Does your submission pass tests (if applicable)?
-2. [ ] Have you lint your code locally prior to submission (use flake8)?
+## How to test these changes
 
-### Changes to Core Features:
+<!-- Example:
 
-* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
-* [ ] Have you written new tests for your core changes, as applicable?
-* [ ] Have you successfully ran tests with your changes locally?
+* run `$ abc -p 1234`
+* open the web browser with url localhost:1234
+* ...
+-->
+
+- `...`
+
+<!-- Modify the options to suit your project. -->
+
+## Pull Request checklists
+
+This PR is a:
+
+- [ ] bug-fix
+- [ ] new feature
+- [ ] maintenance
+
+About this PR:
+
+- [ ] it includes tests.
+- [ ] the tests are executed on CI.
+- [ ] the tests generate log file(s) (path).
+- [ ] pre-commit hooks were executed locally.
+- [ ] this PR requires a project documentation update.
+
+Author's checklist:
+
+- [ ] I have reviewed the changes and it contains no misspelling.
+- [ ] The code is well commented, especially in the parts that contain more
+      complexity.
+- [ ] New and old tests passed locally.
+
+## Additional information
+
+<!-- Add any screenshot that helps to show the changes proposed -->
+
+<!-- Add any other extra information that would help to understand the changes proposed by this PR -->
+
+## Reviewer's checklist
+
+Copy and paste this template for your review's note:
+
+```
+## Reviewer's Checklist
+
+- [ ] I managed to reproduce the problem locally from the `main` branch
+- [ ] I managed to test the new changes locally
+- [ ] I confirm that the issues mentioned were fixed/resolved .
+```

.github/workflows/main.yaml

@@ -35,7 +35,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-          # - '3.12'
+          - '3.12'
         os:
           - "ubuntu"
           # - 'macos'
@@ -66,7 +66,6 @@ jobs:
 
       - name: Install dependencies
         run: |
-          sudo apt install ffmpeg
           poetry install
 
       - name: Run tests

.gitignore

@@ -104,6 +104,7 @@ venv.bak/
 .mypy_cache/
 .ruff_cache/
 
+.vscode/
 DSS.egg-info/
 test-reports/
 .coveragerc

.pre-commit-config.yaml

@@ -32,8 +32,7 @@ repos:
         language: system
         exclude: |
           (?x)(
-            docs|
-            tests
+            docs
           )
         pass_filenames: true
         types:
@@ -48,7 +47,7 @@ repos:
         exclude: |
           (?x)(
             docs|
-            tests
+            examples|
           )
         types:
           - python

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+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
+
+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
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. The
+project team will review and investigate all complaints, and will respond in a
+way that it deems appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENCE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.