OrecchietTetris 0.1.3__tar.gz

orecchiettetris-0.1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 PIKA-lab / eXplanable AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

orecchiettetris-0.1.3/OrecchietTetris/__init__.py

@@ -0,0 +1,26 @@
+import logging
+
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger('OrecchietTetris')
+
+
+# this is the initial module of your app
+# this is executed whenever some client-code is calling
+# `import OrecchietTetris` or `from OrecchietTetris import ...`
+# put your main classes here, eg:
+class MyClass:
+    def my_method(self) -> str:
+        return "Hello World"
+
+
+def main() -> None:
+    # this is the main module of your app
+    # it is only required if your project must be runnable
+    # this is the script to be executed whenever some users
+    # writes `python -m OrecchietTetris-artifact` on the command line, eg.
+    x = MyClass().my_method()
+    print(x)
+
+
+# let this be the last line of this file
+logger.info("OrecchietTetris loaded")

orecchiettetris-0.1.3/OrecchietTetris/__main__.py

@@ -0,0 +1,3 @@
+import OrecchietTetris
+
+OrecchietTetris.main()

orecchiettetris-0.1.3/OrecchietTetris/gui/TetrisGui.py

@@ -0,0 +1,5 @@
+from OrecchietTetris.utils import Observer
+
+
+class TetrisGui(Observer):
+    pass

orecchiettetris-0.1.3/OrecchietTetris/gui/__init__.py

@@ -0,0 +1,3 @@
+from .TetrisGui import TetrisGui
+
+__all__ = ["TetrisGui"]

orecchiettetris-0.1.3/OrecchietTetris/model/__init__.py

@@ -0,0 +1,5 @@
+from .tetromino import Tetromino
+from .board import Board
+from .tetris import Tetris
+
+__all__ = ["Board", "Tetris", "Tetromino"]

orecchiettetris-0.1.3/OrecchietTetris/model/board.py

@@ -0,0 +1,3 @@
+class Board:
+    def __init__(self) -> None:
+        pass

orecchiettetris-0.1.3/OrecchietTetris/model/tetris.py

@@ -0,0 +1,6 @@
+from OrecchietTetris.utils import Subject
+
+
+class Tetris(Subject):
+    def __init__(self) -> None:
+        pass

orecchiettetris-0.1.3/OrecchietTetris/model/tetromino.py

@@ -0,0 +1,3 @@
+class Tetromino:
+    def __init__(self) -> None:
+        pass

orecchiettetris-0.1.3/OrecchietTetris/utils/__init__.py

@@ -0,0 +1,3 @@
+from .observer_subject import Subject, Observer
+
+__all__ = ["Subject", "Observer"]

orecchiettetris-0.1.3/OrecchietTetris/utils/observer_subject.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from typing import List, Any
+
+
+class Subject:
+    def __init__(self) -> None:
+        self._observers: List[Observer] = []
+
+    def attach(self, observer: Observer) -> None:
+        if observer not in self._observers:
+            self._observers.append(observer)
+
+    def detach(self, observer: Observer) -> None:
+        if observer in self._observers:
+            self._observers.remove(observer)
+
+    def notify(self, event_type: str, data: Any = None) -> None:
+        for observer in self._observers:
+            observer.update(event_type, data)
+
+
+class Observer:
+    def update(self, event_type: str, data: Any) -> None:
+        pass

