Merge pull request #11 from 3xp0rt/1.0.8

chore(release): bump version to 1.0.8

Author: 3xp0rt

.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dev dependencies
+        run: uv sync --extra dev
+
+      - name: Ruff check
+        run: uv run ruff check --output-format=github .
+
+      - name: Ruff format
+        run: uv run ruff format --check --diff .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install WeasyPrint system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            libpango-1.0-0 \
+            libpangoft2-1.0-0 \
+            libharfbuzz-subset0 \
+            fonts-dejavu-core
+
+      - 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@v5
+        with:
+          enable-cache: true
+
+      - name: Install dev dependencies
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest

.github/workflows/docs.yml

@@ -13,24 +13,25 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
-      
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
       - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install mkdocs mkdocs-material mkdocstrings[python]
-          pip install -e .
-      
+        run: uv sync --extra dev
+
       - name: Build documentation
-        run: mkdocs build
-      
+        run: uv run mkdocs build
+
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./site
-

.gitignore

@@ -45,6 +45,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
+coverage.json
 *.cover
 *.py,cover
 .hypothesis/
@@ -138,6 +139,10 @@ venv.bak/
 # mkdocs documentation
 /site
 
+# Local WhatsMyName dataset copies for manual testing
+/wmn-data.json
+/wmn-data-schema.json
+
 # mypy
 .mypy_cache/
 .dmypy.json

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check --fix
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format
+        language: system
+        types_or: [python, pyi]

docs/api/core/constants.md

@@ -5,12 +5,12 @@ Public constants (see API Reference).
 ## Usage
 
 ```python
-from naminter import CurlCFFISession, WMN_REMOTE_URL, WMN_SCHEMA_URL
+from naminter import CurlCFFISession, WMN_DATA_URL, WMN_SCHEMA_URL
 
 async with CurlCFFISession() as http_client:
     # Fetch data using the public constant
-    wmn_data = (await http_client.get(WMN_REMOTE_URL)).json()
-    wmn_schema = (await http_client.get(WMN_SCHEMA_URL)).json()
+    data = (await http_client.get(WMN_DATA_URL)).json()
+    schema = (await http_client.get(WMN_SCHEMA_URL)).json()
 ```
 
 ## API Reference

docs/api/core/exceptions.md

@@ -66,8 +66,8 @@ except WMNValidationError as e:
     # Access validation errors
     for error in e.schema_errors:
         print(f"Schema error: {error}")
-    for error in e.dataset_errors:
-        print(f"Dataset error: {error}")
+    for error in e.data_errors:
+        print(f"Data error: {error}")
 except WMNDataError:
     # Handle any other data error
     pass

docs/api/core/formatter.md

@@ -13,22 +13,22 @@ from naminter import WMNFormatter
 with open("wmn-data.json", encoding="utf-8") as f:
     data = json.load(f)
 
-with open("wmn-schema.json", encoding="utf-8") as f:
+with open("wmn-data-schema.json", encoding="utf-8") as f:
     schema = json.load(f)
 
-# Read original content for comparison
+# Read original data for comparison
 input_path = Path("wmn-data.json")
-original_content = input_path.read_text(encoding="utf-8")
+original_data = input_path.read_text(encoding="utf-8")
 
 # Create formatter with schema
 formatter = WMNFormatter(schema)
 # Format data (data is not modified)
-formatted_content = formatter.format_dataset(data)
+formatted_data = formatter.format_data(data)
 
 # Compare and write if changed
-if original_content != formatted_content:
+if original_data != formatted_data:
     output_path = Path("wmn-data-formatted.json")
-    output_path.write_text(formatted_content, encoding="utf-8")
+    output_path.write_text(formatted_data, encoding="utf-8")
     print("File was formatted and saved")
 else:
     print("File was already properly formatted")
@@ -40,9 +40,9 @@ The formatter is also available via the CLI:
 
 ```bash
 naminter format \
-    --local-schema schema.json \
-    --local-data data.json \
-    --output formatted-data.json
+    --local-schema wmn-data-schema.json \
+    --local-data wmn-data.json \
+    --output-data formatted-data.json
 ```
 
 ## API Reference

docs/api/core/main.md

@@ -6,13 +6,13 @@ Main class for username enumeration.
 
 ```python
 import asyncio
-from naminter import Naminter, CurlCFFISession, WMN_REMOTE_URL
+from naminter import Naminter, CurlCFFISession, WMN_DATA_URL
 
 async def main():
     async with CurlCFFISession() as http_client:
-        wmn_data = (await http_client.get(WMN_REMOTE_URL)).json()
+        data = (await http_client.get(WMN_DATA_URL)).json()
 
-        async with Naminter(http_client=http_client, wmn_data=wmn_data) as naminter:
+        async with Naminter(http_client=http_client, data=data) as naminter:
             async for result in naminter.enumerate_usernames(["username"]):
                 print(f"{result.name}: {result.status.value}")
 
@@ -23,13 +23,13 @@ asyncio.run(main())
 
 ```python
 import asyncio
-from naminter import Naminter, CurlCFFISession, WMN_REMOTE_URL
+from naminter import Naminter, CurlCFFISession, WMN_DATA_URL
 
 async def main():
     async with CurlCFFISession() as http_client:
-        wmn_data = (await http_client.get(WMN_REMOTE_URL)).json()
+        data = (await http_client.get(WMN_DATA_URL)).json()
 
-        async with Naminter(http_client=http_client, wmn_data=wmn_data) as naminter:
+        async with Naminter(http_client=http_client, data=data) as naminter:
             async for site_result in naminter.test_enumeration():
                 if site_result.error:
                     print(f"ERROR {site_result.name}: {site_result.error}")

docs/api/core/network.md

@@ -121,7 +121,7 @@ class AiohttpSession:
 
 # Usage with Naminter
 async with AiohttpSession() as http_client:
-    async with Naminter(http_client=http_client, wmn_data=wmn_data) as naminter:
+    async with Naminter(http_client=http_client, data=data) as naminter:
         async for result in naminter.enumerate_usernames(["username"]):
             print(f"{result.name}: {result.status.value}")
 ```

docs/api/core/validator.md

@@ -13,7 +13,7 @@ from naminter import WMNValidator
 with open("wmn-data.json", encoding="utf-8") as f:
     data = json.load(f)
 
-with open("wmn-schema.json", encoding="utf-8") as f:
+with open("wmn-data-schema.json", encoding="utf-8") as f:
     schema = json.load(f)
 
 # Create validator with schema
@@ -22,15 +22,15 @@ validator = WMNValidator(schema)
 # Validate against JSON schema
 schema_errors = validator.validate_schema(data)
 
-# Validate with custom dataset rules
-dataset_errors = WMNValidator.validate_dataset(data)
+# Validate with custom data rules
+data_errors = WMNValidator.validate_data(data)
 
-if schema_errors or dataset_errors:
+if schema_errors or data_errors:
     print(f"Validation failed:")
     for error in schema_errors:
         print(f"  Schema: {error.path}: {error.message}")
-    for error in dataset_errors:
-        print(f"  Dataset: {error.path}: {error.message}")
+    for error in data_errors:
+        print(f"  Data: {error.path}: {error.message}")
 else:
     print("Validation passed!")
 ```
@@ -41,8 +41,8 @@ The validator is also available via the CLI:
 
 ```bash
 naminter validate \
-    --local-schema schema.json \
-    --local-data data.json
+    --local-schema wmn-data-schema.json \
+    --local-data wmn-data.json
 ```
 
 ## API Reference