orchestrator-lso 2.3.0__tar.gz → 2.3.1__tar.gz

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/PKG-INFO

@@ -1,10 +1,9 @@
 Metadata-Version: 2.4
 Name: orchestrator-lso
-Version: 2.3.0
+Version: 2.3.1
 Summary: LSO, an API for remotely running Ansible playbooks.
+Author: GÉANT Orchestration and Automation Team
 Author-email: GÉANT Orchestration and Automation Team <goat@geant.org>
-Requires-Python: >=3.11,<3.14
-Description-Content-Type: text/markdown
 License-Expression: Apache-2.0
 Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: System Administrators
@@ -25,38 +24,20 @@ Classifier: Intended Audience :: Telecommunications Industry
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-License-File: LICENSE
-Requires-Dist: ansible-runner==2.4.1
+Requires-Dist: ansible-runner==2.4.2
 Requires-Dist: ansible==10.7.0
-Requires-Dist: fastapi==0.116.1
+Requires-Dist: fastapi==0.120.4
 Requires-Dist: httpx==0.28.1
-Requires-Dist: uvicorn[standard]==0.35.0
+Requires-Dist: uvicorn[standard]==0.38.0
 Requires-Dist: requests==2.32.5
-Requires-Dist: pydantic-settings==2.10.1
+Requires-Dist: pydantic-settings==2.11.0
 Requires-Dist: celery==5.5.3
 Requires-Dist: redis==5.3.1
-Requires-Dist: types-setuptools ; extra == "dev"
-Requires-Dist: types-requests ; extra == "dev"
-Requires-Dist: toml ; extra == "dev"
-Requires-Dist: types-toml ; extra == "dev"
-Requires-Dist: mypy_extensions ; extra == "dev"
-Requires-Dist: pre-commit ; extra == "dev"
-Requires-Dist: sphinx ; extra == "doc"
-Requires-Dist: sphinx-rtd-theme ; extra == "doc"
-Requires-Dist: docutils ; extra == "doc"
-Requires-Dist: pytest ; extra == "test"
-Requires-Dist: pytest-cov ; extra == "test"
-Requires-Dist: Faker ; extra == "test"
-Requires-Dist: responses ; extra == "test"
-Requires-Dist: mypy ; extra == "test"
-Requires-Dist: ruff ; extra == "test"
-Requires-Dist: jsonschema ; extra == "test"
-Requires-Dist: starlette ; extra == "test"
-Project-URL: Documentation, https://workfloworchestrator.org/lso/
+Requires-Python: >=3.11, <3.14
+Project-URL: Documentation, https://docs.gap.geant.org
+Project-URL: Homepage, https://workfloworchestrator.org/lso/
 Project-URL: Source, https://github.com/workfloworchestrator/lso
