slugany 0.1.0__tar.gz

slugany-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior
+title: "[BUG] "
+labels: bug
+assignees: ''
+---
+
+## Description
+
+A clear and concise description of the bug.
+
+## Steps to reproduce
+
+```python
+from slugany import slugify
+
+# Minimal code that reproduces the issue
+```
+
+## Expected behavior
+
+What you expected to happen.
+
+## Actual behavior
+
+What actually happened.
+
+## Environment
+
+- **slugany version**:
+- **Python version**:
+- **OS**:
+
+## Additional context
+
+Any other relevant information.

slugany-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest a new feature or enhancement
+title: "[FEATURE] "
+labels: enhancement
+assignees: ''
+---
+
+## Motivation
+
+Why is this feature needed? What problem does it solve?
+
+## Proposed solution
+
+A clear description of what you want to happen.
+
+## Alternatives considered
+
+Any alternative solutions or features you've considered.
+
+## Additional context
+
+Any other relevant information.

slugany-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+## 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 (no functional changes)
+
+## Checklist
+
+- [ ] Code follows the project's style guidelines (ruff check, ruff format)
+- [ ] Type checking passes (mypy --strict)
+- [ ] Tests pass with 100% coverage (pytest)
+- [ ] CHANGELOG.md updated under `[Unreleased]`
+- [ ] Documentation updated if needed

slugany-0.1.0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 5
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+    open-pull-requests-limit: 5

slugany-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - run: ruff check slugany/ tests/
+      - run: ruff format --check slugany/ tests/
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - run: mypy --strict slugany/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: pip install -e ".[dev]"
+      - run: pytest tests/ -v --cov=slugany --cov-report=term-missing --cov-report=xml --cov-fail-under=100
+      - name: Upload coverage
+        if: matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

slugany-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install -e ".[docs]"
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

