Merge branch 'feature/rename-to-lso' into 'develop'

Update name from LARP to LSO

See merge request !5

Jenkinsfile

 library 'SWDPipeline'
 
-SimplePythonBuild('goat-larp');
+SimplePythonBuild('goat-lso');

README.md

-# Lightweight Ansible Runner Provisioner
+# Lightweight Service Orchestrator
 
-LARP: an API that allows for remotely executing Ansible playbooks
+LSO: an API that allows for remotely executing Ansible playbooks
 
 ## Running locally
 

docs/dump-openapi-spec.py

@@ -2,7 +2,7 @@ import json
 import os
 
 from fastapi.testclient import TestClient
-import larp
+import lso
 
 config_filename = os.path.join(
     os.path.dirname(__file__),
@@ -13,7 +13,7 @@ output_filename = os.path.join(
     'source', '_static', 'openapi.json')
 
 os.environ['SETTINGS_FILENAME'] = config_filename
-app = larp.create_app()
+app = lso.create_app()
 client = TestClient(app)
 rsp = client.get('/openapi.json')
 openapi_doc = json.dumps(rsp.json(), indent=2)

docs/source/index.rst

-GOAT Ansible API
+GOAT Lightweight Service Orchestrator
 ==========================
 
-Documentation for LARP: a Lightweight Ansible Runner Provisioner
+Documentation for LSO: a Lightweight Service Orchestrator
 
 .. toctree::
    :maxdepth: 1

docs/source/quickstart.rst

@@ -15,7 +15,7 @@ Install the Module
     python3 -m venv my-venv-directory
     . my-venv-directory/bin/activate
 
-    pip install --pre --extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple goat-larp
+    pip install --pre --extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple goat-lso
 
 * Install the source code
 
@@ -24,8 +24,8 @@ Install the Module
     python3 -m venv my-venv-directory
     . my-venv-directory/bin/activate
 
-    git clone https://gitlab.geant.org/goat/gap/larp.git
-    cd larp
+    git clone https://gitlab.geant.org/goat/gap/lso.git
+    cd lso
     pip install -e .
 
     # for a full dev environment
@@ -39,7 +39,7 @@ Running the App
 
   .. code-block:: bash
 
-     SETTINGS_FILENAME=/absolute/path/to/config.json python -m goat_larp.app
+     SETTINGS_FILENAME=/absolute/path/to/config.json python -m goat_lso.app
 
 Examples
 

larp/__init__.py → lso/__init__.py

@@ -6,10 +6,10 @@ import logging
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
-from larp import environment
-from larp import config
+from lso import environment
+from lso import config
 
-from larp.routes import default
+from lso.routes import default
 
 
 def create_app():

larp/app.py → lso/app.py

 """
 default app creation
 """
-import larp
+import lso
 
-app = larp.create_app()
+app = lso.create_app()
 
 if __name__ == "__main__":
     import uvicorn
     uvicorn.run(
-        'larp.app:app',
+        'lso.app:app',
         host='0.0.0.0',
         port=44444,
         log_level='debug')

larp/routes/default.py → lso/routes/default.py

@@ -18,5 +18,5 @@ def version() -> Version:
     return {
         'api': API_VERSION,
         'module':
-            pkg_resources.get_distribution('goat-larp').version
+            pkg_resources.get_distribution('goat-lso').version
     }

setup.py

 from setuptools import setup, find_packages
 
 setup(
-    name='goat-larp',
+    name='goat-lso',
     version='0.0.1',
     author='GÉANT Orchestration & Automation Team',
     author_email='TBD',
     description='Lightweight Ansible Runner Provioner',
-    url='https://gitlab.geant.org/goat/gap/larp',
+    url='https://gitlab.geant.org/goat/gap/lso',
     packages=find_packages(),
     install_requires=[
         'jsonschema',

test/conftest.py

@@ -5,7 +5,7 @@ import tempfile
 import pytest
 from fastapi.testclient import TestClient
 
-import larp
+import lso
 
 
 @pytest.fixture
@@ -42,5 +42,5 @@ def invalid_config_file(bad_config_data):
 
 @pytest.fixture
 def client(config_file):
-    app = larp.create_app()
+    app = lso.create_app()
     yield TestClient(app)  # wait here until calling context ends

test/test_config.py

@@ -2,9 +2,7 @@ import io
 import json
 import pytest
 
-from pydantic.error_wrappers import ValidationError
-
-from larp import config
+from lso import config
 
 
 def test_config_with_file(config_file):

tox.ini

@@ -10,7 +10,7 @@ deps =
 
 commands =
     coverage erase
-    coverage run --source larp -m pytest
+    coverage run --source lso -m pytest
     coverage xml
     coverage html
     coverage report --fail-under 80