Use uv

Author: theskumar

.github/workflows/release.yml

@@ -1,37 +1,36 @@
-name: Upload Python Package
+name: Release and Publish
 
 on:
   release:
     types: [created]
 
 jobs:
-  pypi-publish:
-    name: upload release to PyPI
+  test:
+    uses: ./.github/workflows/test-reusable.yml
 
+  pypi-publish:
+    name: Upload release to PyPI
+    needs: test # Only run after all tests pass
     runs-on: ubuntu-latest
-    # Specifying a GitHub environment is optional, but strongly encouraged
     environment: release
     permissions:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
 
     steps:
-      # retrieve your distributions here
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12" # Use stable version for building
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install hatch
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
 
       - name: Build package distributions
         run: |
-          hatch build
+          uv build
 
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test-reusable.yml

@@ -0,0 +1,61 @@
+name: Test (Reusable)
+
+on:
+  workflow_call:
+    inputs:
+      python-versions:
+        description: 'JSON array of Python versions to test'
+        required: false
+        type: string
+        default: '["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ${{ fromJson(inputs.python-versions) }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups --python ${{ matrix.python-version }}
+
+      - name: Lint with ruff
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          uv run ruff check --output-format=github --select=E9,F63,F7,F82 .
+          # default set of ruff rules with GitHub Annotations
+          uv run ruff check --output-format=github .
+
+      - name: Test with pytest
+        run: |
+          uv run pytest
+
+  test-summary:
+    name: Test Suite Status
+    runs-on: ubuntu-latest
+    needs: test
+    if: always()
+    steps:
+      - name: Check test matrix status
+        run: |
+          if [[ "${{ needs.test.result }}" == "success" ]]; then
+            echo "All tests passed successfully!"
+            exit 0
+          else
+            echo "Tests failed or were cancelled"
+            exit 1
+          fi

.github/workflows/test.yml

@@ -1,34 +1,7 @@
 name: Test
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
-
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements-dev.lock
-
-      - name: Lint with ruff
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          ruff --format=github --select=E9,F63,F7,F82 --target-version=py37 .
-          # default set of ruff rules with GitHub Annotations
-          ruff --format=github --target-version=py37 .
-      - name: Test with pytest
-        run: |
-          pytest
+  test:
+    uses: ./.github/workflows/test-reusable.yml

.python-version

@@ -1 +1 @@
-[email protected]
+3.14

README.md

@@ -1,11 +1,8 @@
 # python-usernames
 
-[![Build
-Status](https://travis-ci.org/theskumar/python-usernames.svg?branch=v0.1.0)](https://travis-ci.org/theskumar/python-usernames)
-[![Coverage
-Status](https://coveralls.io/repos/theskumar/python-usernames/badge.svg?branch=master&service=github)](https://coveralls.io/github/theskumar/python-usernames?branch=master)
-[![PyPI
-version](https://badge.fury.io/py/python-usernames.svg)](http://badge.fury.io/py/python-usernames)
+[![Test](https://github.com/theskumar/python-usernames/actions/workflows/test.yml/badge.svg)](https://github.com/theskumar/python-usernames/actions/workflows/test.yml)
+[![PyPI version](https://badge.fury.io/py/python-usernames.svg)](https://pypi.org/project/python-usernames/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/python-usernames.svg)](https://pypi.org/project/python-usernames/)
 
 Python library to validate usernames suitable for use in public facing
 applications where use can choose login names and sub-domains.
@@ -75,6 +72,43 @@ is checked. We don't try to be smart to avoid [Scunthorpe
 problem](https://en.wikipedia.org/wiki/Scunthorpe_problem). If you can
 come up with a algorithm/solution, please create an issue/pr :).
 
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and packaging.
+
+### Setup
+
+1. Install uv:
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   ```
+
+2. Clone the repository and sync dependencies:
+   ```bash
+   git clone https://github.com/theskumar/python-usernames.git
+   cd python-usernames
+   uv sync --all-groups
+   ```
+
+### Running Tests
+
+```bash
+uv run pytest
+```
+
+### Linting
+
+```bash
+uv run ruff check .
+uv run black --check .
+```
+
+### Building
+
+```bash
+uv build
+```
+
 ## License
 
 MIT

pyproject.toml

@@ -57,13 +57,12 @@ Tracker = "https://github.com/theskumar/python-usernames/issues"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.rye]
-managed = true
-dev-dependencies = [
-    "pytest~=7.3.2",
-    "black~=23.3.0",
-    "ruff~=0.0.272",
-    "hatch~=1.7.0",
+[dependency-groups]
+dev = [
+    "pytest>=7.3.2",
+    "black>=23.3.0",
+    "ruff>=0.0.272",
+    "hatch>=1.7.0",
 ]
 
 [tool.hatch.metadata]

requirements-dev.lock

@@ -1,5 +1,4 @@
-from .validators import is_safe_username
+from python_usernames.__about__ import VERSION as __version__
+from python_usernames.validators import is_safe_username
 
-__version__ = "0.4.1"
-
-__all__ = ["is_safe_username"]
+__all__ = ["is_safe_username", "__version__"]

requirements.lock

@@ -1,4 +1,5 @@
 import re
+from functools import lru_cache
 
 from .reserved_words import get_reserved_words
 
@@ -17,34 +18,40 @@
 )
 
 
+@lru_cache(maxsize=1)
+def _get_cached_reserved_words():
+    """Cache reserved words to avoid repeated file I/O."""
+    return get_reserved_words()
+
+
 def is_safe_username(
     username: str, whitelist=None, blacklist=None, regex=username_regex, max_length=None
 ) -> bool:
-    # check for max length
+    # check for max length (fastest check first)
     if max_length and len(username) > max_length:
         return False
 
     # check against provided regex
-    if not re.match(regex, username):
+    if not regex.match(username):
         return False
 
-    # ensure the word is not in the blacklist and is not a reserved word
-    if whitelist is None:
-        whitelist = []
+    username_lower = username.lower()
 
-    if blacklist is None:
-        blacklist = []
+    # Fast path: no custom lists
+    if not whitelist and not blacklist:
+        return username_lower not in _get_cached_reserved_words()
 
-    default_words = get_reserved_words()
+    # Start with reserved words
+    forbidden = _get_cached_reserved_words().copy()
 
-    whitelist = set(
-        [each_whitelisted_name.lower() for each_whitelisted_name in whitelist]
-    )
-    blacklist = set(
-        [each_blacklisted_name.lower() for each_blacklisted_name in blacklist]
-    )
+    # Apply whitelist (remove from forbidden)
+    if whitelist:
+        whitelist_set = {w.lower() for w in whitelist}
+        forbidden -= whitelist_set
 
-    default_words = default_words - whitelist
-    default_words = default_words.union(blacklist)
+    # Apply blacklist (add to forbidden)
+    if blacklist:
+        blacklist_set = {w.lower() for w in blacklist}
+        forbidden |= blacklist_set
 
-    return False if username.lower() in default_words else True
+    return username_lower not in forbidden