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

Rename to LARP

See merge request goat/gap/ansible-api!2

Jenkinsfile

 library 'SWDPipeline'
 
-SimplePythonBuild('goat-ansible-api');
+SimplePythonBuild('goat-larp');

README.md

-# Ansible API
+# Lightweight Ansible Runner Provisioner
 
-And API that allows for remotely executing Ansible playbooks
+LARP: 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 ansible_api
+import larp
 
 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 = ansible_api.create_app()
+app = larp.create_app()
 client = TestClient(app)
 rsp = client.get('/openapi.json')
 openapi_doc = json.dumps(rsp.json(), indent=2)

docs/source/conf.py

@@ -48,7 +48,7 @@ def setup(app):
 
 # -- Project information -----------------------------------------------------
 
-project = 'Ansible API'
+project = 'Lightweight Ansible Runner Provisioner'
 copyright = '2023, GÉANT'
 author = 'GÉANT Orchestration & Automation Team'
 

docs/source/index.rst

 GOAT Ansible API
 ==========================
 
-Documentation for the GOAT Ansible API
+Documentation for LARP: a Lightweight Ansible Runner Provisioner
 
 .. 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-ansible-api
+    pip install --pre --extra-index-url https://artifactory.software.geant.org/artifactory/api/pypi/geant-swd-pypi/simple goat-larp
 
 * 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/ansible-api.git
-    cd ansible-api
+    git clone https://gitlab.geant.org/goat/gap/larp.git
+    cd larp
     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 ansible_api.app
+     SETTINGS_FILENAME=/absolute/path/to/config.json python -m goat_larp.app
 
 Examples
 

ansible_api/__init__.py → larp/__init__.py

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

ansible_api/app.py → larp/app.py

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

ansible_api/routes/default.py → larp/routes/default.py

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

setup.py

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

tox.ini

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