designkit 0.1.1__tar.gz → 0.2.0__tar.gz

designkit-0.2.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,79 @@
+name: Bug Report
+description: Report a bug in the library.
+title: "[Bug]: "
+labels: ["bug"]
+projects: ["designkit"]
+type: bug
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks so much for taking the time to fill out this bug report...
+  
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "No description provided."
+    validations:
+      required: true
+  
+  - type: dropdown
+    id: version
+    attributes:
+      label: DesignKit Version
+      description: What version of our library are you using?
+      options:
+        - v0.1.0 -- v0.1.1 (default)
+      default: 0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python Version
+      description: What version of Python are you using?
+      options:
+        - Python 3.14
+    validations:
+      required: true
+  
+  - type: dropdown
+    id: devices
+    attributes:
+      label: What OS are you seeing the problem on?
+      multiple: true
+      options:
+        - Windows
+        - macOS
+        - Linux
+        - iOS
+      default: ["Windows"]
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  
+  - type: upload
+    id: screenshots
+    attributes:
+      label: Upload screenshots
+      description: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false
+
+  - type: textarea
+    id: notes
+    attributes:
+      label: Additional Notes
+      description: Any additional information that might be helpful.
+      value: "No additional notes."
+    validations:
+      required: false

designkit-0.2.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,26 @@
+blank_issues_enabled: false
+
+issue_templates:
+  - name: "Bug Report"
+    description: "Report a bug in the DesignKit."
+    title: "[Bug]: "
+    labels: ["bug"]
+    body: "./ISSUE_TEMPLATE/bug_report.md"
+
+  - name: "Design Pattern Request"
+    description: "Propose a new design pattern."
+    title: "[Design Pattern]: "
+    labels: ["enhancement"]
+    body: "./ISSUE_TEMPLATE/pattern_request.md"
+
+  - name: "Documentation"
+    description: "Suggest updates or additions to the documentation."
+    title: "[Docs]: "
+    labels: ["documentation"]
+    body: "./ISSUE_TEMPLATE/documentation.md"
+
+  - name: "General Report"
+    description: "Provide general feedback or inquiries."
+    title: "[General]: "
+    labels: ["general"]
+    body: "./ISSUE_TEMPLATE/general_report.md"

designkit-0.2.0/.github/PULL_REQUEST_TEMPLATE/new_pattern.md

