mreg-cli 1.0.0__tar.gz

mreg_cli-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,128 @@
+name: build mreg-cli
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+**'
+
+concurrency:
+  group: build-mreg-cli-${{ github.head_ref }}
+
+jobs:
+  build_pypi:
+    name: Build wheels and source distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#determining-when-to-use-contexts
+      - name: Exit if not on master branch
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: exit -1
+      
+      - 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 venv
+          uv pip install --upgrade build
+
+      - name: Build source distribution
+        run: uv run python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pypi_artifacts
+          path: dist/*
+          if-no-files-found: error
+
+  build_pyinstaller:
+    name: Build pyinstaller binary
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version:
+          - '3.12'
+        include:
+          - os: ubuntu-latest
+            container: centos:8
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+
+    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: Run PyInstaller with Tox
+        run: |
+          uv venv
+          uv pip install tox-uv tox-gh-actions
+          tox
+      
+      - name: Rename binary
+        run: |
+          mv dist/mreg-cli${{ contains(matrix.os, 'windows') && '.exe' || '' }} dist/mreg-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+      
+      - uses: actions/upload-artifact@v4
+        with:
+          name: mreg-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+          path: dist/mreg-cli-${{ matrix.os }}-${{ matrix.python-version }}${{ contains(matrix.os, 'windows') && '.exe' || '' }}
+          if-no-files-found: error
+          
+  publish_pypi:
+    name: Publish PyPI release
+    needs:
+      - build_pypi
+    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@v1.8.14
+  
+  publish_github:
+    name: Publish GitHub release
+    needs:
+      - build_pypi
+      - build_pyinstaller
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download PyInstaller binaries
+        uses: actions/download-artifact@v4
+        with:
+          pattern: mreg-cli-*
+          path: dist
+          merge-multiple: true
+    
+      - name: Download wheel and source distributions
+        uses: actions/download-artifact@v4
+        with:
+          pattern: pypi_artifacts
+          path: dist
+          merge-multiple: true
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body: |
+            Release ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+    

mreg_cli-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,54 @@
+on: [push, pull_request]
+
+
+name: CI
+jobs:
+  test:
+    name: Integration
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-22.04]
+        python-version:
+          - '3.11'
+          - '3.12'
+    env:
+      # Disable colors and formatting in Rich console output
+      TERM: dumb
+    steps:
+      - name: Checkout
+        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 mreg-cli
+        run: |
+          uv venv
+          uv pip install -e .[dev]
+      - name: Test and compare api calls
+        run: uv run ci/run_testsuite_and_record.sh
+
+  tox:
+    name: tox
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+
+    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 venv
+          uv pip install tox-uv tox-gh-actions 
+      - name: Test with tox
+        run: uv run tox r
+        

mreg_cli-1.0.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_cli/_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_cli-1.0.0/AUTHORS

@@ -0,0 +1,12 @@
+Dmytro Karpenko
+Fredrik Larsen
+Magnus Hirth
+Marius Bakke
+Nico
+Nils Hiorth
+Paal Braathen
+Peder Hovdan Andresen
+Safet Amedov
+Terje Kvernes
+Øyvind Hagberg
+Øyvind Kolbu

mreg_cli-1.0.0/CHANGELOG

@@ -0,0 +1,36 @@
+# 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]
+
+The big Pydantic update. The entire codebase has been rewritten to use Pydantic for request and response validation. This brings with it a huge improvement to the development experience and the robustness of the code.
+
+### Added
+
+- `--version` option to display current application version and exit. 
+    Version number is in the form of `major.minor.patch` if installed from a published version.
+    Shows a version number including the commit hash if installed from a git repository in the form of `major.minor.patch.dev123+gabc1234`.
+    See [Default versioning scheme](https://setuptools-scm.readthedocs.io/en/latest/usage/#default-versioning-scheme) in the [setuptools_scm](https://github.com/pypa/setuptools_scm/) documentation for more information.
+  - The version can be accessed programmatically with `mreg_cli.__version__`.
+- `label set_description` command to set the description of a label.
+- `network list_excluded_ranges` command to list the excluded ranges of a network.
+- Application can now store tokens for multiple servers and will pick the correct one based on the server URL.
+- Building binaries for Windows, Linux and MacOS, and publishing the package to PyPI on each GitHub release.
+
+### Changed
+
+- The application now uses Pydantic internally to validate request and response data. This should make the code more robust and easier to maintain.
+- Application now attempts to send JSON for every request. This should improve the consistency of the API responses.
+- Version now follows Semantic Versioning 2.0.0 and is automatically determined based on the most recent git tag (`mreg-cli-v*`). As part of this change, the verison has been bumped from 0.9.10 to 1.0.0. See the Added section for more information on how version numbers are accessed.
+
+### Removed
+
+- `label rename -desc` option. Description modification is now done through the new `label set_description` command.
+
+### Fixed
+
+- Hopefully more than we broke.

mreg_cli-1.0.0/CONTRIBUTING

@@ -0,0 +1,38 @@
+# Contributing
+
+If you would like to contribute to this project, please follow these steps:
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature/branch-name`)
+3. Make changes
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin feature/branch-name`)
+6. Create a Pull Request
+
+## Publishing
+
+Publishing new versions is automatically handled by GitHub actions for versions tagged with `x.y.z[.prerelease]` (`1.2.3`, `1.2.3.rc1`, etc.). If you are a maintainer, you can create a new release by following these steps:
+
+1. Switch to the `master` branch:
+
+```bash
+git checkout master
+```
+
+2. Create a new tag:
+
+```bash
+git tag 1.2.3
+```
+
+3. Push the tag to the upstream repository:
+
+```bash
+git push upstream 1.2.3
+```
+
+To push a tag together with a new commit:
+
+```bash
+git push upstream master --tags
+```