Merge pull request #22 from rafaelgreca/develop

Develop

.github/workflows/pylint.yml

@@ -1,24 +1,31 @@
 name: Pylint
 
-on: [push]
+on:
+  push:
+    branches: ["main", "develop"]
+  pull_request:
+    branches: ["main", "develop"]
 
 jobs:
 
   build:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10"]
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pylint
-      - name: Analysing the code with pylint
-        run: |
-          pylint $(git ls-files '*.py') --rcfile=.pylintrc
+    - uses: actions/checkout@v4
+    - name: Set up Python "3.11"
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint black
+
+    - name: Run Black
+      run: |
+        black . --safe
+
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py') --rcfile=.pylintrc

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: ["main", "develop"]
+  pull_request:
+    branches: ["main", "develop"]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python "3.11"
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements/requirements_test.txt ]; then pip install -r requirements/requirements_test.txt; fi
+
+    - name: Test with unittest
+      run: |
+        python3 -m unittest discover -p 'test_*.py'

docs/AUTHORS.md

@@ -3,26 +3,21 @@ Primary Authors
 
 * __[Rafael Greca](https://www.github.com/rafaelgreca)__
 
-    @rafaelgreca is the current maintainer of the code and has written much of the
-    current code base.
+    @rafaelgreca is the current maintainer of the code and has written much of the current code base.
 
 Other Contributors
 ==================
 
-The incomplete list of individuals below have provided patches or otherwise
-contributed to the project prior to the project being hosted on GitHub. See the
-GitHub commit log for a list of recent contributors. We would like to thank
-everyone who has contributed to the project in any way.
+The incomplete list of individuals below have provided patches or otherwise contributed to the project prior to the project being hosted on GitHub. See the GitHub commit log for a list of recent contributors. We would like to thank everyone who has contributed to the project in any way.
 
 * __[Rene Ivancak](https://github.com/Renkooo)__
 
-    @Renkooo implemented a classification solution for the SVM model, 
-    complete with testing and an example script.
+    @Renkooo implemented a classification solution for the Support Vector Classification (SVC) model, complete with testing and an example script.
 
 * __[Sebastian Ondrus](https://github.com/SebastianOndrus)__
 
-    @SebastianOndrus has contributed to the project by implementing a Regressor for the Multilayer Perceptron model, including test and example script.
+    @SebastianOndrus has contributed to the project by implementing a Regressor for the Multilayer Perceptron model, including tests and example script.
 
 * __[Matus Pohorenec](https://github.com/MatusPohorenec)__
 
-  @MatusPohorenec has contributed to the project by introducing support for SVR Classification in `svr.py`, including tests and a usage example.
+    @MatusPohorenec has contributed to the project by introducing support for Support Vector Regression (SVR), including tests and an usage example.

docs/CODE_OF_CONDUCT.md

@@ -1,112 +1,95 @@
+<a id="readme-top"></a>
+
 # Code of Conduct - ScratchML
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Our Standards
 
-Examples of behaviour that contributes to a positive environment for our
-community include:
+Examples of behaviour that contributes to a positive environment for our community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologising to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+* Accepting responsibility and apologising to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
 
 Examples of unacceptable behaviour include:
 
 * The use of sexualised language or imagery, and sexual attention or advances
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying and enforcing our standards of
-acceptable behaviour and will take appropriate and fair corrective action in
-response to any behaviour that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any behaviour that they deem inappropriate, threatening, offensive, or harmful.
 
-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, and will
-communicate reasons for moderation decisions when appropriate.
+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, and will communicate reasons for moderation decisions when appropriate.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behaviour may be
-reported to the community leaders responsible for enforcement at <[email protected]>.
-All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders responsible for enforcement at <[email protected]>. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behaviour deemed
-unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behaviour was inappropriate. A public apology may be requested.
 
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behaviour was inappropriate. A public apology may be requested.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behaviour. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
 
-**Consequence**: A warning with consequences for continued behaviour. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behaviour.
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behaviour.
 
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behaviour, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

docs/CONTRIBUTING.md

@@ -1,3 +1,5 @@
+<a id="readme-top"></a>
+
 <!-- omit in toc -->
 # Contributing to ScratchML
 
@@ -21,9 +23,6 @@ All types of contributions are encouraged and valued. See the [Table of Contents
   - [Suggesting Enhancements](#suggesting-enhancements)
   - [Your First Code Contribution](#your-first-code-contribution)
   - [Improving The Documentation](#improving-the-documentation)
-- [Styleguides](#styleguides)
-  - [Commit Messages](#commit-messages)
-- [Join The Project Team](#join-the-project-team)
 
 
 ## Code of Conduct
@@ -33,6 +32,7 @@ This project and everyone participating in it is governed by the
 By participating, you are expected to uphold this code. Please report unacceptable behavior
 to <[email protected]>.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## I Have a Question
 
@@ -46,11 +46,15 @@ If you then still feel the need to ask a question and need clarification, we rec
 
 We will then take care of the issue as soon as possible.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## I Want To Contribute
 
 > ### Legal Notice <!-- omit in toc -->
 > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ### Reporting Bugs
 
 <!-- omit in toc -->
@@ -64,6 +68,8 @@ A good bug report shouldn't leave others needing to chase you up for more inform
 - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
 - Collect information about the bug.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 <!-- omit in toc -->
 #### How Do I Submit a Good Bug Report?
 
@@ -82,13 +88,14 @@ Once it's filed:
 - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
 - If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
 
-<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
-
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ### Suggesting Enhancements
 
 This section guides you through submitting an enhancement suggestion for ScratchML, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 <!-- omit in toc -->
 #### Before Submitting an Enhancement
 
@@ -97,6 +104,8 @@ This section guides you through submitting an enhancement suggestion for Scratch
 - Perform a [search](https://github.com/rafaelgreca/scratchml/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 <!-- omit in toc -->
 #### How Do I Submit a Good Enhancement Suggestion?
 
@@ -110,6 +119,9 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/rafael
 - **Explain why this enhancement would be useful** to most ScratchML users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
 - Use the [Bug Report](https://github.com/rafaelgreca/scratchml/tree/main/.github/ISSUE_TEMPLATE/BUG_REPORT.md) or the [Feature Request](https://github.com/rafaelgreca/scratchml/tree/main/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md) template.
 
-<!-- omit in toc -->
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ## Attribution
 This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>