@@ -0,0 +1,112 @@
+
+<!-- One PR, One Design Pattern ~ @Sheñey -->
+
+
+# DESIGN PATTERN -- PULL REQUEST
+
+> **Purpose:** Implementation
+>
+> **Date:** <!-- YYYY-MM-DD -->
+>
+> **Authors:** <!-- @gh_username1, @gh_username2 -->
+
+
+---
+
+
+## 1. Pattern Information
+
+### What is your proposed name for the pattern?
+<!-- Provide a name for your design pattern and the "scientific" definition -->
+<!-- Example: State, an Automaton of Finite State Machine -->
+
+### What is the category of the pattern?
+<!-- Specify the category of your design pattern -->
+<!-- Example: Behavioral, Structural, Creational -->
+
+### What problem does this pattern solve?
+<!-- Describe the problem that this design pattern addresses -->
+<!-- Example: Managing state transitions in a finite state machine -->
+
+### How does this pattern solve the problem?
+<!-- Describe how this design pattern solves the problem -->
+<!-- Example: This design pattern is implemented using a reusable state machine that includes support for transitions, hooks, decorators, metamethods, and enums as possible states. -->
+
+### Sample Screenshots/Videos/GIFs: <!-- Optional -->
+*`N/A`*
+
+
+---
+
+
+## 2. Implementation Checklist
+<!-- Basically, check if the implementation contains *adequate documentation*, *unitary tests*, and *samples* -->
+- [ ] I have documented my design pattern according to the specifications in [CONTRIBUTING.md](CONTRIBUTING.md) <!-- Important -->
+- [ ] I have created unit tests that efficiently cover a large number of my functionalities in [tests/...](tests/...) <!-- Optional -->
+- [ ] I have designed at least one example of its use in [samples/...](samples/...) <!-- Important -->
+
+
+---
+
+
+## 3. Pattern Checklist
+<!-- In summary... check or add the technologies, utilities, styles or paradigms that support your design pattern -->
+- [ ] Pythonic Design. <!-- Almost fully compliant -->
+- [ ] Implementation in Rust. <!-- At least the heavy/core parts -->
+- [ ] Type Hints. <!-- Very Important -->
+- [ ] OOP Paradigm.
+- [ ] Functional Paradigm.
+- [ ] Reusable Component.
+- [ ] Asynchronous & Synchronous.
+- [ ] Thread-safe.
+- [ ] Hooks Support.
+<!-- Add more as-needed -->
+
+
+---
+
+
+### 4. Pull-Request Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] It works on `Python 3.14+`. <!-- Important -->
+- [ ] Does NOT cause adverse effects like bugs in other design patterns. <!-- Important -->
+- [ ] Only affects my own design pattern. <!-- Important -->
+- [ ] Does NOT contain breaking changes that raise the major digit of the version. <!-- Important -->
+- [ ] Does NOT have any bugs or errors.
+- [ ] Does NOT depend on other design patterns.
+- [ ] This is based on the latest version of the main branch. <!-- Important -->
+- [ ] Does NOT have any merge conflicts. <!-- Important -->
+
+
+---
+
+
+## 5. Developer Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] My design pattern is unique in functionality and the problem it solves.
+- [ ] I designed an API with *developer experience*, education, and ***type annotations*** in mind, prioritizing this over performance. <!-- Optional, but recommended -->
+- [ ] I agree with what can and cannot be done with my design pattern according to the [LICENSE](LICENSE) <!-- Important -->
+- [ ] I have read, understand and apply the contribution regulations in [CONTRIBUTING.md](CONTRIBUTING.md) <!-- Important -->
+- [ ] I have modified the [TODO.md](TODO.md) file to add my design pattern in its respective state (`[~] building`, `[X] complete` or `[ ] incomplete`) and incremented the patterns number in the [README.md](README.md) file. <!-- Important -->
+
+
+---
+
+
+<!-- If you want to leave a note about complications, suggestions, future implementations, or anything else... this is where you can do it. -->
+> [!NOTE]
+> No note was left by the developer. :D
+
+<!-- If you have marked that there are bugs... this is the section to specify them. -->
+<!-- Example:
+
+> [!CAUTION]
+> **designkit/behavioral/state/core.py**#L23-L30: The transition method does not handle invalid states correctly, which can lead to unexpected behavior. A fix is needed to validate state transitions before applying them.
+
+> [!WARNING]
+> **tests/structural/singleton/test_singleton.py** (test_new_metamethod): The test for the metamethod `__new__` in the Singleton pattern is failing intermittently due to a race condition. This needs to be addressed to ensure consistent test results.
+
+-->
+
+
+---

designkit-0.2.0/.github/PULL_REQUEST_TEMPLATE/pattern_maintenance.md

@@ -0,0 +1,94 @@
+
+<!-- One PR, One Design Pattern ~ @Sheñey -->
+
+
+# DESIGN PATTERN -- PULL REQUEST
+
+> **Purpose:** Maintenance
+>
+> **Date:** <!-- YYYY-MM-DD -->
+>
+> **Authors:** <!-- @gh_username1, @gh_username2 -->
+<!--
+>
+> **Issue:** #ISSUE_NUMBER -->
+
+
+---
+
+
+## 1. PR Information
+
+### What pattern are you maintaining?
+<!-- Provide the category and name like tree of the design pattern you are maintaining -->
+<!-- Example: `designkit/behavioral/strategy` -->
+
+### What does this PR do?
+<!-- Describe the issue that this pull request addresses -->
+<!-- Example: Add about 12 unit tests for the strategy pattern. -->
+
+### Sample Screenshots/Videos/GIFs: <!-- Optional -->
+*`N/A`*
+
+
+---
+
+
+## 2. Change Checklist
+<!-- Select the type of changes included in this PR -->
+- [ ] Refactoring
+- [ ] Performance Optimization (on `python`/`rust` <!-- Specify the language -->)
+- [ ] API Improvement <!-- Like adding new methods -->
+- [ ] Renaming <!-- Only renaming of existing elements -->
+- [ ] Documentation
+- [ ] Bug Fixing
+- [ ] Testing
+- [ ] Sampling
+- [ ] Other... <!-- Specify the type of changes included in this PR -->
+
+
+---
+
+
+## 3. Pull-Request Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] It works on `Python 3.14+`. <!-- Important -->
+- [ ] Does NOT depend on other design patterns.
+- [ ] Only affects one design pattern. <!-- Important -->
+- [ ] Only includes relevant changes.
+- [ ] This is based on the latest version of the main branch. <!-- Important -->
+- [ ] Does NOT have any merge conflicts. <!-- Important -->
+- [ ] Does NOT contain any commented-out code. <!-- Important -->
+- [ ] Does NOT contain breaking changes that raise the major digit of the version. <!-- Important -->
+- [ ] Does NOT have any bugs or errors.
+
+
+---
+
+## 4. Developer Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] I agree with what can and cannot be done with my design pattern according to the [LICENSE](LICENSE) <!-- Important -->.
+- [ ] I have read, understand and apply the contribution regulations in [CONTRIBUTING.md](CONTRIBUTING.md) <!-- Important -->
+- [ ] I have modified the [TODO.md](TODO.md) file to update the respective design pattern in its state (`[~] building`, `[X] complete`). <!-- Important -->
+
+
+---
+
+
+<!-- If you want to leave a note about complications, suggestions, future implementations, or anything else... this is where you can do it. -->
+> [!NOTE]
+> No note was left by the developer. :D
+
+<!-- If you have marked that there are bugs... this is the section to specify them. -->
+<!-- Example:
+
+> [!CAUTION]
+> **designkit/behavioral/state/core.py**#L23-L30: The transition method does not handle invalid states correctly, which can lead to unexpected behavior. A fix is needed to validate state transitions before applying them.
+
+> [!WARNING]
+> **tests/structural/singleton/test_singleton.py** (test_new_metamethod): The test for the metamethod `__new__` in the Singleton pattern is failing intermittently due to a race condition. This needs to be addressed to ensure consistent test results.
+
+-->
+
+
+---

