Update from 1.0.2 to 1.1.0

.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install Dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements-lint.txt
+    - name: Lint
+      shell: bash
+      run: |
+        pylint nomad/
+        black --check -l 120 -t py312 nomad/

.github/workflows/main.yml

@@ -0,0 +1,65 @@
+# 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: Python Nomad Test and Publish
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  registry_package:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      NOMAD_IP: '127.0.0.1'
+      NOMAD_PORT: '4646'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.8', '3.13'] # the oldest and newest support versions
+        nomad-version: ['1.4.14', '1.5.17', '1.6.10', '1.7.7', '1.8.4', '1.9.5']
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Setup Nomad ${{ matrix.nomad-version }}
+      env:
+        NOMAD_VERSION: ${{ matrix.nomad-version }}
+      shell: bash
+      run: |
+        echo ${NOMAD_VERSION}
+
+        echo "downloading nomad"
+        curl -L -o /tmp/nomad_${NOMAD_VERSION}_linux_amd64.zip https://releases.hashicorp.com/nomad/${NOMAD_VERSION}/nomad_${NOMAD_VERSION}_linux_amd64.zip
+
+        echo "unzip nomad"
+        unzip -o -d /usr/local/bin/ /tmp/nomad_${NOMAD_VERSION}_linux_amd64.zip
+        chmod +x /usr/local/bin/nomad
+        /usr/local/bin/nomad version
+    - name: Install Dependencies
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r requirements-dev.txt
+    - name: Before Tests
+      shell: bash
+      run: |
+        nomad init example.nomad
+        nomad run -output example.nomad > example.json
+    - name: Unit and Integration Tests
+      env:
+        NOMAD_VERSION: ${{ matrix.nomad-version }}
+      shell: bash
+      run: |
+        ./run_tests.sh
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+    - name: Install Dependencies
+      shell: bash
+      run: pip install build
+    - name: Create Package
+      shell: bash
+      run: python -m build --sdist --wheel
+    - name: Publish/Release Package
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -5,3 +5,8 @@
 .vagrant
 .build
 .venv
+
+# dev related files
+example.json
+example.nomad
+nomad.log

.pylintrc

@@ -0,0 +1,6 @@
+[FORMAT]
+# Maximum number of characters on a single line.
+max-line-length=120
+
+[MESSAGES CONTROL]
+disable=duplicate-code

CHANGELOG.md

