pluralio 1.0.0__tar.gz

pluralio-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug in pluralio
+title: "[BUG] "
+labels: bug
+assignees: []
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To reproduce
+
+```python
+import pluralio
+
+# Minimal code that reproduces the issue
+```
+
+## Expected behavior
+
+What you expected to happen.
+
+## Actual behavior
+
+What actually happened.
+
+## Environment
+
+- **pluralio version**: [e.g. 0.1.0]
+- **Python version**: [e.g. 3.12]
+- **OS**: [e.g. Ubuntu 24.04, Windows 11, macOS 14]
+
+## Additional context
+
+Any other context about the problem.

pluralio-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,29 @@
+---
+name: Feature request
+about: Suggest a feature for pluralio
+title: "[FEATURE] "
+labels: enhancement
+assignees: []
+---
+
+## Is your feature request related to a problem?
+
+A clear description of the problem. e.g. "I'm always frustrated when [...]"
+
+## Proposed solution
+
+A clear description of what you want to happen.
+
+```python
+# Example of the proposed API (if applicable)
+import pluralio
+pluralio.pluralize("word", lang="xx")  # "words"
+```
+
+## Alternatives considered
+
+Any alternative solutions or features you've considered.
+
+## Additional context
+
+Any other context or screenshots about the feature request.

pluralio-1.0.0/.github/pull_request_template.md

@@ -0,0 +1,28 @@
+## Summary
+
+Brief description of the changes.
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Refactor / code quality
+- [ ] New language support
+
+## Changes
+
+- Change 1
+- Change 2
+
+## Checklist
+
+- [ ] My code follows the style guidelines (`ruff check` passes)
+- [ ] My code passes type checking (`mypy` passes)
+- [ ] I have added tests for my changes
+- [ ] All tests pass (`pytest` passes)
+- [ ] Test coverage remains >= 95%
+- [ ] I have updated `CHANGELOG.md`
+- [ ] I have updated `README.md` if needed
+- [ ] My commits follow the commit message convention described in `CONTRIBUTING.md`

pluralio-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check pluralio/ tests/
+
+      - name: Type check
+        run: mypy pluralio/
+
+      - name: Test with coverage
+        run: pytest --cov=pluralio --cov-report=term-missing --cov-fail-under=95

pluralio-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: write
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

pluralio-1.0.0/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.venv/
+venv/
+.env
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+ref/

pluralio-1.0.0/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## [Unreleased]
+
+### Changed
+
+- `LanguageRules` is now `frozen=True` — prevents accidental attribute reassignment while allowing in-place extension via the public API
+- `register()` now raises `ValueError` if `code` is empty
+- English pluralization rules expanded: `fe → ves`, `consonant+f → ves`, `consonant+o → oes` added as regex rules (previously handled only as irregulars)
+- English singularization rules expanded: `ves → f`, `oes → o` added as regex rules
+- `pyproject.toml`: added author email, `Bug Tracker` and `Changelog` URLs
+
+### Added
+
+- 25 new English irregular exceptions for the new regex rules (`cafe → cafes`, `solo → solos`, `turf → turfs`, `shoe → shoes`, etc.)
+- Tests for `frozen=True` behavior, empty code validation, and all new regex rules
+
+## [0.1.0] - 2025-07-10
+
+### Added
+
+- `pluralize()` and `singularize()` for English and Spanish
+- `count` parameter for count-aware pluralization
+- Case preservation (title case, all caps)
+- Hyphenated word support (`mother-in-law` → `mothers-in-law`)
+- Extensibility API: `add_irregular`, `add_plural`, `add_singular`, `add_uncountable`, `add_plural_rule`, `add_singular_rule`, `register_language`
+- `supported_languages()` to list registered languages
+- `LanguageRules` dataclass for custom language registration
+- `py.typed` marker for PEP 561
+- CI workflow (lint + type check + test on Python 3.10–3.13)
+- Release workflow (trusted publishing to PyPI)
+- 95% coverage requirement enforced in CI

pluralio-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders 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, or 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 behavior 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 apologizing 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 behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- 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
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**mathias.paulenko@outlook.com**.
+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.
+
+## 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:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior 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
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. 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.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**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.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