slugany-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,76 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: true
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Extract changelog
+        id: changelog
+        run: |
+          TAG="${GITHUB_REF#refs/tags/}"
+          VERSION="${TAG#v}"
+          BODY=$(awk -v ver="## [$VERSION]" '
+            $0 ~ ver {found=1; next}
+            /^## \[/ && found {exit}
+            found {print}
+          ' CHANGELOG.md)
+          echo "body<<EOF" >> "$GITHUB_OUTPUT"
+          echo "$BODY" >> "$GITHUB_OUTPUT"
+          echo "EOF" >> "$GITHUB_OUTPUT"
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body: ${{ steps.changelog.outputs.body }}
+          files: dist/*
+          draft: false
+          prerelease: false

slugany-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Reference materials (local only)
+ref/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+*.egg
+dist/
+build/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Type checking
+.mypy_cache/
+.pyre/
+
+# Linting
+.ruff_cache/
+
+# Docs build
+site/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

slugany-0.1.0/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- `slugify()` and `slugify_batch()` parameters are now properly typed (no more `Any` sentinel pattern) — IDE autocompletion and type checking now work correctly for all 14 keyword arguments
+- `slugify_batch()` now accepts explicit keyword arguments instead of `**kwargs: Any`
+- `SlugConfig.from_kwargs()` no longer uses `type: ignore` comments — validation constants extracted to module-level `frozenset`s
+- `_STYLE_PRESETS` and validation constants moved before `SlugConfig` class definition
+- `is_slug()` now raises `TypeError` for non-string `separator` input
+- CLI `_build_kwargs` return type changed from `dict[str, object]` to `dict[str, Any]` to eliminate `type: ignore` on `slugify` calls
+- `pyproject.toml` description translated to English; license changed to SPDX expression with `license-files`
+- README.md and docs/index.md translated from Spanish to English
+- `mkdocs.yml` site description translated to English
+- Development status classifier updated from Alpha to Beta
+- Removed redundant `re.UNICODE` flag from `_UNICODE_ALNUM_RE` (default in Python 3)
+- `_CONFIG_DEFAULTS` now computed from dataclass fields instead of hardcoded values (DRY)
+- Fixed pipeline step count in documentation (16, not 17)
+- Fixed benchmark numbers in performance documentation
+- Fixed incorrect emoji_mode examples in README
+- README expanded with advanced examples, documentation links, and contributing section
+- `docs/index.md` rewritten as a proper landing page with feature list and navigation
+- `CONTRIBUTING.md` updated with full dev setup (dev+docs) and Code of Conduct reference
+- CI/CD workflows now use pip dependency caching
+
+### Added
+
+- `SlugConfig` API reference page in documentation
+- `CONTRIBUTING.md` with development setup, PR process, and code style guidelines
+- `SECURITY.md` with vulnerability reporting policy
+- `CODE_OF_CONDUCT.md` based on Contributor Covenant 2.1
+- GitHub issue templates (bug report, feature request)
+- GitHub pull request template with checklist
+- Dependabot configuration for pip and GitHub Actions
+- Documentation URL in `pyproject.toml` project URLs
+- `__version__` attribute exported from package
+
+### Removed
+
+- `_verify.py` — redundant sanity-check script duplicated by the test suite
+- `docs/changelog.md` — duplicate of root `CHANGELOG.md`; mkdocs now references the original
+
+## [0.1.0] - 2026-08-18
+
+### Added
+
+- `slugify()` function with keyword-only API and `TypeError` on non-string input
+- `slugify_batch()` for batch processing of multiple texts
+- `is_slug()` validator with `allow_unicode` support
+- `SlugConfig` frozen dataclass with `from_kwargs()` factory and style presets
+- Transliteration tables for es, pt, de, fr, it
+- Smart punctuation normalization (curly quotes, em-dash, NBSP, zero-width, bullets)
+- HTML entity decoding (`&` → `&`)
+- Emoji stripping via regex
+- Confusable character detection (Cyrillic → Latin)
+- Case styles: kebab, snake, camel, pascal, dot, train, filename, url
+- Stopwords removal
+- Pre/post replacements (dict or iterable of tuples)
+- `max_length` with optional `word_boundary` truncation
+- `allow_unicode` mode to preserve non-ASCII characters
+- `fallback` parameter for empty slug results
+- `css_safe` mode to prefix digit-leading slugs
+- `emoji_mode` (strip, text, keep)
+- `html_entities` and `smart_punctuation` toggles
+- `lru_cache` built-in (maxsize=512) with `cache_info()` and `cache_clear()`
+- Pipeline architecture with 16 pure-function steps
+- CLI with argparse, auto-stdin detection, and batch mode
+- `py.typed` marker (PEP 561)
+- CI/CD: lint (ruff), typecheck (mypy), test (3.11/3.12/3.13), release, docs
+- MkDocs Material documentation with mkdocstrings API reference
+- Idempotency, determinism, ASCII output, and no-double-separator contracts

slugany-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,123 @@
+# 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, caste, color, 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
+- Focusing on what is best for the overall community, not just us as individuals
+
+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 email 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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+[homepage]: https://www.contributor-covenant.org
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://www.mozilla.org/en-US/about/governance/policies/participation/).

slugany-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to slugany
+
+Thank you for your interest in contributing to slugany! This document
+outlines the process for contributing to the project.
+
+## Development setup
+
+```bash
+git clone https://github.com/MathiasPaulenko/slugany.git
+cd slugany
+pip install -e ".[dev,docs]"
+```
+
+## Running checks
+
+Before submitting a pull request, ensure all checks pass:
+
+```bash
+ruff check slugany/ tests/
+ruff format --check slugany/ tests/
+mypy --strict slugany/
+pytest tests/
+```
+
+## Pull request process
+
+1. Create a feature branch from `main`.
+2. Make your changes with clear, descriptive commit messages.
+3. Add or update tests to maintain 100% coverage.
+4. Ensure all checks pass (ruff, mypy, pytest).
+5. Update the CHANGELOG.md under the `[Unreleased]` section.
+6. Open a pull request with a clear description of the changes.
+
+## Code style
+
+- Follow PEP 8, PEP 257, and PEP 484.
+- Use `ruff` for linting and formatting.
+- Use type hints for all public APIs.
+- Keep functions small and focused (single responsibility).
+- Write docstrings for all public functions, classes, and methods.
+
+## Testing
+
+- Maintain 100% test coverage.
+- Write tests that are readable, deterministic, and independent.
+- Use descriptive test method names (`test_<behavior>`).
+- Test edge cases: empty input, None, invalid types, boundary conditions.
+
+## Changelog
+
+Follow the [Keep a Changelog](https://keepachangelog.com/) format.
+Entries go under `[Unreleased]` until a release is cut.
+
+## License
+
+By contributing, you agree that your contributions will be licensed
+under the MIT License.
+
+## Code of Conduct
+
+Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).

slugany-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 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.