-Provides-Extra: dev
-Provides-Extra: doc
-Provides-Extra: test
+Description-Content-Type: text/markdown
 
 ![Lightweight Service Orchestrator](./docs/LSO_banner.jpg)
 [![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-lso.svg?color=%2334D058)](https://pypi.org/project/orchestrator-lso)
@@ -65,10 +46,6 @@ Provides-Extra: test
 
 LSO: an API that allows for remotely executing Ansible playbooks.
 
-## Code documentation
-
-Code documentation can be found at <https://workfloworchestrator.org/lso>
-
 ## Quick start
 
 This is a quick setup guide for running on your local machine.
@@ -104,7 +81,6 @@ This will expose the API on port 8000. The container requires some more files to
 
 ### Install the module
 
-
 As an alternative, below are a set of instructions for installing and running LSO directly on a machine.
 
 *One of these should be what you're looking for:*
@@ -112,24 +88,18 @@ As an alternative, below are a set of instructions for installing and running LS
 * Install the latest release
 
 ```bash
-  python3 -m venv my-venv-directory
-  . my-venv-directory/bin/activate
-
-  pip install orchestrator-lso
+  uv venv --python 3.12
+  uv add orchestrator-lso
 ```
 
 * Install the source code
 
 ```bash
   git clone https://github.com/workfloworchestrator/lso.git && cd lso
-  python3 -m venv my-venv-directory
-  . my-venv-directory/bin/activate
+  uv venv --python 3.12
+  . .venv/bin/activate
   
-  pip install flit
-  flit install --deps production
-  
-  # Or, for the full development environment
-  flit install --deps develop
+  uv sync --all-extras --dev
 ```
 
 ### Running the app
@@ -161,3 +131,18 @@ celery -A lso.worker worker --loglevel=info -Q lso-worker-queue
 2. ThreadPoolExecutor (Local Execution)
 
 For local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.
+
+## Contributing
+
+We use [uv](https://docs.astral.sh/uv/getting-started/installation/) to manage dependencies.
+
+To get started, run:
+
+```
+uv sync --all-extras --dev
+pre-commit install
+```
+
+## Code documentation
+
+Code documentation can be found at <https://workfloworchestrator.org/lso>

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/README.md

@@ -5,10 +5,6 @@
 
 LSO: an API that allows for remotely executing Ansible playbooks.
 
-## Code documentation
-
-Code documentation can be found at <https://workfloworchestrator.org/lso>
-
 ## Quick start
 
 This is a quick setup guide for running on your local machine.
@@ -44,7 +40,6 @@ This will expose the API on port 8000. The container requires some more files to
 
 ### Install the module
 
-
 As an alternative, below are a set of instructions for installing and running LSO directly on a machine.
 
 *One of these should be what you're looking for:*
@@ -52,24 +47,18 @@ As an alternative, below are a set of instructions for installing and running LS
 * Install the latest release
 
 ```bash
-  python3 -m venv my-venv-directory
-  . my-venv-directory/bin/activate
-
-  pip install orchestrator-lso
+  uv venv --python 3.12
+  uv add orchestrator-lso
 ```
 
 * Install the source code
 
 ```bash
   git clone https://github.com/workfloworchestrator/lso.git && cd lso
-  python3 -m venv my-venv-directory
-  . my-venv-directory/bin/activate
-  
-  pip install flit
-  flit install --deps production
+  uv venv --python 3.12
+  . .venv/bin/activate
   
-  # Or, for the full development environment
-  flit install --deps develop
+  uv sync --all-extras --dev
 ```
 
 ### Running the app
@@ -100,4 +89,19 @@ celery -A lso.worker worker --loglevel=info -Q lso-worker-queue
 ```
 2. ThreadPoolExecutor (Local Execution)
 
-For local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.
+For local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.
+
+## Contributing
+
+We use [uv](https://docs.astral.sh/uv/getting-started/installation/) to manage dependencies.
+
+To get started, run:
+
+```
+uv sync --all-extras --dev
+pre-commit install
+```
+
+## Code documentation
+
+Code documentation can be found at <https://workfloworchestrator.org/lso>

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -13,7 +13,7 @@
 
 """LSO, an API for remotely running Ansible playbooks."""
 
-__version__ = "2.3.0"
+__version__ = "2.3.1"
 
 import logging
 

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/app.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/config.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/environment.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/execute.py

@@ -1,3 +1,16 @@
+# Copyright 2023-2025 GÉANT Vereniging.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 """Module for handling the execution of arbitrary executables."""
 
 import subprocess  # noqa: S404

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/playbook.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/routes/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/routes/default.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/routes/execute.py

@@ -1,3 +1,16 @@
+# Copyright 2023-2025 GÉANT Vereniging.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 """FastAPI route for running arbitrary executables."""
 
 import asyncio

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/routes/playbook.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/lso/worker.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 GÉANT Vereniging.
+# Copyright 2023-2025 GÉANT Vereniging.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_lso-2.3.0 → orchestrator_lso-2.3.1}/pyproject.toml

@@ -1,10 +1,6 @@
-[build-system]
-build-backend = "flit_core.buildapi"
-requires = ["flit_core >=3.2,<4"]
-
 [project]
 name = "orchestrator-lso"
-dynamic = ["version"]
+version = "2.3.1"
 description = "LSO, an API for remotely running Ansible playbooks."
 readme = "README.md"
 license = "Apache-2.0"
@@ -34,23 +30,25 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
 ]
 dependencies = [
-    "ansible-runner==2.4.1",
+    "ansible-runner==2.4.2",
     "ansible==10.7.0",
-    "fastapi==0.116.1",
+    "fastapi==0.120.4",
     "httpx==0.28.1",
-    "uvicorn[standard]==0.35.0",
+    "uvicorn[standard]==0.38.0",
     "requests==2.32.5",
-    "pydantic-settings==2.10.1",
+    "pydantic-settings==2.11.0",
     "celery==5.5.3",
     "redis==5.3.1",
 ]
 
 [project.urls]
-Documentation = "https://workfloworchestrator.org/lso/"
+Homepage = "https://workfloworchestrator.org/lso/"
+Documentation = "https://docs.gap.geant.org"
 Source = "https://github.com/workfloworchestrator/lso"
 
-[project.optional-dependencies]
-test = [
+[dependency-groups]
+dev = [
+    "bumpversion",
     "pytest",
     "pytest-cov",
     "Faker",
@@ -59,6 +57,12 @@ test = [
     "ruff",
     "jsonschema",
     "starlette",
+    "types-setuptools",
+    "types-requests",
+    "toml",
+    "types-toml",
+    "mypy_extensions",
+    "pre-commit>=4.3.0",
 ]
 
 doc = [
@@ -67,15 +71,16 @@ doc = [
     "docutils",
 ]
 
-dev = [
-    "types-setuptools",
-    "types-requests",
-    "toml",
-    "types-toml",
-    "mypy_extensions",
-    "pre-commit",
-]
+[build-system]
+build-backend = "uv_build"
+requires = ["uv_build >=0.9.3,<0.10.0"]
+
+[tool.uv]
+prerelease = "if-necessary"
 
+[tool.uv.build-backend]
+module-name = "lso"
+module-root = ""
 
 [tool.mypy]
 exclude = [
@@ -181,7 +186,3 @@ ban-relative-imports = "all"
 [tool.ruff.lint.isort]
 known-third-party = []
 known-first-party = ["test", "docs"]
-
-[tool.flit.module]
-name = "lso"
-

orchestrator_lso-2.3.0/.bumpversion.cfg

@@ -1,16 +0,0 @@
-[bumpversion]
-current_version = 2.3.0
-commit = False
-tag = False
-parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<build>\d+))?
-serialize = 
-	{major}.{minor}.{patch}rc{build}
-	{major}.{minor}.{patch}
-
-[bumpversion:file:lso/__init__.py]
-search = __version__ = "{current_version}"
-replace = __version__ = "{new_version}"
-
-[bumpversion:file:Dockerfile.example]
-search = RUN pip install orchestrator-lso=="{current_version}"
-replace = RUN pip install orchestrator-lso=="{new_version}"

orchestrator_lso-2.3.0/.github/dependabot.yml

@@ -1,11 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"

orchestrator_lso-2.3.0/.github/styles/config/vocabularies/Sphinx/accept.txt

@@ -1 +0,0 @@
-param

orchestrator_lso-2.3.0/.github/styles/config/vocabularies/jargon/accept.txt

@@ -1,10 +0,0 @@
-(LSO|lso)
-[Ss]ubpackages
-Vereniging
-against
-BASIS
-A(NY|ny)
-KIND
-Ansible
-[Uu]nprocessable
-[Hh]ostnames?

orchestrator_lso-2.3.0/.github/workflows/publish-package.yaml

@@ -1,26 +0,0 @@
-name: Publish package on PyPI
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install flit
-      env:
-        FLIT_ROOT_INSTALL: 1
-    - name: Build and publish
-      env:
-        FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }}
-        FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
-      run: flit publish

orchestrator_lso-2.3.0/.github/workflows/run-linting-tests.yaml

@@ -1,43 +0,0 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
-name: Linting tests
-
-on:
-  push:
-  pull_request:
-    branches: [main]
-  workflow_call:
-
-jobs:
-  build:
-    name: Linting Tests
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.11', '3.12']
-      fail-fast: false
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install flit
-          flit install --deps develop --symlink
-        env:
-          FLIT_ROOT_INSTALL: 1
-      - name: Check formatting with ruff
-        run: |
-          ruff format --respect-gitignore --preview --check .
-      - name: Lint with ruff
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          ruff check --respect-gitignore --preview .
-      - name: Check with mypy
-        run: |
-          mypy .

orchestrator_lso-2.3.0/.github/workflows/run-unit-tests.yaml

@@ -1,28 +0,0 @@
-name: Unit tests
-on:
-  push:
-  workflow_call:
-
-jobs:
-  container_job:
-    name: Unit tests
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.11', '3.12']
-      fail-fast: false
-    container: python:${{ matrix.python-version }}-slim
-    steps:
-      # Downloads a copy of the code in your repository before running CI tests
-      - name: Check out repository code
-        uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install flit
-          flit install --deps develop --symlink
-        env:
-          FLIT_ROOT_INSTALL: 1
-      - name: Run Unit tests
-        run: pytest --cov-branch --cov=lso --cov-report=xml

orchestrator_lso-2.3.0/.github/workflows/sphinx.yaml

@@ -1,43 +0,0 @@
-name: "Sphinx: render docs"
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  docs:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python environment
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.12
-      - name: Install requirements
-        run: |
-          python -m pip install --upgrade pip
-          pip install flit
-          flit install --deps develop --symlink
-        env:
-          FLIT_ROOT_INSTALL: 1
-      - name: Build documentation
-        run: TZ=UTC sphinx-build -b html docs/source docs/build
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.3'
-      - uses: errata-ai/vale-action@reviewdog
-        with:
-          files: "docs/source/,lso/"
-          separator: ','
-          fail_on_error: true
-          vale_flags: "--glob=*.{rst,py}"
-      - uses: peaceiris/actions-gh-pages@v3
-        if: ${{ !env.ACT }}
-        with:
-          publish_branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build/
-          enable_jekyll: false

orchestrator_lso-2.3.0/.gitignore

@@ -1,15 +0,0 @@
-__pycache__
-.coverage
-.idea
-.vscode
-coverage.xml
-*.egg-info
-
-dist/
-.github/styles/*
-!.github/styles/config/
-venv/
-.venv/
-
-.DS_Store # macOS
-Thumbs.db # Windows

orchestrator_lso-2.3.0/.vale.ini

@@ -1,27 +0,0 @@
-StylesPath = .github/styles
-
-MinAlertLevel = suggestion
-
-Vocab = jargon, Sphinx
-
-Packages = proselint, Microsoft
-
-[*]
-BasedOnStyles = Vale, proselint, Microsoft
-; Found to be too intrusive
-Microsoft.Passive = NO
-; We are not a general audience
-Microsoft.GeneralURL = NO
-; It's okay to leave TODOs in the code, that's what they're for
-proselint.Annotations = NO
-; Replacing a ... with … shouldn't be holding back the entire CI pipeline
-proselint.Typography = warning
-; Same applies for not using contractions
-Microsoft.Contractions = warning
-Microsoft.Headings = NO
-Microsoft.SentenceLength = NO
-
-TokenIgnores = (:class:`\S+`),(:returns?.*:),(:param.+:),(noqa.*)
-
-[formats]
-py = rst

orchestrator_lso-2.3.0/Dockerfile.example

@@ -1,27 +0,0 @@
-FROM python:3.12-alpine
-
-WORKDIR /app
-
-# Copy in requirements files, if needed
-# These could be for Ansible Galaxy, Poetry, or a requirements.txt file
-COPY ./requirements.txt ./requirements.txt
-COPY ./ansible-galaxy-requirements.yaml ./ansible-galaxy-requirements.yaml
-
-# Install required system packages
-RUN apk add --update --no-cache gcc libc-dev libffi-dev openssh
-
-# Install the LSO python package, and additional requirements
-RUN pip install orchestrator-lso=="2.3.0"
-RUN pip install -r requirements.txt
-
-# Install required Ansible Galaxy roles and collections
-RUN ansible-galaxy install \
-                   -r ansible-galaxy-requirements.yaml \
-                   -p /app/gap/ansible
-RUN ansible-galaxy collection install \
-                   -r ansible-galaxy-requirements.yaml \
-                   -p /app/gap/ansible
-
-EXPOSE 8000
-ENTRYPOINT []
-CMD ["python", "-m",  "uvicorn", "lso.app:app", "--host", "0.0.0.0", "--port", "8000"]