pluralio-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,142 @@
+# Contributing to pluralio
+
+Thanks for your interest in contributing! This document covers everything you need to get started.
+
+## Development setup
+
+### Prerequisites
+
+- Python 3.10+
+- [pip](https://pip.pypa.io/)
+
+### Install in development mode
+
+```bash
+git clone https://github.com/MathiasPaulenko/pluralio.git
+cd pluralio
+pip install -e ".[dev]"
+```
+
+### Verify your environment
+
+```bash
+ruff check pluralio/ tests/
+mypy pluralio/
+pytest
+```
+
+All three must pass before submitting a PR.
+
+## Project structure
+
+```text
+pluralio/
+├── pluralio/
+│   ├── __init__.py        # Public API + extensibility functions
+│   ├── core.py            # pluralize(), singularize(), _match_case(), hyphens
+│   ├── registry.py        # LanguageRules dataclass, register(), get_rules()
+│   ├── rules_en.py        # English rules (irregulars, regex, uncountables)
+│   ├── rules_es.py        # Spanish rules (irregulars, regex, uncountables)
+│   └── py.typed           # PEP 561 marker
+├── tests/
+│   ├── conftest.py
+│   ├── test_registry.py
+│   ├── test_core.py
+│   ├── test_en_plurals.py
+│   ├── test_en_singles.py
+│   ├── test_es_plurals.py
+│   ├── test_es_singles.py
+│   ├── test_edge_cases.py
+│   ├── test_round_trip.py
+│   └── test_registry_isolation.py
+├── ref/                   # Design docs, rules reference, development plan
+├── .github/workflows/     # CI + release workflows
+├── pyproject.toml
+├── CHANGELOG.md
+├── CONTRIBUTING.md
+├── CODE_OF_CONDUCT.md
+├── SECURITY.md
+└── README.md
+```
+
+## Coding standards
+
+- **Style**: PEP 8, enforced by `ruff` (line-length = 100)
+- **Typing**: Strict mypy, type hints required on all public functions
+- **Tests**: 95% coverage minimum, enforced in CI (`--cov-fail-under=95`)
+- **Dependencies**: Zero runtime dependencies (stdlib only)
+- **Python**: Code must work on Python 3.10, 3.11, 3.12, and 3.13
+
+## Adding a new language
+
+1. Create `pluralio/rules_xx.py` with a `LanguageRules` dataclass
+2. Call `register(_RULES)` at module level
+3. Import the module in `pluralio/__init__.py`
+4. Add tests in `tests/test_xx_plurals.py` and `tests/test_xx_singles.py`
+5. Add round-trip tests in `tests/test_round_trip.py`
+6. Update `README.md` languages table
+7. Update `CHANGELOG.md`
+
+No changes needed to `core.py` or `registry.py`.
+
+## Adding irregulars or rules to an existing language
+
+Edit the corresponding `rules_xx.py` file and add tests in the appropriate test file.
+
+## Pull request process
+
+1. Fork the repo and create a branch from `main`
+2. Write tests for your changes
+3. Ensure all checks pass:
+
+   ```bash
+   ruff check pluralio/ tests/
+   mypy pluralio/
+   pytest
+   ```
+
+4. Update `CHANGELOG.md` with a description of your changes
+5. Open a pull request using the [PR template](.github/pull_request_template.md)
+6. Wait for CI to pass — all checks must be green
+
+## Commit messages
+
+Use clear, descriptive commit messages. Suggested format:
+
+```text
+<type>: <short description>
+
+<optional longer description>
+```
+
+Types: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`, `ci`
+
+Examples:
+
+```text
+feat: add Portuguese pluralization rules
+fix: correct singularize for words ending in -ces
+docs: update README with count parameter example
+test: add round-trip tests for Spanish irregulars
+```
+
+## Reporting bugs
+
+Use the [Bug Report template](.github/ISSUE_TEMPLATE/bug_report.md) when opening an issue. Include:
+
+- Python version
+- OS
+- Minimal reproduction code
+- Expected vs actual output
+
+## Suggesting features
+
+Use the [Feature Request template](.github/ISSUE_TEMPLATE/feature_request.md) when opening an issue. Describe:
+
+- The use case
+- The proposed API
+- Any alternatives you've considered
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

pluralio-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mathias Paulenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.