designkit-0.2.0/.github/PULL_REQUEST_TEMPLATE/repo_maintenance.md

@@ -0,0 +1,69 @@
+
+
+# GENERAL -- PULL REQUEST
+
+> **Purpose:** Repository Maintenance
+>
+> **Date:** <!-- YYYY-MM-DD -->
+>
+> **Authors:** <!-- @gh_username1, @gh_username2 -->
+<!--
+>
+> **Issue:** #ISSUE_NUMBER -->
+
+
+---
+
+
+## 1. PR Information
+
+### What does this PR add, maintain, update, fix or ...?
+<!-- Describe the issue that this pull request addresses -->
+<!-- Example: Update the `README` file to add new contribution guidelines... -->
+
+### Sample Screenshots/Videos/GIFs: <!-- Optional -->
+*`N/A`*
+
+
+---
+
+
+## 2. Pull-Request Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] Only includes relevant changes.
+- [ ] Only affects one part of the repository. <!-- Important -->
+- [ ] This is based on the latest version of the main branch. <!-- Important -->
+- [ ] Does NOT have any merge conflicts. <!-- Important -->
+- [ ] Does NOT contain any commented-out code. <!-- Important -->
+- [ ] Does NOT contain breaking changes that raise the major digit of the version. <!-- Important -->
+- [ ] Does NOT have any bugs or errors.
+
+
+---
+
+
+## 4. Developer Checklist
+<!-- Check if you did what was asked of you. -->
+- [ ] I have read, understand and apply the contribution regulations in [CONTRIBUTING.md](CONTRIBUTING.md) <!-- Important -->
+
+
+---
+
+
+<!-- If you want to leave a note about complications, suggestions, future implementations, or anything else... this is where you can do it. -->
+> [!NOTE]
+> No note was left by the developer. :D
+
+<!-- If you have marked that there are bugs... this is the section to specify them. -->
+<!-- Example:
+
+> [!CAUTION]
+> **requirements.txt**#L1-L2: Some dependencies are outdated and need to be updated to their latest versions. This may cause compatibility issues with other parts of the repository. Please review and update the dependencies accordingly.
+
+> [!WARNING]
+> **.gitignore**: .gitignore file exposes .env files, which may contain sensitive information. Please ensure that these files are not included in the repository and update the .gitignore file accordingly.
+
+-->
+
+
+---

