CU-869aa22g2 Add ElasticSearch bits from working_with_cogstack

.github/workflows/cogstack-es_main.yml

@@ -0,0 +1,42 @@
+name: cogstack-es - Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    paths:
+      - 'cogstack-es/**'
+      - '.github/workflows/cogstack-es**'
+
+defaults:
+  run:
+    working-directory: ./cogstack-es
+
+jobs:
+  types-lint-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+      max-parallel: 4
+
+    steps:
+      - uses: actions/checkout@v5
+      - 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 -r requirements.txt
+          pip install -r requirements-dev.txt
+      - name: Check types
+        run: |
+          python -m mypy --follow-imports=normal *.py
+      - name: Lint
+        run: |
+          ruff check *.py
+      - name: Test
+        run: |
+          pytest tests

cogstack-es/ReadMe.md

@@ -0,0 +1,27 @@
+
+# Login and search
+This project is responsible for logging in and performing a search.
+
+## Login details
+1. Create a [credentials.py](credentials.py)
+2. Populate it with your cogstack instance and login details
+An example template can be seen below:
+```
+hosts = []  # This is a list of your cogstack elasticsearch instances.
+
+# These are your login details (either via http_auth or API)
+username = None
+password = None
+```
+
+__Note__: If these fields are left blank then the user will be prompted to enter the details themselves.
+
+If you are unsure about the above information please contact your CogStack system administrator.
+
+## How to build a Search query
+
+A core component of cogstack is Elasticsearch which is a search engine built on top of Apache Lucene.
+
+Lucene has a custom query syntax for querying its indexes (Lucene Query Syntax). This query syntax allows for features such as Keyword matching, Wildcard matching, Regular expression, Proximity matching, Range searches.
+
+Full documentation for this syntax is available as part of Elasticsearch [query string syntax](https://www.elastic.co/guide/en/elasticsearch/reference/8.5/query-dsl-query-string-query.html#query-string-syntax).