chore(ci): add ci and pypi

Author: Dev Bear

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install uv
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sh
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+    - name: Install dependencies
+      run: |
+        uv venv
+        source .venv/bin/activate # Activate venv for subsequent uv commands in the same step
+        uv pip install .[dev]
+
+    - name: Check formatting with Ruff
+      run: |
+        source .venv/bin/activate
+        uv run ruff format --check .
+
+    - name: Lint with Ruff
+      run: |
+        source .venv/bin/activate
+        uv run ruff check .

.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish Python Package to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*' # Trigger on tags like v0.1.0, v1.2.3
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write # Required for trusted publishing
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install uv
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sh
+        echo "$HOME/.cargo/bin" >> $GITHUB_PATH
+
+    - name: Install build dependencies
+      run: uv pip install build --system # Install build globally in the runner
+
+    - name: Build package
+      run: uv run python -m build
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      # No need for with: password: ${{ secrets.PYPI_API_TOKEN }} if using trusted publishing
+      # Ensure you have configured trusted publishing for this repository on PyPI.
+      # If not using trusted publishing, uncomment the line above and add a PYPI_API_TOKEN secret.

.gitignore

@@ -8,3 +8,4 @@ wheels/
 
 # Virtual environments
 .venv
+.ruff_cache

README.md

@@ -108,7 +108,8 @@ if __name__ == '__main__':
         print(f"API request error: {re}")
     except Exception as e:
         print(f"An unexpected error occurred: {e}")
-```
+
+### How to Run the Example Script
 
 To run the example script (e.g., if it's `src/examples/basic.py`), ensure your virtual environment is activated and you are in the project root directory:
 
@@ -121,6 +122,59 @@ python src/examples/basic.py
 For more details on the API endpoints and responses, refer to the unofficial Gist:
 [https://gist.github.com/asianviking/b87cad7b9e0b0519f1ae8bdb8121398b](https://gist.github.com/asianviking/b87cad7b9e0b0519f1ae8bdb8121398b)
 
+## Development
+
+This section outlines tools and practices for developing `furthermore-py`.
+
+### Linting and Formatting
+
+This project uses [Ruff](https://github.com/astral-sh/ruff) for linting and code formatting to ensure code quality and consistency.
+
+**Installation:**
+
+Ruff is included as a development dependency in `pyproject.toml`. If you followed the main installation steps using `uv pip install .` or `uv sync`, and it included development dependencies (e.g., via an extras group like `dev` if configured, or by default if not specified otherwise), Ruff should already be installed. 
+
+To ensure you have all development dependencies, you can explicitly install them. If your `pyproject.toml` defines a `dev` extras group like this:
+
+```toml
+[project.optional-dependencies]
+dev = [
+  "ruff>=0.11.8",
+  # ... other dev tools
+]
+```
+
+Then install with:
+```bash
+uv pip install .[dev]
+```
+
+If development dependencies are listed directly under `[project.dependencies]` or there isn't a specific `dev` group for them, the standard `uv pip install .` or `uv sync` should suffice.
+
+**Configuration:**
+
+Ruff is configured in the `pyproject.toml` file under the `[tool.ruff]` section. This includes settings for line length, selected rules, and formatting preferences.
+
+**Usage:**
+
+Make sure your virtual environment is activated (`source .venv/bin/activate`).
+
+-   **To check for linting issues:**
+    ```bash
+    uv run ruff check .
+    ```
+
+-   **To automatically fix linting issues (where possible) and format the code:**
+    First, apply formatting:
+    ```bash
+    uv run ruff format .
+    ```
+    Then, apply lint fixes:
+    ```bash
+    uv run ruff check . --fix
+    ```
+    Ruff's formatter will handle most style issues, and `check --fix` will address other auto-fixable linting errors.
+
 ## Contributing
 
 (Details on how to contribute to this project, if applicable.)

src/client/client.py

@@ -203,11 +203,17 @@ def get_sources(self, vault_limit_for_scan: int = 100) -> dict[str, set[str]]:
 
                         # Check metadata.protocol.name as per API response structure
                         protocol_info = metadata.get("protocol")
-                        if isinstance(protocol_info, dict) and protocol_info.get("name"):
+                        if isinstance(protocol_info, dict) and protocol_info.get(
+                            "name"
+                        ):
                             protocols.add(protocol_info["name"])
 
                         incentivizer_info = metadata.get("incentivizer")
-                        if isinstance(incentivizer_info, dict) and incentivizer_info.get("name") and incentivizer_info["name"].strip():
+                        if (
+                            isinstance(incentivizer_info, dict)
+                            and incentivizer_info.get("name")
+                            and incentivizer_info["name"].strip()
+                        ):
                             incentivizers.add(incentivizer_info["name"].strip())
 
             self.logger.info(