mreg-api 0.1.0__tar.gz

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

@@ -0,0 +1,152 @@
+name: build mreg-api
+
+on:
+    push:
+        tags:
+            - "[0-9]+.[0-9]+.[0-9]+*"
+
+concurrency:
+    group: build-mreg-api-${{ github.head_ref }}
+
+env:
+    UV_FROZEN: 1
+
+jobs:
+    build_pypi:
+        name: Build wheels and source distribution
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0 # Fetch all history to verify tag is on main
+
+            - name: Exit if tag is not on main branch
+              run: |
+                  if ! git branch -r --contains HEAD | grep -q 'origin/main'; then
+                    echo "Error: Tagged commit is not on the main branch"
+                    exit 1
+                  fi
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@v2
+
+            - name: Set up Python 3.12
+              run: uv python install 3.12
+
+            - name: Install build dependencies
+              run: uv sync
+
+            - name: Build source distribution
+              run: uv build
+
+            - uses: actions/upload-artifact@v4
+              with:
+                  name: pypi_artifacts
+                  path: dist/*
+                  if-no-files-found: error
+
+    publish_github:
+        name: Publish GitHub release
+        needs:
+            - build_pypi
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Download wheel and source distributions
+              uses: actions/download-artifact@v4
+              with:
+                  pattern: pypi_artifacts
+                  path: dist
+                  merge-multiple: true
+
+            - name: Generate SHA256 checksums
+              id: sha
+              run: |
+                  cd dist
+                  echo "checksums<<EOF" >> $GITHUB_OUTPUT
+                  sha256sum * >> $GITHUB_OUTPUT
+                  echo "EOF" >> $GITHUB_OUTPUT
+
+            - name: Create GitHub release
+              uses: softprops/action-gh-release@v2
+              with:
+                  files: dist/*
+                  body: |
+                      Release ${{ github.ref_name }}
+
+                      ## Installation Instructions
+
+                      ### uv
+
+                      ```bash
+                      uv tool install mreg-api==${{ github.ref_name }}
+                      ```
+
+                      ### pipx
+
+                      ```bash
+                      pipx install mreg-api==${{ github.ref_name }}
+                      ```
+
+                      ### pip
+
+                      ```bash
+                      pip install mreg-api==${{ github.ref_name }}
+                      ```
+
+                      ## SHA256 Checksums
+                      ```
+                      ${{ steps.sha.outputs.checksums }}
+                      ```
+                  draft: false
+                  prerelease: false
+
+    # GitHub releases can be republished, but PyPI uploads are permanent.
+    # Ensure all steps succeed before publishing to PyPI.
+    publish_pypi:
+        name: Publish PyPI release
+        needs:
+            - build_pypi # redundant but explicit
+            - publish_github
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: write
+        steps:
+            - uses: actions/download-artifact@v4
+              with:
+                  name: pypi_artifacts
+                  path: dist
+
+            - name: Push build artifacts to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+
+    rollback_on_failure:
+        name: Rollback on publish failure
+        if: ${{ always() && (needs.publish_github.result == 'failure' || needs.publish_pypi.result == 'failure') }}
+        needs:
+            - publish_github
+            - publish_pypi
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+            - name: Rollback GitHub release and tag
+              if: ${{ needs.publish_github.result == 'success' }}
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                  echo "Deleting GitHub release..."
+                  gh release delete ${{ github.ref_name }} --repo ${{ github.repository }} --yes || true
+
+                  echo "Deleting git tag..."
+                  git push --delete origin "refs/tags/${{ github.ref_name }}" || true
+            - name: Rollback notification
+              run: |
+                  echo "::notice::Rolling back release ${{ github.ref_name }} due to publish failure"
+                  echo "GitHub release status: ${{ needs.publish_github.result }}"
+                  echo "PyPI publish status: ${{ needs.publish_pypi.result }}"

mreg_api-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+on:
+  push:
+  pull_request:
+
+env:
+  UV_FROZEN: 1
+
+name: Tests
+jobs:
+  test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync
+      - name: Run unit tests
+        run: uv run pytest -vv

mreg_api-0.1.0/.gitignore

@@ -0,0 +1,112 @@
+# 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/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+mreg_api/_version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+ci/new_testsuite_log.json
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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/
+
+# PyCharm
+.idea/*
+mreg/.idea
+
+*.log

mreg_api-0.1.0/.markdownlint.json

@@ -0,0 +1,9 @@
+{
+    "default": true,
+    "no-duplicate-heading": {
+        "siblings_only": true
+    },
+    "line-length": false,
+    "no-bare-urls": false,
+    "no-inline-html": false
+}

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

@@ -0,0 +1,25 @@
+# This is the configuration file for prek (drop-in replacement for pre-commit).
+# See:
+# - https://pre-commit.com/
+# - https://github.com/j178/prek?tab=readme-ov-file#prek
+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-added-large-files
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.14.11
+    hooks:
+      # Run the linter.
+      - id: ruff-check
+        args: [--fix]
+      # Run the formatter.
+      - id: ruff-format
+  # - repo: https://github.com/DetachHead/basedpyright-prek-mirror
+  #   rev: 1.37.1
+  #   hooks:
+  #       - id: basedpyright
+  #         exclude: ^(tests|scripts|docs)/

mreg_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- ## Unreleased -->
+
+## [0.1.0](https://github.com/unioslo/mreg-api/releases/tag/0.1.0) - 2026-01-27
+
+### Added
+
+- Initial release of MREG API client library.

mreg_api-0.1.0/CLAUDE.md

@@ -0,0 +1,145 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+MREG API is a Python client library for interacting with the MREG network registry system. It provides Pydantic-based models for type-safe API interactions, caching, and configuration management.
+
+**Current Status:** This project is being extracted from the mreg-cli codebase to create a standalone API client library. Many files have been copied with minor name changes (e.g., `cli` -> `api`), but the architecture will be significantly refactored to support API-only usage without CLI dependencies.
+
+**Key Technologies:**
+
+- Python 3.11+ (supports 3.11, 3.12, 3.13)
+- Pydantic v2 for data validation and models
+- requests for HTTP operations
+- diskcache for persistent caching
+- pytest for testing
+
+## Development Commands
+
+### Environment Setup
+
+```bash
+# Install dependencies (uses uv for fast dependency resolution)
+uv pip install -e ".[dev]"
+```
+
+### Code Quality
+
+```bash
+# Lint with ruff (check only)
+ruff check .
+
+# Lint and auto-fix issues
+ruff check --fix .
+
+# Format code
+ruff format .
+
+# Combined lint + format (recommended before commits)
+ruff check --fix . && ruff format .
+```
+
+### Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run tests with verbose output
+pytest -v
+
+# Run specific test file
+pytest path/to/test_file.py
+
+# Run tests matching pattern
+pytest -k "pattern"
+```
+
+### Building
+
+```bash
+# Build distribution packages
+python -m build
+```
+
+## Code Style
+
+### Ruff Configuration
+
+- Line length: 99 characters
+- Target: Python 3.11+
+- Import style: One import per line (`force-single-line = true`)
+- Required import: `from __future__ import annotations` in all files
+
+### Enabled Lints
+
+- flake8-builtins (A)
+- flake8-unused-arguments (ARG)
+- flake8-bugbear (B)
+- pydocstyle (D) - requires docstrings
+- Error checking (E, F)
+- isort (I) for import sorting
+- Pylint conventions and errors (PLC, PLE)
+
+### Docstring Style
+
+- Multi-line docstrings: Summary on first line (D212)
+- No blank line before class docstring (D211)
+- Use triple double quotes (D300)
+
+## Important Notes
+
+### Work in Progress
+
+This codebase is in active development as it's being extracted from mreg-cli. The current code structure is temporary and will undergo significant architectural changes. Do not assume the current patterns and module organization are final.
+
+### Missing/Incomplete Modules
+
+Several modules are referenced but not yet implemented or need to be refactored:
+
+- `mreg_api/dirs.py` - Directory/path constants
+- `mreg_api/outputmanager.py` - Output formatting (may be removed or refactored)
+- `mreg_api/choices.py` - Choice enums
+- `mreg_api/__about__.py` - Package metadata
+
+### Testing
+
+- Tests use pytest with `pytest-httpserver` for mocking HTTP
+- Use `inline-snapshot` for snapshot testing
+- Test files should be in a `tests/` directory (to be created)
+- Test files excluded from strict docstring requirements
+
+### Dependencies
+
+Core dependencies are minimal:
+
+- requests (with SOCKS proxy support)
+- pydantic v2.7.1+
+- pydantic-extra-types
+- platformdirs
+- diskcache
+
+Dev dependencies include ruff, pytest, and build tools.
+
+### Refactoring Roadmap
+
+#### Goal
+
+Transform this CLI codebase into a clean, standalone API client library for programmatic use.
+
+#### Key Changes
+
+- Remove CLI-specific logic and output methods from models
+- Preserve current CRUD semantics (`fetch*`, `create`, `update`, `delete` methods)
+- Create `mreg_api/client.py` with `MregClient` class for session management
+  - Handles authentication, base URL, session state
+  - Replace global session state with client instance (singleton pattern recommended)
+  - Migrate `get`/`post`/`patch`/`delete` from `utilities/api.py` to client methods
+- Rename `MregCliConfig` to remove CLI references
+- **Token file handling:** Do NOT change semantics - CLI users depend on this for auth persistence
+
+#### Fragile Modules
+
+- `mreg_api/api/history.py` - Complex filtering logic, brittle code