vnbdigital-client 0.1.0__tar.gz

vnbdigital_client-0.1.0/.devcontainer/Dockerfile

@@ -0,0 +1,28 @@
+FROM python:3.12-slim
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    curl \
+    build-essential \
+    ca-certificates \
+    gnupg \
+    && rm -rf /var/lib/apt/lists/*
+
+# Add wakemeops apt repo and install tools via wake
+RUN curl -sSL https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository | bash
+
+RUN apt-get update \
+    && apt-get install -y uv pre-commit \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create non-root user 'code'
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+RUN groupadd --gid $USER_GID code \
+    && useradd --uid $USER_UID --gid $USER_GID -m -s /bin/bash code
+
+# Set working directory
+WORKDIR /workspace
+
+USER code

vnbdigital_client-0.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+{
+  "name": "vnbdigital-client Development",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "features": {
+    "ghcr.io/devcontainers/features/common-utils:2": {
+      "username": "code",
+      "installZsh": true,
+      "ohMyZsh": true,
+      "ohMyZshTheme": "fino",
+      "configureZshAsDefaultShell": true
+    },
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  },
+  "initializeCommand": "bash -c 'TOKEN=$(gh auth token 2>/dev/null) && echo GITHUB_TOKEN=$TOKEN > .devcontainer/.env || echo GITHUB_TOKEN= > .devcontainer/.env'",
+  "runArgs": [
+    "--env-file",
+    ".devcontainer/.env"
+  ],
+  "mounts": [
+    "source=${localEnv:SSH_AUTH_SOCK},target=/ssh-agent,type=bind,consistency=cached"
+  ],
+  "containerEnv": {
+    "SSH_AUTH_SOCK": "/ssh-agent"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-python.black-formatter",
+        "charliermarsh.ruff",
+        "GitHub.copilot",
+        "GitHub.copilot-chat"
+      ],
+      "settings": {
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.linting.enabled": true,
+        "python.linting.ruffEnabled": true,
+        "python.formatting.provider": "black",
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+          "source.organizeImports": "explicit"
+        }
+      }
+    }
+  },
+  "remoteUser": "code"
+}

vnbdigital_client-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Lint with ruff
+      run: uv run --extra dev ruff check src/
+
+    - name: Format check with black
+      run: uv run --extra dev black --check src/
+
+    - name: Type check with mypy
+      run: uv run --extra dev mypy src/vnbdigital_client/
+      continue-on-error: true
+
+    - name: Run tests
+      run: uv run --extra dev pytest

vnbdigital_client-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  pypi-publish:
+    name: Version, build & publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/vnbdigital-client
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Determine version
+        id: version
+        uses: paulhatch/semantic-version@v5.4.0
+        with:
+          tag_prefix: "v"
+          major_pattern: "/(feat|fix|refactor)!:/"
+          minor_pattern: "/^feat:/"
+          version_format: "${major}.${minor}.${patch}"
+          bump_each_commit: true
+          search_commit_body: true
+
+      - name: Set version in pyproject.toml
+        run: |
+          sed -i 's/^version = ".*"/version = "${{ steps.version.outputs.version }}"/' pyproject.toml
+
+      - name: Create git tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag "v${{ steps.version.outputs.version }}"
+          git push origin "v${{ steps.version.outputs.version }}"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Build package
+        run: uv build
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ steps.version.outputs.version }}"
+          name: "v${{ steps.version.outputs.version }}"
+          generate_release_notes: true
+          files: dist/*
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

vnbdigital_client-0.1.0/.gitignore

@@ -0,0 +1,146 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# uv
+.uv/

vnbdigital_client-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-ast
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
+    hooks:
+      # Linter
+      - id: ruff
+        args: [--fix]
+      # Formatter
+      - id: ruff-format
+
+  - repo: https://github.com/psf/black
+    rev: 26.1.0
+    hooks:
+      - id: black
+        args: [--line-length=100, --target-version=py39]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-requests
+        args: [--ignore-missing-imports]
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.36.1
+    hooks:
+      - id: check-github-workflows

vnbdigital_client-0.1.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-02-08
+
+### Added
+- Initial release of vnbdigital-client
+- Python client library for accessing vnbdigital.de database
+- GraphQL abstraction layer with simple API methods:
+  - `search()` - Search for items
+  - `get_item()` - Get specific item by ID
+  - `list_collections()` - List all collections
+  - `get_collection()` - Get items from a collection
+- Command-line interface (CLI) with Click:
+  - `vnbdigital search` - Search for items
+  - `vnbdigital get` - Get specific item
+  - `vnbdigital collections` - List collections
+  - `vnbdigital collection` - Get collection items
+  - Support for JSON and table output formats
+- Project setup with uv package manager
+- pyproject.toml configuration
+- Renovate configuration for automated dependency updates
+- GitHub Actions workflows:
+  - CI workflow for testing and linting
+  - PyPI publish workflow for releases
+- Dev container support with:
+  - Dockerfile with Python 3.12 and uv
+  - VS Code devcontainer.json configuration
+- Comprehensive test suite with pytest (67% coverage)
+- Documentation:
+  - Detailed README with usage examples
+  - Contributing guidelines
+  - Example scripts
+- Code quality tools:
+  - Black for code formatting
+  - Ruff for linting
+  - mypy for type checking
+
+### Security
+- Added explicit permissions to GitHub Actions workflows
+- Passed CodeQL security scanning with no alerts
+
+[0.1.0]: https://github.com/the78mole/vnbdigital-client/releases/tag/v0.1.0

vnbdigital_client-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,247 @@
+# Contributing to vnbdigital-client
+
+Thank you for your interest in contributing to vnbdigital-client! This document provides guidelines and instructions for contributing.
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.9 or higher
+- [uv](https://github.com/astral-sh/uv) package manager
+
+### Setting Up Your Development Environment
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/the78mole/vnbdigital-client.git
+   cd vnbdigital-client
+   ```
+
+2. **Install uv:**
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   ```
+
+3. **Run directly with `uv` (automatically creates `.venv` and installs dependencies):**
+   ```bash
+   uv run --extra dev pytest
+   ```
+
+   Alternativ kannst du die Umgebung auch manuell einrichten:
+   ```bash
+   uv venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   uv pip install -e ".[dev]"
+   ```
+
+### Using Dev Container (Optional)
+
+If you use VS Code, you can use the provided dev container:
+
+1. Install the "Dev Containers" extension
+2. Open the project in VS Code
+3. Click "Reopen in Container" when prompted
+4. The workspace is mounted into the container automatically
+5. When you run the first `uv` command, it will create a `.venv` and install dependencies
+
+## Development Workflow
+
+### Running Tests
+
+```bash
+# Run all tests
+uv run --extra dev pytest
+
+# Run with coverage
+uv run --extra dev pytest --cov=vnbdigital_client --cov-report=html
+
+# Run specific test file
+uv run --extra dev pytest tests/test_client.py
+```
+
+### Code Formatting
+
+We use [Black](https://github.com/psf/black) for code formatting:
+
+```bash
+# Format code
+uv run --extra dev black src/ tests/ examples/
+
+# Check formatting without making changes
+uv run --extra dev black --check src/
+```
+
+### Linting
+
+We use [Ruff](https://github.com/astral-sh/ruff) for linting:
+
+```bash
+# Run linter
+uv run --extra dev ruff check src/
+
+# Auto-fix issues
+uv run --extra dev ruff check src/ --fix
+```
+
+### Type Checking
+
+We use [mypy](https://mypy-lang.org/) for type checking:
+
+```bash
+uv run --extra dev mypy src/vnbdigital_client/
+```
+
+### Building the Package
+
+```bash
+uv build
+```
+
+## Making Changes
+
+### Branch Naming
+
+- Feature branches: `feature/description-of-feature`
+- Bug fix branches: `fix/description-of-bug`
+- Documentation: `docs/description-of-change`
+
+### Commit Messages
+
+Follow these guidelines for commit messages:
+
+- Use present tense ("Add feature" not "Added feature")
+- Use imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters
+- Reference issues and pull requests when relevant
+
+Example:
+```
+Add support for advanced search filters
+
+- Add filter parameters to search method
+- Update CLI to accept filter options
+- Add tests for new functionality
+
+Fixes #123
+```
+
+### Pull Request Process
+
+1. **Create a new branch** from `main`
+2. **Make your changes** following the coding standards
+3. **Add or update tests** for your changes
+4. **Update documentation** if needed
+5. **Ensure all tests pass** and code is formatted
+6. **Submit a pull request** with a clear description
+
+### Pull Request Checklist
+
+Before submitting your PR, make sure:
+
+- [ ] Tests pass (`uv run --extra dev pytest`)
+- [ ] Code is formatted (`uv run --extra dev black src/ tests/`)
+- [ ] Linting passes (`uv run --extra dev ruff check src/`)
+- [ ] Type checking passes (`uv run --extra dev mypy src/vnbdigital_client/`)
+- [ ] Documentation is updated (if applicable)
+- [ ] CHANGELOG is updated (if applicable)
+- [ ] Commit messages follow guidelines
+
+## Code Style
+
+### Python Code
+
+- Follow [PEP 8](https://pep8.org/) style guide
+- Use type hints for function signatures
+- Maximum line length: 100 characters
+- Use descriptive variable names
+- Add docstrings for public functions and classes
+
+### Example:
+
+```python
+from typing import List, Dict, Any
+
+def search_items(query: str, limit: int = 10) -> List[Dict[str, Any]]:
+    """
+    Search for items matching the query.
+
+    Args:
+        query: Search query string
+        limit: Maximum number of results to return
+
+    Returns:
+        List of matching items
+
+    Raises:
+        ValueError: If query is empty
+    """
+    if not query:
+        raise ValueError("Query cannot be empty")
+
+    # Implementation here
+    return []
+```
+
+## Testing Guidelines
+
+### Writing Tests
+
+- Place tests in the `tests/` directory
+- Test files should start with `test_`
+- Test functions should start with `test_`
+- Use descriptive test names that explain what is being tested
+- Mock external API calls
+- Aim for high code coverage
+
+### Example Test:
+
+```python
+from unittest.mock import Mock, patch
+from vnbdigital_client import VNBDigitalClient
+
+@patch('vnbdigital_client.client.Client')
+def test_search_returns_results(mock_client_class):
+    """Test that search returns expected results."""
+    mock_client = Mock()
+    mock_client.execute.return_value = {
+        "search": [{"id": "1", "title": "Test"}]
+    }
+    mock_client_class.return_value = mock_client
+
+    client = VNBDigitalClient()
+    results = client.search("test")
+
+    assert len(results) == 1
+    assert results[0]["id"] == "1"
+```
+
+## Documentation
+
+### Updating README
+
+When adding new features:
+- Update the usage examples
+- Add new CLI commands to the command reference
+- Update the feature list if applicable
+
+### Code Documentation
+
+- Add docstrings to all public functions and classes
+- Use Google-style docstrings
+- Include examples in docstrings for complex functions
+
+## Getting Help
+
+If you have questions or need help:
+
+1. Check existing issues and discussions
+2. Read the README and documentation
+3. Open a new issue with the "question" label
+
+## Code of Conduct
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## License
+
+By contributing to vnbdigital-client, you agree that your contributions will be licensed under the MIT License.

vnbdigital_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Glaser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.