designkit-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,308 @@
+# Contributing to DesignKit
+
+First of all, thank you for considering contributing to **DesignKit**! ❤️
+
+Our goal is to build a modern, educational, and production-ready collection of software architecture and design patterns for Python, powered by Rust where appropriate.
+
+Please read this document before opening a Pull Request.
+
+---
+
+# Philosophy
+
+DesignKit prioritizes:
+
+- 📚 Education and readability over micro-optimizations.
+- 🐍 Pythonic APIs.
+- 🦀 Rust implementations for performance-critical components.
+- 🧩 Reusable software architecture.
+- 📝 Complete documentation.
+- 🧪 Reliable testing.
+- 🔒 Stable public APIs.
+
+Every contribution should improve the library without making it harder to understand.
+
+---
+
+# Before Contributing
+
+Make sure you:
+
+- Read the project README.
+- Read the LICENSE.
+- Search existing Issues and Pull Requests.
+- Verify your idea has not already been implemented.
+
+---
+
+# Development Setup
+
+Clone the repository
+
+```bash
+git clone https://github.com/Sheniey/designkit.git
+cd designkit
+```
+
+Create a virtual environment
+
+```bash
+python -m venv .venv
+```
+
+Activate it
+
+Windows
+
+```bash
+.venv\Scripts\activate
+```
+
+Linux/macOS
+
+```bash
+source .venv/bin/activate
+```
+
+Install development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+Build the Rust extension
+
+```bash
+maturin develop
+```
+
+Run tests
+
+```bash
+pytest
+```
+
+---
+
+# Python Version
+
+DesignKit currently targets:
+
+- Python **3.14+**
+
+Pull Requests using older Python syntax will not be accepted.
+
+---
+
+# Project Structure
+
+A typical pattern should contain:
+
+```
+designkit/
+    behavioral/
+        my_pattern/
+            __init__.py
+            core.py
+            ...
+tests/
+    behavioral/
+        test_my_pattern.py
+samples/
+    behavioral/
+        my_pattern.py
+```
+
+Documentation should be reflected in:
+
+- README.md
+- TODO.md
+- Pattern documentation (if applicable)
+
+---
+
+# Adding a New Design Pattern
+
+Every new pattern must include:
+
+## 1. Implementation
+
+Implement the pattern following the project's coding style.
+
+Prefer:
+
+- Type hints
+- Clear naming
+- Small classes
+- Small functions
+- Documentation strings
+
+---
+
+## 2. Tests
+
+Every feature should be tested.
+
+Tests should cover:
+
+- Normal usage
+- Invalid inputs
+- Edge cases
+- Public API
+
+Use `pytest`.
+
+---
+
+## 3. Sample
+
+Provide at least one working example under:
+
+```
+samples/
+```
+
+Examples should be educational and executable.
+
+---
+
+## 4. Documentation
+
+Document:
+
+- What problem the pattern solves
+- Why it exists
+- When it should be used
+- Advantages
+- Disadvantages
+- Example usage
+
+---
+
+# Code Style
+
+Preferred conventions:
+
+- PEP 8
+- Type annotations everywhere
+- Explicit imports
+- Meaningful names
+- No dead code
+- No commented-out code
+
+Avoid unnecessary complexity.
+
+Readable code is preferred over clever code.
+
+---
+
+# Rust Code
+
+Rust is used for performance-sensitive implementations.
+
+Rust code should:
+
+- Follow idiomatic Rust
+- Be memory safe
+- Expose clean Python APIs through PyO3
+- Avoid unsafe blocks unless absolutely necessary
+
+---
+
+# API Design
+
+Public APIs should be:
+
+- Easy to discover
+- Easy to read
+- Easy to type
+- Stable
+
+Breaking API changes are discouraged.
+
+---
+
+# Pull Requests
+
+Every Pull Request must use the provided PR template.
+
+The checklist must be completed honestly.
+
+A PR should focus on **one design pattern** whenever possible.
+
+Large unrelated changes may be rejected.
+
+---
+
+# Pull Request Requirements
+
+A Pull Request should:
+
+- Build successfully
+- Pass all tests
+- Include documentation
+- Include examples
+- Include type hints
+- Avoid breaking changes
+- Follow the project philosophy
+
+---
+
+# Commit Messages
+
+Recommended format:
+
+```bash
+feat(pattern): implement state pattern
+
+fix(observer): fix subscription bug
+
+docs: improve README
+
+test(factory): add edge cases
+
+refactor(builder): simplify API
+```
+
+---
+
+# Reporting Bugs
+
+Please include:
+
+- Python version
+- Operating system
+- Minimal reproducible example
+- Expected behavior
+- Actual behavior
+
+---
+
+# Feature Requests
+
+Explain:
+
+- The problem
+- Why it matters
+- Possible implementation
+- Alternatives considered
+
+---
+
+# Code of Conduct
+
+Please be respectful.
+
+Constructive discussions are encouraged.
+
+Harassment, discrimination, or toxic behavior will not be tolerated.
+
+---
+
+# License
+
+By submitting code, you agree that your contribution will be licensed under the project's MIT License.
+
+---
+
+Thank you for helping make **DesignKit** better.