fraction-py 1.0.0__tar.gz

fraction_py-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,84 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - published
+
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  publish:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fraction
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Upgrade pip
+        run: |
+          python -m pip install --upgrade pip
+
+      - name: Install build tools
+        run: |
+          python -m pip install build twine
+
+      - name: Build distributions
+        run: |
+          python -m build
+
+      - name: Verify distributions
+        run: |
+          twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI (Trusted Publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      # --------------------------------------------------
+      # Fallback (Disabled)
+      # Uncomment only if using a PyPI API token instead
+      #
+      # - name: Publish using API Token
+      #   uses: pypa/gh-action-pypi-publish@release/v1
+      #   with:
+      #     user: __token__
+      #     password: ${{ secrets.PYPI_API_TOKEN }}
+      # --------------------------------------------------
+
+      - name: Generate checksums
+        run: |
+          cd dist
+          sha256sum * > SHA256SUMS
+
+      - name: Upload checksums
+        uses: actions/upload-artifact@v4
+        with:
+          name: sha256-checksums
+          path: dist/SHA256SUMS
+
+      - name: Upload release assets
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/*
+

fraction_py-1.0.0/.github/workflows/tests.yml

@@ -0,0 +1,90 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+  pull_request:
+    branches:
+      - main
+      - master
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        python-version:
+          - "3.12"
+          - "3.13"
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip
+        run: |
+          python -m pip install --upgrade pip
+
+      - name: Install project
+        run: |
+          pip install -e .[dev]
+
+      - name: Show Python version
+        run: |
+          python --version
+
+      - name: Run Ruff
+        run: |
+          ruff check src tests examples
+
+      - name: Check formatting with Black
+        run: |
+          black --check src tests examples
+
+      - name: Run MyPy
+        run: |
+          mypy src
+
+      - name: Run pytest
+        run: |
+          pytest
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Verify distributions
+        run: |
+          twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-python-${{ matrix.python-version }}
+          path: dist/
+
+      - name: Upload coverage report
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: |
+            coverage.xml
+            htmlcov/

fraction_py-1.0.0/CHANGELOG.md

@@ -0,0 +1,140 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on **Keep a Changelog** and this project adheres to **Semantic Versioning (SemVer)**.
+
+## [Unreleased]
+
+### Added
+
+* Planned support for additional utility methods.
+* Planned performance improvements.
+* Planned documentation enhancements.
+* Planned benchmark suite.
+* Planned serialization utilities.
+* Planned additional interoperability features.
+
+---
+
+## [1.0.0] - 2026-07-27
+
+### Added
+
+#### Core Features
+
+* Initial public release of the `fraction` package.
+* Immutable rational number implementation.
+* Automatic fraction simplification.
+* Positive denominator normalization.
+* Full integration with Python's `numbers.Rational`.
+
+#### Constructors
+
+* Standard constructor.
+* `from_string()`
+* `from_float()`
+* `from_decimal()`
+
+#### Arithmetic
+
+* Addition
+* Subtraction
+* Multiplication
+* Division
+* Reverse arithmetic operators
+* In-place arithmetic operators
+* Integer interoperability
+* Float interoperability
+* Compatibility with `fractions.Fraction`
+
+#### Comparison
+
+* Equality
+* Less than
+* Less than or equal
+* Greater than
+* Greater than or equal
+
+#### Unary Operations
+
+* Unary plus
+* Unary minus
+* Absolute value
+
+#### Power Operations
+
+* Integer powers
+* Negative powers
+* Float powers
+
+#### Type Conversion
+
+* `float()`
+* `int()`
+* `bool()`
+* `round()`
+* String formatting support
+
+#### Utility Methods
+
+* `reciprocal()`
+* `mixed()`
+* `to_decimal()`
+* `as_tuple()`
+
+#### Python Integration
+
+* Hashable implementation.
+* Pickle support.
+* Copy support.
+* Deep copy support.
+* Type annotations (PEP 561).
+
+#### Packaging
+
+* Modern `src/` project layout.
+* PEP 517 build system.
+* PEP 518 compliance.
+* PEP 621 metadata.
+* PyPI-ready packaging.
+* MkDocs documentation.
+* GitHub Actions CI/CD.
+* Comprehensive pytest test suite.
+
+---
+
+## Versioning Policy
+
+This project follows **Semantic Versioning (SemVer)**.
+
+* **MAJOR** version when incompatible API changes are introduced.
+* **MINOR** version when functionality is added in a backward-compatible manner.
+* **PATCH** version when backward-compatible bug fixes are released.
+
+Examples:
+
+* `1.0.0` → Initial stable release
+* `1.1.0` → New features
+* `1.1.1` → Bug fixes
+* `2.0.0` → Breaking changes
+
+---
+
+## Release Process
+
+Each release should include:
+
+* Updated documentation
+* Updated tests
+* Updated version number
+* Git tag
+* GitHub Release
+* PyPI publication
+
+---
+
+## References
+
+* Keep a Changelog: https://keepachangelog.com/
+* Semantic Versioning: https://semver.org/

fraction_py-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,171 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We, as members, contributors, and maintainers, pledge to make participation in our community a harassment-free experience for everyone, regardless of:
+
+* Age
+* Body size
+* Visible or invisible disability
+* Ethnicity
+* Sex characteristics
+* Gender identity and expression
+* Level of experience
+* Education
+* Socio-economic status
+* Nationality
+* Personal appearance
+* Race
+* Religion
+* Sexual identity and orientation
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+---
+
+# Our Standards
+
+Examples of behaviour that contributes to a positive environment include:
+
+* Demonstrating empathy and kindness toward others.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Taking responsibility for mistakes and learning from them.
+* Focusing on what is best for the community.
+* Showing professionalism in public discussions and private communications.
+* Helping new contributors feel welcome.
+* Encouraging respectful collaboration.
+
+Examples of unacceptable behaviour include:
+
+* Harassment or discriminatory language.
+* Trolling, insulting, or derogatory comments.
+* Personal or political attacks.
+* Public or private harassment.
+* Publishing others' private information without explicit permission.
+* Deliberate intimidation or stalking.
+* Threats of violence.
+* Sexual language or imagery in inappropriate contexts.
+* Any conduct that would reasonably be considered inappropriate in a professional setting.
+
+---
+
+# Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour.
+
+Maintainers have the right and responsibility to:
+
+* Remove, edit, or reject comments, commits, code, issues, wiki edits, discussions, and pull requests that violate this Code of Conduct.
+* Take appropriate and fair corrective action in response to unacceptable behaviour.
+* Communicate moderation decisions respectfully and transparently whenever possible.
+
+---
+
+# Scope
+
+This Code of Conduct applies within all project spaces, including but not limited to:
+
+* GitHub repositories
+* Issues
+* Pull requests
+* Discussions
+* Documentation
+* Community forums
+* Chat platforms related to the project
+* Public events representing the project
+
+It also applies when an individual is officially representing the project in public spaces.
+
+Examples include:
+
+* Using an official project email address.
+* Posting through official project social media accounts.
+* Acting as an appointed representative at conferences or community events.
+
+---
+
+# Reporting Issues
+
+If you experience or witness unacceptable behaviour, please report it privately to the project maintainer.
+
+For project-related concerns, open a private communication through the repository owner or the contact information provided in the project documentation.
+
+Reports will be:
+
+* Reviewed promptly.
+* Investigated fairly.
+* Handled confidentially whenever possible.
+* Treated with respect for all involved parties.
+
+---
+
+# Enforcement Guidelines
+
+Project maintainers may apply the following consequences for behaviour that violates this Code of Conduct.
+
+## 1. Correction
+
+**Community Impact**
+
+Use of inappropriate language or other behaviour deemed unprofessional or unwelcome.
+
+**Consequence**
+
+A private, written warning explaining the nature of the violation and why the behaviour was inappropriate.
+
+---
+
+## 2. Warning
+
+**Community Impact**
+
+A violation through a single incident or repeated inappropriate behaviour.
+
+**Consequence**
+
+A warning with consequences for continued behaviour. Interaction with the community may be limited for a specified period.
+
+---
+
+## 3. Temporary Ban
+
+**Community Impact**
+
+A serious violation of community standards.
+
+**Consequence**
+
+A temporary ban from interacting with the project, including discussions, issues, pull requests, and other community spaces.
+
+---
+
+## 4. Permanent Ban
+
+**Community Impact**
+
+Demonstrating a pattern of violating community standards or engaging in harassment, discrimination, intimidation, or other severe misconduct.
+
+**Consequence**
+
+A permanent ban from participation in the project community.
+
+---
+
+# Attribution
+
+This Code of Conduct is adapted from the **Contributor Covenant**, version **2.1**.
+
+Contributor Covenant is available at:
+
+https://www.contributor-covenant.org/version/2/1/code_of_conduct/
+
+Enforcement guidelines were inspired by the Mozilla Community Participation Guidelines.
+
+---
+
+# Commitment
+
+By participating in this project, you agree to uphold this Code of Conduct and contribute to a respectful, inclusive, and collaborative environment.
+
+Thank you for helping make **Fraction** a welcoming project for everyone.