Move to uv & update dependencies

.github/workflows/ci.yaml

@@ -13,23 +13,26 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8","3.9", "3.10", "3.11"]
+        python-version: ["3.11", "3.12", "3.13"]
         experimental: [false]
         # include:
-        #   - python-version: "3.12"
+        #   - python-version: "3.14"
         #     experimental: true
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install dev dependencies
-        run: |
-          python -m pip install --upgrade pip setuptools poetry
-          poetry install --with dev
+      - name: Install the project
+        run: uv sync --dev
 
       - name: Run Tests
-        run: poetry run ./run-tests.sh
+        run: uv run ./run-tests.sh

.python-version

@@ -0,0 +1 @@
+3.11.12

MANIFEST.in

@@ -1 +1 @@
-include README.rst
+include README.md

README.md

@@ -0,0 +1,32 @@
+# Pyap: Python address parser
+
+Pyap is an MIT Licensed text processing library, written in Python, for detecting and parsing addresses. Currently it supports US 🇺🇸, Canadian 🇨🇦 and British 🇬🇧 addresses.
+
+This fork is maintained by [Beauhurst](https://github.com/Beauhurst).
+
+## Installation
+Install via pip:
+```commandline
+pip install pyap_beauhurst
+```
+
+## Usage
+```python
+import pyap_beauhurst
+
+# some text with an address in it
+test_address = """
+Lorem ipsum
+225 E. John Carpenter Freeway,
+Suite 1500 Irving, Texas 75062
+Dorem sit amet
+"""
+
+# Parse the text for US addresses
+addresses = pyap_beauhurst.parse(test_address, country='US')
+for address in addresses:
+    # shows found address
+    print(address)
+    # shows address parts
+    print(address.model_dump())
+```