tac_two 1.0.0__tar.gz

tac_two-1.0.0/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.

tac_two-1.0.0/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.4
+Name: tac_two
+Version: 1.0.0
+Summary: A two-level tic-tac-toe game
+License: Apache 2.0
+License-File: LICENSE
+Author: Begoyim Kosimova
+Author-email: begoyim.kosimova@studio.unibo.it
+Requires-Python: >=3.10.0,<4.0.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Description-Content-Type: text/markdown
+
+
+# Tac²
+
+![Status](https://img.shields.io/badge/status-in%20development-orange)
+![Python](https://img.shields.io/badge/Python-3.9%2B-blue?logo=python&logoColor=white)
+![Vue.js](https://img.shields.io/badge/Vue.js-frontend-42b883?logo=vuedotjs&logoColor=white)
+![License](https://img.shields.io/badge/License-Apache%202.0-lightgrey?logo=apache)
+
+A two-player, two-level tic-tac-toe strategy game featuring forced-board moves and a chess clock.
+
+## Project Overview
+
+**Tac²** is a two-player strategy game that expands classic tic-tac-toe into two levels: a large 3×3 grid containing nine smaller tic-tac-toe boards.
+
+The objective is to win three small boards in a row, column, or diagonal on the larger board. Each move determines which small board the opponent must play in next. If the designated board has already been won or is full, the opponent can choose another available board.
+
+The game features a chess clock, with a configurable time limit (e.g., five minutes per player). A player who runs out of time loses the game.
+
+Beyond the core game mechanics, Tac² aims to provide user accounts, an interactive tutorial, multiple game modes, a global leaderboard, and personal statistics.
+
+## How to Play
+
+1. **Play a move.** Place your mark in an available cell of the current small board.
+2. **Determine the opponent's next board.** The position of your move determines which small board the opponent must play in next. For example, playing in the top-right cell sends the opponent to the top-right small board.
+3. **Win a small board.** Complete a horizontal, vertical, or diagonal line of three marks within a small board.
+4. **Win the game.** Win three small boards in a row, column, or diagonal on the larger grid.
+5. **Manage your time.** Each player has five minutes. Running out of time results in a loss.
+
+If the designated next board has already been won or is full, the opponent may choose another eligible board.
+
+
+## Key Features
+
+The planned features of Tac² include:
+
+- **User Authentication and Profiles:** User registration, login, and personal profile management.
+- **Interactive Tutorial (Level 0):** A step-by-step introduction to the game rules and mechanics for new players.
+- **Multiple Game Modes:**
+  - **Local Multiplayer:** Two players compete on the same device.
+  - **Player vs. Computer:** Single-player matches against AI opponents with multiple difficulty levels, such as easy, medium, and hard.
+  - **Online Multiplayer:** Players create or join online rooms using a room key.
+- **Global Leaderboard:** A public ranking of players based on their performance and scores against the computer.
+- **User Statistics:** A personal dashboard showing win rates, performance across difficulty levels, and match history.
+- **Timed Gameplay:** A chess clock that limits the time available to each player.
+
+
+## Team
+
+Tac² is developed by:
+
+- **Begoyim Kosimova**
+- **Sofia Scardovi**
+- **Martina Samorè**
+
+University of Bologna — Digital Transformation Management, A.Y. 2025/2026.
+
+## Project Scope
+
+The project focuses on implementing Tac²'s core game mechanics, board-selection rules, win conditions, and timed gameplay.
+
+The final implementation scope and acceptance criteria are defined by the project requirements and documented in the accompanying Software Engineering report.
+
+
+## Proposed Technology Stack
+
+The following technologies are proposed for development. The final implementation may evolve as the project progresses.
+
+- **Python:** Backend programming language and game logic.
+- **FastAPI:** Backend API framework, including WebSockets for online multiplayer rooms.
+- **PostgreSQL:** Relational database for user accounts, profiles, match records, and statistics.
+- **FastAPI Users:** Authentication and user-management functionality.
+- **Vue.js:** Frontend framework for the interactive user interface.
+- **JavaScript:** Frontend interactions and client-side functionality.
+- **Poetry:** Python dependency and build management.
+- **pytest:** Python testing framework.
+- **Vitest and Vue Test Utils:** Frontend unit testing.
+- **Playwright:** End-to-end browser testing.
+- **Ruff and Mypy:** Python code quality and static analysis.
+- **Docker and Docker Compose:** Application containerisation and local development environment.
+- **GitHub Actions:** Continuous integration and continuous delivery (CI/CD), including automated checks and builds.
+
+## Project Structure
+
+The repository separates the Python application from the Vue frontend.
+
+```text
+artifact/
+├── docs
+├── tac_two/
+│   ├── __init__.py
+│   ├── __main__.py
+│   └── frontend/
+│       ├── src/
+│       │   ├── components/
+│       │   ├── views/
+│       │   ├── router/
+│       │   ├── stores/
+│       │   ├── App.vue
+│       │   └── main.js
+│       ├── e2e/
+│       ├── package.json
+│       └── vite.config.js
+├── tests/
+├── pyproject.toml
+├── README.md
+└── LICENSE
+```
+
+This illustrates the principal project files; additional configuration and source files may be present.
+
+## Development Setup
+
+### Prerequisites
+
+- Python version supported by `pyproject.toml`.
+- Poetry.
+- Node.js compatible with the frontend's `package.json` requirements.
+- npm.
+
+### Python Environment
+
+Install the Python dependencies from the repository root:
+
+```bash
+poetry install
+```
+
+Run the Python test suite:
+
+```bash
+poetry run poe test
+```
+
+Run the configured static checks:
+
+```bash
+poetry run poe static-checks
+```
+
+Run Python coverage:
+
+```bash
+poetry run poe coverage
+poetry run poe coverage-report
+```
+
+Generate an HTML coverage report:
+
+```bash
+poetry run poe coverage-html
+```
+
+### Frontend Environment
+
+Navigate to the frontend directory:
+
+```bash
+cd tac_two/frontend
+```
+
+Install the JavaScript dependencies:
+
+```bash
+npm install
+```
+
+Start the development server:
+
+```bash
+npm run dev
+```
+
+Run the frontend unit tests:
+
+```bash
+npm run test:unit -- --run
+```
+
+Build the frontend for production:
+
+```bash
+npm run build
+```
+
+Run the end-to-end tests:
+
+```bash
+npm run test:e2e
+```
+
+Playwright may require browser binaries to be installed before the end-to-end tests can run.
+
+## Testing and Quality Assurance
+
+Tac² includes testing infrastructure for the Python application and Vue frontend.
+
+- **Python tests:** pytest.
+- **Frontend unit tests:** Vitest and Vue Test Utils.
+- **End-to-end tests:** Playwright.
+- **Code quality:** Ruff and Mypy.
+- **Coverage:** Python coverage tooling.
+
+The testing strategy should cover the core game rules, including:
+
+- Valid and invalid moves;
+- board-selection rules;
+- small-board victory conditions;
+- overall game victory conditions;
+- handling of completed or full boards;
+- chess-clock behavior and timeout outcomes;
+- relevant frontend interactions and user-visible feedback.
+
+Coverage measurements and acceptance-test results should be documented once the corresponding tests have been implemented and executed.
+
+## Build and Code Quality
+
+Run the configured Python static checks from the repository root:
+
+```bash
+poetry run poe static-checks
+```
+
+Build the frontend:
+
+```bash
+cd tac_two/frontend
+npm run build
+```
+
+These checks help identify static-analysis issues and frontend build errors before changes are merged.
+
+## Versioning and Releases
+
+Tac² follows Semantic Versioning:
+
+`MAJOR.MINOR.PATCH`
+
+Version numbers should be updated consistently across relevant project metadata, the changelog, Git tags, and published releases.
+
+Release automation and the release history will be documented here once configured.
+
+## Project Documentation
+
+The accompanying Software Engineering report should document:
+
+- Functional and non-functional requirements;
+- user stories and acceptance criteria;
+- game rules and domain modelling;
+- architecture and design decisions;
+- implementation details;
+- testing strategy and validation evidence;
+- development, build, and deployment instructions;
+- licensing decisions and future improvements.
+
+Links to the project report, user guide, developer guide, and release history can be added here when those resources are available.
+
+## Third-Party Software
+
+Tac² uses open-source software and third-party dependencies, including Python and Vue.js.
+
+- **Python:** See the [official Python license documentation](https://docs.python.org/3/license.html).
+- **Vue.js:** Vue.js is distributed under the [MIT License](https://github.com/vuejs/core/blob/main/LICENSE).
+- **Other dependencies:** Each dependency remains subject to its own license terms and applicable notices.
+
+The licenses of third-party packages should be reviewed and documented where appropriate.
+
+## License
+
+Tac² is distributed under the **Apache License 2.0**.
+
+This permissive open-source license allows use, modification, and redistribution subject to its terms. It also includes an express patent license and requires preservation of applicable notices.
+
+See the [`LICENSE`](LICENSE) file for the complete license text.
+
+