Major Refactoring & Company Details Feature

.github/workflows/docs.yml

@@ -0,0 +1,100 @@
+name: Deploy Documentation
+
+on:
+  workflow_run:
+    workflows: ["Lint", "Run Python 🐍 tests"]
+    types:
+      - completed
+    branches:
+      - main
+
+jobs:
+  # Check if docs changed and all checks passed
+  check-and-deploy:
+    runs-on: ubuntu-latest
+    # Only proceed if the triggering workflow succeeded
+    if: github.event.workflow_run.conclusion == 'success'
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+      actions: read
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.workflow_run.head_branch }}
+
+      # Check if both required workflows have passed for this commit
+      - name: Check workflow status
+        id: check-workflows
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const commitSha = context.payload.workflow_run.head_sha;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+
+            // Get all workflow runs for this commit
+            const { data: runs } = await github.rest.actions.listWorkflowRunsForRepo({
+              owner,
+              repo,
+              head_sha: commitSha,
+              per_page: 100
+            });
+
+            // Check if both Lint and test workflows passed
+            const lintRun = runs.workflow_runs.find(run => run.name === 'Lint');
+            const testRun = runs.workflow_runs.find(run => run.name === 'Run Python 🐍 tests');
+
+            const bothPassed = 
+              lintRun?.conclusion === 'success' && 
+              testRun?.conclusion === 'success';
+
+            core.setOutput('both-passed', bothPassed);
+
+      # Check if docs changed in this commit
+      - uses: dorny/paths-filter@v3
+        id: filter
+        if: steps.check-workflows.outputs.both-passed == 'true'
+        with:
+          filters: |
+            docs:
+              - 'docs/**'
+              - 'mkdocs.yml'
+
+      # Only deploy if docs actually changed and both workflows passed
+      - name: Install uv
+        if: steps.filter.outputs.docs == 'true'
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - name: Set up Python
+        if: steps.filter.outputs.docs == 'true'
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        if: steps.filter.outputs.docs == 'true'
+        run: |
+          uv sync --extra docs --extra dev
+          # Ensure package is installed in editable mode for mkdocstrings
+          uv pip install -e ".[docs]"
+      - name: Setup Pages
+        if: steps.filter.outputs.docs == 'true'
+        uses: actions/configure-pages@v5
+      - name: Build with MkDocs
+        if: steps.filter.outputs.docs == 'true'
+        run: uv run mkdocs build
+      - name: Upload artifact
+        if: steps.filter.outputs.docs == 'true'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+      - name: Deploy to GitHub Pages
+        if: steps.filter.outputs.docs == 'true'
+        id: deployment
+        uses: actions/deploy-pages@v4
+

.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install ruff
+        run: pip install ruff==0.6.3
+      - name: Run ruff check
+        run: ruff check .
+      - name: Run ruff format check
+        run: ruff format --check .
+

.github/workflows/runtests.yml

@@ -7,13 +7,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

.gitignore

@@ -2,19 +2,88 @@
 .idea/
 *.xml
 *.iml
+.vscode/
+*.swp
+*.swo
+*~
+.project
+.pydevproject
+.settings/
 
 # Python
 __pycache__/
 *.py[cod]
 *$py.class
+*.so
+.Python
 
 # Environments
 .env
+.env.*
+!.env.example
 .venv/
 venv/
 env/
+ENV/
+env.bak/
+venv.bak/
 
 # Distribution / Packaging
 dist/
 build/
 *.egg-info/
+.eggs/
+*.egg
+*.whl
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Testing
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+.hypothesis/
+.pytest_cache/
+test-results/
+*.cover
+*.log
+.cache
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+.ruff_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*.ipynb_checkpoints/
+
+# MkDocs
+site/
+.mkdocs_cache/
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+desktop.ini
+
+# Temporary files
+*.tmp
+*.temp
+*.bak
+*.swp
+*~
+
+# Pre-commit
+.pre-commit-config.yaml.bak

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.3
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+