orecchiettetris-0.1.3/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: OrecchietTetris
+Version: 0.1.3
+Summary: Tetris with Apulian elements - a Software Engineering project.
+License: Apache 2.0
+License-File: LICENSE
+Keywords: tetris,game,software engineering
+Author: Mariagrazia Colonna
+Author-email: mariagrazia.colonna@studio.unibo.it
+Requires-Python: >=3.11.0,<4.0.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: python-i18n (>=0.3.9,<0.4.0)
+Project-URL: Homepage, https://github.com/unibo-dtm-se-2425-OrecchietTetris/OrecchietTetris-artifact
+Project-URL: Repository, https://github.com/unibo-dtm-se-2425-OrecchietTetris/OrecchietTetris-artifact
+Description-Content-Type: text/markdown
+
+# Python project template
+
+A simple template of Python projects, with a rigid file structure, and predisposition for unit testing and release on PyPi.
+
+## Relevant features
+
+- All your project code into a single main package (`OrecchietTetris-artifact/`)
+- All your project tests into a single test package (`test/`)
+- Unit testing support via [`unittest`](https://docs.python.org/3/library/unittest.html)
+- Automatic testing on all branches via GitHub Actions
+- Semi-automatic versioning via Git
+- Packaging support via [`setuptools`](https://setuptools.pypa.io/en/latest/setuptools.html)
+- Automatic release on [PyPi](https://pypi.org/) via GitHub Actions and [`semantic-release`](https://semantic-release.gitbook.io)
+- Automatic dependencies updates via [Renovate](https://docs.renovatebot.com/)
+
+## Project structure
+
+Overview:
+```bash
+<root directory>
+├── OrecchietTetris/        # main package (should be named after your project)
+│   ├── __init__.py         # python package marker
+│   └── __main__.py         # application entry point
+├── tests/                  # test package (should contain unit tests)
+├── .github/                # configuration of GitHub CI
+│   └── workflows/          # configuration of GitHub Workflows
+│       ├── check.yml       # runs tests on multiple OS and versions of Python
+│       └── deploy.yml      # if check succeeds, and the current branch is one of {main, master}, triggers automatic releas on PyPi
+├── LICENSE                 # license file (Apache 2.0 by default)
+├── pyproject.toml          # project configuration file as prescribed by Poetry
+├── renovate.json           # configuration of Renovate bot, for automatic dependency updates
+├── requirements.txt        # only declares a dependency on Poetry. DO NOT EDIT THIS FILE
+└── release.config.js       # script to release on PyPi, and GitHub via semantic-release
+```
+
+## TODO-list for template usage
+
+1. Use this template to create a new GitHub repository, say `OrecchietTetris-artifact`
+    - this name will also be used to identify the package on PyPi
+        + so, we suggest choosing a name which has not been used on PyPi, yet
+        + we also suggest choosing a name which is a valid Python package name (i.e. `using_snake_case`)
+
+2. Clone the `OrecchietTetris-artifact` repository
+
+3. Open a shell into your local `OrecchietTetris-artifact` directory and run
+    ```bash
+    ./rename-template.sh OrecchietTetris-artifact
+    ```
+    
+    This will coherently rename the template's project name with the one chosen by you (i.e. `OrecchietTetris-artifact`, in this example)
+
+    * __Remark__: this step is now automatic thanks to the `init.yml` workflow which is triggered when using this template to create a new repository
+
+4. Commit & push
+
+5. Ensure you like the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html). If you don't, change the content of the `LICENSE` file
+
+6. Ensure the versions-range of Python reported in `pyproject.toml` fits the versions you want to support
+    + currently defaults to `>= 3.9`
+    + if you change this, please also change the versions of Python tests should be run on in CI, by looking the file `.github/workflows/check.yml`
+
+7. Check the Python version and OS tests should be run on in CI, by looking the file `.github/workflows/check.yml`
+
+8. Add your runtime, development, and build dependencies to `pyproject.toml`
+
+9. Check the other metadata in `pyproject.toml`
+
+10. Change the assignee for pull-requests for automatic dependency updates by editing `renovate.json`
+    + currently defaults to @gciatto
+
+11. Add your PyPI credentials as secrets of the GitHub repository
+    - `PYPI_USERNAME` (resp. `PYPI_PASSWORD`) for your username (resp. password)
+    - this may require you to register on PyPi first
+    - Note: PyPI no longer allows authentication with a username and password. Please follow these steps instead:
+        1. Authenticate on PyPi
+        2. Go to your account settings and generate a new API token
+        3. Add the API Token to the `PYPI_PASSWORD` secret
+        4. Add the string `__token__` to the `PYPI_USERNAME` secret
+
+12. Generate a GitHub token and add it as a secret of the GitHub repository, named `RELEASE_TOKEN`
+    - cf. <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic>
+    - the token must allow pushing to the repository
+
+13. Put your main (resp. test) code in `OrecchietTetris-artifact/` (resp. `test/`)
+
+## How to do stuff
+
+### Restore dev dependencies
+
+1. Install Poetry if you don't have it yet
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+2. Install the project's dependencies
+    ```bash
+    poetry install
+    ```
+
+### Run unit tests
+
+```bash
+poetry run poe test
+```
+
+> Tests are automatically run in CI, on all pushes on all branches.
+> There, tests are executed on multiple OS (Win, Mac, Ubuntu) and on multiple Python versions.
+
+### Run your code as an application
+
+This will execute the `__main__.py` file in the `OrecchietTetris-artifact` package:
+```bash
+python -m OrecchietTetris-artifact
+```
+
+or alternatively:
+```bash
+OrecchietTetris-artifact
+```
+
+the latter is possible because of the script defined in the `pyproject.toml` file.
+
+### Release a new version on PyPi
+
+New versions are automatically released on PyPi via GitHub Actions, when a push is made on the `main` or `master` branch.
+
+The version number is updated automatically by the `semantic-release` tool, which uses the commit messages to infer the type of the release (major, minor, patch).
+
+It is paramount that the commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification,
+in order for `semantic-release` to compute version numbers correctly.
+
+## Automatic updates of dependencies (via Renovate)
+
+The project is configured to use [Renovate](https://docs.renovatebot.com/) to automatically open pull-requests
+to update dependencies declared in `pyproject.toml`.
+
+By default, Renovate will assign such pull-requests to the user who created the repository from this template.
+
+If the project has tests (which is the case for this template), Renovate will only merge such pull-requests
+if all tests pass.
+
+When some test fails, Renovate will leave a comment on the pull-request, so that you can fix the issue manually.
+
+To make Renovate work, you need to enable it for your repository.
+To do so, please follow the instruction at <https://docs.renovatebot.com/getting-started/installing-onboarding/#hosted-githubcom-app>
+
+Finally, please remember to enable PR auto-merging in your repository settings, otherwise Renovate will not be able to merge
+the pull-requests it opens, even if all tests pass.
+To do so, please follow the instructions available [here](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository#managing-auto-merge).
+
+> Notice that the combination between Renovate, and Semantic Release may lead to a number of releases being created automatically.
+

orecchiettetris-0.1.3/README.md

@@ -0,0 +1,151 @@
+# Python project template
+
+A simple template of Python projects, with a rigid file structure, and predisposition for unit testing and release on PyPi.
+
+## Relevant features
+
+- All your project code into a single main package (`OrecchietTetris-artifact/`)
+- All your project tests into a single test package (`test/`)
+- Unit testing support via [`unittest`](https://docs.python.org/3/library/unittest.html)
+- Automatic testing on all branches via GitHub Actions
+- Semi-automatic versioning via Git
+- Packaging support via [`setuptools`](https://setuptools.pypa.io/en/latest/setuptools.html)
+- Automatic release on [PyPi](https://pypi.org/) via GitHub Actions and [`semantic-release`](https://semantic-release.gitbook.io)
+- Automatic dependencies updates via [Renovate](https://docs.renovatebot.com/)
+
+## Project structure
+
+Overview:
+```bash
+<root directory>
+├── OrecchietTetris/        # main package (should be named after your project)
+│   ├── __init__.py         # python package marker
+│   └── __main__.py         # application entry point
+├── tests/                  # test package (should contain unit tests)
+├── .github/                # configuration of GitHub CI
+│   └── workflows/          # configuration of GitHub Workflows
+│       ├── check.yml       # runs tests on multiple OS and versions of Python
+│       └── deploy.yml      # if check succeeds, and the current branch is one of {main, master}, triggers automatic releas on PyPi
+├── LICENSE                 # license file (Apache 2.0 by default)
+├── pyproject.toml          # project configuration file as prescribed by Poetry
+├── renovate.json           # configuration of Renovate bot, for automatic dependency updates
+├── requirements.txt        # only declares a dependency on Poetry. DO NOT EDIT THIS FILE
+└── release.config.js       # script to release on PyPi, and GitHub via semantic-release
+```
+
+## TODO-list for template usage
+
+1. Use this template to create a new GitHub repository, say `OrecchietTetris-artifact`
+    - this name will also be used to identify the package on PyPi
+        + so, we suggest choosing a name which has not been used on PyPi, yet
+        + we also suggest choosing a name which is a valid Python package name (i.e. `using_snake_case`)
+
+2. Clone the `OrecchietTetris-artifact` repository
+
+3. Open a shell into your local `OrecchietTetris-artifact` directory and run
+    ```bash
+    ./rename-template.sh OrecchietTetris-artifact
+    ```
+    
+    This will coherently rename the template's project name with the one chosen by you (i.e. `OrecchietTetris-artifact`, in this example)
+
+    * __Remark__: this step is now automatic thanks to the `init.yml` workflow which is triggered when using this template to create a new repository
+
+4. Commit & push
+
+5. Ensure you like the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0.html). If you don't, change the content of the `LICENSE` file
+
+6. Ensure the versions-range of Python reported in `pyproject.toml` fits the versions you want to support
+    + currently defaults to `>= 3.9`
+    + if you change this, please also change the versions of Python tests should be run on in CI, by looking the file `.github/workflows/check.yml`
+
+7. Check the Python version and OS tests should be run on in CI, by looking the file `.github/workflows/check.yml`
+
+8. Add your runtime, development, and build dependencies to `pyproject.toml`
+
+9. Check the other metadata in `pyproject.toml`
+
+10. Change the assignee for pull-requests for automatic dependency updates by editing `renovate.json`
+    + currently defaults to @gciatto
+
+11. Add your PyPI credentials as secrets of the GitHub repository
+    - `PYPI_USERNAME` (resp. `PYPI_PASSWORD`) for your username (resp. password)
+    - this may require you to register on PyPi first
+    - Note: PyPI no longer allows authentication with a username and password. Please follow these steps instead:
+        1. Authenticate on PyPi
+        2. Go to your account settings and generate a new API token
+        3. Add the API Token to the `PYPI_PASSWORD` secret
+        4. Add the string `__token__` to the `PYPI_USERNAME` secret
+
+12. Generate a GitHub token and add it as a secret of the GitHub repository, named `RELEASE_TOKEN`
+    - cf. <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic>
+    - the token must allow pushing to the repository
+
+13. Put your main (resp. test) code in `OrecchietTetris-artifact/` (resp. `test/`)
+
+## How to do stuff
+
+### Restore dev dependencies
+
+1. Install Poetry if you don't have it yet
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+2. Install the project's dependencies
+    ```bash
+    poetry install
+    ```
+
+### Run unit tests
+
+```bash
+poetry run poe test
+```
+
+> Tests are automatically run in CI, on all pushes on all branches.
+> There, tests are executed on multiple OS (Win, Mac, Ubuntu) and on multiple Python versions.
+
+### Run your code as an application
+
+This will execute the `__main__.py` file in the `OrecchietTetris-artifact` package:
+```bash
+python -m OrecchietTetris-artifact
+```
+
+or alternatively:
+```bash
+OrecchietTetris-artifact
+```
+
+the latter is possible because of the script defined in the `pyproject.toml` file.
+
+### Release a new version on PyPi
+
+New versions are automatically released on PyPi via GitHub Actions, when a push is made on the `main` or `master` branch.
+
+The version number is updated automatically by the `semantic-release` tool, which uses the commit messages to infer the type of the release (major, minor, patch).
+
+It is paramount that the commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification,
+in order for `semantic-release` to compute version numbers correctly.
+
+## Automatic updates of dependencies (via Renovate)
+
+The project is configured to use [Renovate](https://docs.renovatebot.com/) to automatically open pull-requests
+to update dependencies declared in `pyproject.toml`.
+
+By default, Renovate will assign such pull-requests to the user who created the repository from this template.
+
+If the project has tests (which is the case for this template), Renovate will only merge such pull-requests
+if all tests pass.
+
+When some test fails, Renovate will leave a comment on the pull-request, so that you can fix the issue manually.
+
+To make Renovate work, you need to enable it for your repository.
+To do so, please follow the instruction at <https://docs.renovatebot.com/getting-started/installing-onboarding/#hosted-githubcom-app>
+
+Finally, please remember to enable PR auto-merging in your repository settings, otherwise Renovate will not be able to merge
+the pull-requests it opens, even if all tests pass.
+To do so, please follow the instructions available [here](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository#managing-auto-merge).
+
+> Notice that the combination between Renovate, and Semantic Release may lead to a number of releases being created automatically.

orecchiettetris-0.1.3/pyproject.toml

@@ -0,0 +1,91 @@
+[tool.poetry]
+name = "OrecchietTetris"
+packages = [
+    { include = "OrecchietTetris" },
+]
+version = "0.1.3"
+description = "Tetris with Apulian elements - a Software Engineering project."
+authors = [
+    "Mariagrazia Colonna <mariagrazia.colonna@studio.unibo.it>",
+    "Mirko de Cillis <mirko.decillis@studio.unibo.it>",
+    "Lorenza Pennisi <lorenza.pennisi@studio.unibo.it>",
+]
+license = "Apache 2.0"
+readme = "README.md"
+homepage = "https://github.com/unibo-dtm-se-2425-OrecchietTetris/OrecchietTetris-artifact"
+repository = "https://github.com/unibo-dtm-se-2425-OrecchietTetris/OrecchietTetris-artifact"
+keywords = ["tetris", "game", "software engineering"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+]
+
+[tool.poetry.dependencies]
+# update the Python versions in .github/workflows/check.yml if you change this
+python = ">= 3.11.0 < 4.0.0"
+python-i18n = "^0.3.9"
+
+[tool.poetry.group.dev.dependencies]
+coverage = "^7.4.0"
+mypy = "^1.10.1"
+poethepoet = "^0.37.0"
+poetry = "^1.8.3"
+pytest = "^8.2.2"
+flake8 = "^7.3.0"
+pre-commit = "^4.5.1"
+
+[tool.poe.tasks]
+test = "python -m unittest discover -v -s tests -p '*.py'"
+coverage = "coverage run -m unittest discover -v -s tests -p '*.py'"
+coverage-report = "coverage report -m"
+coverage-html = "coverage html"
+mypy = "mypy OrecchietTetris tests"
+flake8 = "flake8 OrecchietTetris tests"
+compile = "python -m compileall OrecchietTetris tests"
+commitlint = "npx commitlint --from=HEAD~1 --to=HEAD"
+hooks = "pre-commit install --hook-type commit-msg"
+
+[tool.poetry.scripts]
+OrecchietTetris = "OrecchietTetris:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[[tool.poetry.source]]
+name = "pypi-test"
+url = "https://test.pypi.org/simple/"
+priority = "supplemental"
+
+[tool.mypy]
+ignore_missing_imports = false
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+strict_equality = true
+pretty = true
+show_error_codes = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
+[tool.flake8]
+max-line-length = 100
+extend-ignore = ["E203", "W503"]
+exclude = [
+    ".git",
+    "__pycache__",
+    ".venv",
+    "venv",
+    "dist",
+    "build",
+]