@@ -0,0 +1,27 @@
+**Changes of the next versions will be published in the [releases](https://github.com/jrxFive/python-nomad/releases) section of the repository**
+
+## 2.0.1
+* update parameters in `Job` functions by @IgnacioHeredia #153
+* Fix nodes API filter by @bernardoVale #162
+* Read env variables on __init__ by @atwam #157
+
+## 2.0.0
+### BREAKING CHANGES
+* Drop Python 2 and Python 3.6 support
+* Rename `id` arguments to `id_` across of code base
+* Rename `type` arguments to `type_` across of code base
+### Other changes
+* Add more missing parameters to allocations.get_allocations()
+* Up `requests` lib version to 2.28.1
+* Add missing parameters to allocations.get_allocations and jobs.get_jobs (#144). Thanks @Kamilcuk
+* Add option for custom user agent (#150)
+* Add missing parameters to nodes.get_nodes (#152).
+## 1.5.0
+* Add `namespace` argument support for `get_allocations` and `get_deployments` endpoints (#133)
+* Add Python 3.10 support (#133)
+* Add support for pre-populated Sessions (#132)
+* Add scaling policy endpoint (#136)
+* Drop Python 3.5 support
+* Up `requests` lib version 
+* Add support for /var and /vars endpoints ()
+* Add support for /search endpoint (#134)

CONTRIBUTING.md

@@ -180,7 +180,7 @@ class <Endpoint>(Requester):
     ENDPOINT = "<endpoint>" 
 
     def __init__(self, **kwargs):
-        super(<Endpoint>, self).__init__(**kwargs)
+        super().__init__(**kwargs)
 ```
 
 ##### Entity
@@ -249,7 +249,7 @@ class cat(Requester):
     ENDPOINT = "client/fs/cat"
 
     def __init__(self, **kwargs):
-        super(cat, self).__init__(**kwargs)
+        super().__init__(**kwargs)
 
     def read_file(self, id=None, path="/"):
         """ Read contents of a file in an allocation directory.
@@ -382,7 +382,7 @@ class <Endpoint>(Requester):
     ENDPOINT = "<endpoint>" 
 
     def __init__(self, **kwargs):
-        super(<Endpoint>, self).__init__(**kwargs)
+        super().__init__(**kwargs)
 
     def __str__(self):
         return "{0}".format(self.__dict__)

README.md

@@ -1,9 +1,13 @@
 # python-nomad
 
 
-Branch | Status | Coverage |
----| ---| ---
-master | [![Build Status](https://travis-ci.org/jrxFive/python-nomad.svg?branch=master)](https://travis-ci.org/jrxFive/python-nomad) | [![codecov](https://codecov.io/gh/jrxFive/python-nomad/branch/master/graph/badge.svg)](https://codecov.io/gh/jrxFive/python-nomad)
+[![Python Nomad Test and Publish](https://github.com/jrxFive/python-nomad/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/jrxFive/python-nomad/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/jrxFive/python-nomad/branch/master/graph/badge.svg)](https://codecov.io/gh/jrxFive/python-nomad)
+[![PyPI version](https://badge.fury.io/py/python-nomad.svg)](https://badge.fury.io/py/python-nomad)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/python-nomad.svg)](https://pypi.python.org/pypi/python-nomad/)
+[![Downloads](https://pepy.tech/badge/python-nomad/month)](https://pepy.tech/project/python-nomad)
+[![Downloads](https://static.pepy.tech/personalized-badge/python-nomad?period=total&units=international_system&left_color=black&right_color=blue&left_text=Downloads)](https://pepy.tech/project/python-nomad)
+[![PyPI license](https://img.shields.io/pypi/l/python-nomad.svg)](https://pypi.python.org/pypi/python-nomad/)
 
 
 ## Installation
@@ -34,6 +38,9 @@ n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=True, cert=
 # For HTTPS Nomad instances with cert file and key
 n = nomad.Nomad(host="https://172.16.100.10", secure=True, timeout=5, verify=True, cert=("/path/to/certfile", "/path/to/key")) # See http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification
 
+# For HTTPS Nomad instance with cert file and key and CA file
+n = nomad.Nomad(host="https://172.16.100.10", secure=True, timeout=5, verify="/path/to/cacert", cert=("/path/to/certfile", "/path/to/key"))
+
 # For HTTPS Nomad instances with namespace and acl token
 n = nomad.Nomad(host="172.16.100.10", secure=True, timeout=5, verify=False, namespace='Namespace-example',token='3f4a0fcd-7c42-773c-25db-2d31ba0c05fe')
 
@@ -48,14 +55,16 @@ n.job.deregister_job(j)
 
 ## Environment Variables
 
-This library also supports environment variables: `NOMAD_ADDR`, `NOMAD_NAMESPACE`, `NOMAD_TOKEN`, `NOMAD_REGION` for ease of configuration
-and unifying with nomad cli tools and other libraries.
+This library also supports environment variables: `NOMAD_ADDR`, `NOMAD_NAMESPACE`, `NOMAD_TOKEN`, `NOMAD_REGION`, `NOMAD_CLIENT_CERT`, and `NOMAD_CLIENT_KEY`
+for ease of configuration and unifying with nomad cli tools and other libraries.
 
 ```bash
 NOMAD_ADDR=http://127.0.0.1:4646
 NOMAD_NAMESPACE=default
 NOMAD_TOKEN=xxxx-xxxx-xxxx-xxxx
 NOMAD_REGION=us-east-1a
+NOMAD_CLIENT_CERT=/path/to/tls/client.crt
+NOMAD_CLIENT_KEY=/path/to/tls/client.key
 ```
 
 ## Class Dunders
@@ -68,6 +77,7 @@ NOMAD_REGION=us-east-1a
 |client|N|N|N|N
 |evaluation|Y|N|Y|N
 |evaluations|Y|Y|Y|Y
+|event|N|N|N|N
 |job|Y|N|Y|N
 |jobs|Y|Y|Y|Y
 |node|Y|N|Y|N
@@ -90,8 +100,8 @@ NOMAD_REGION=us-east-1a
 * can either use the Vagrantfile for local integration testing or create environment variables `NOMAD_IP` and `NOMAD_PORT` that are assigned to a nomad binary that is running
 
 ```
-virutalenv venv
-source venv/bin/activate
+virtualenv .venv
+source .venv/bin/activate
 pip install -r requirements-dev.txt
 ```
 
@@ -117,6 +127,7 @@ NOMAD_IP=127.0.0.1 NOMAD_VERSION=<SEMNATIC_VERSION> py.test --cov=nomad --cov-re
     - [x] Client [:link:](docs/api/client.md)
     - [x] Evaluation [:link:](docs/api/evaluation.md)
     - [x] Evaluations [:link:](docs/api/evaluations.md)
+    - [x] Event [:link:](docs/api/event.md)
     - [x] Job [:link:](docs/api/job.md)
     - [x] Jobs [:link:](docs/api/jobs.md)
     - [x] Namespace [:link:](docs/api/namespace.md)
@@ -125,6 +136,9 @@ NOMAD_IP=127.0.0.1 NOMAD_VERSION=<SEMNATIC_VERSION> py.test --cov=nomad --cov-re
     - [x] Nodes [:link:](docs/api/nodes.md)
     - [x] Regions [:link:](docs/api/regions.md)
     - [x] Sentinel [:link:](docs/api/sentinel.md)
+    - [x] Search [:link:](docs/api/search.md)
     - [x] Status [:link:](docs/api/status.md)
     - [x] System [:link:](docs/api/system.md)
     - [x] Validate [:link:](docs/api/validate.md)
+    - [x] Variable [:link:](docs/api/variable.md)
+    - [x] Variables [:link:](docs/api/variables.md)