Create release 0.1.0

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+# This workflow will install Python dependencies and run tests
+name: Python application
+
+on:
+  push:
+    branches: [master, devel]
+  pull_request:
+    branches: [master, devel]
+
+jobs:
+
+  test-packaging:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Poetry
+        run: |
+          pipx install poetry
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          architecture: 'x64'
+
+      - name: Run poetry install
+        run: |
+          poetry env use '3.11'
+          poetry install
+
+      - name: Run pytest
+        run: |
+          poetry run pytest
+
+      - name: Run import checker
+        run: |
+          poetry run isort --check .
+
+      - name: Run code style checker
+        run: |
+          poetry run pflake8
+
+      - name: Run code formatter
+        run: |
+          poetry run black --check src tests

.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+*~
+__pycache__
+*.egg-info
+.vscode
+.eggs
+build
+.pytest_cache
+.vscode

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log for npg_porch Project
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/).
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-07-23
+
+### Added
+
+# Initial project scaffold, code and tests

README.md

@@ -1,2 +1,67 @@
 # npg_porch_cli
-A command-line client to enable communication with the npg_porch API.
+
+A command-line client and a simple client library to enable communication
+with the [npg_porch](https://github.com/wtsi-npg/npg_porch) JSON API.
+
+Provides a Python script, `npg_porch_client`, and a Python client API.
+
+NPG_PORCH_TOKEN environment variable should be set to the value of either
+the admin or project-specific token. The token should be pre-registered in
+the database that is used by the `porch` API server.
+
+The project can be deployed with pip or poetry in a standard way.
+
+Example of using a client API:
+
+``` python
+ from npg_porch_cli.api import PorchRequest
+
+ pr = PorchRequest(porch_url="https://myporch.com")
+ response = pr.send(action="list_pipelines")
+
+ pr = PorchRequest(
+    porch_url="https://myporch.com",
+    pipeline_name="Snakemake_Cardinal",
+    pipeline_url="https://github.com/wtsi-npg/snakemake_cardinal",
+    pipeline_version="1.0",
+ )
+ response = pr.send(
+    action="update_task",
+    task_status="FAILED",
+    task_input={"id_run": 409, "sample": "Valxxxx", "id_study": "65"},
+ )
+```
+
+By default the client validates the certificate of the server's certification
+authority (CA). If the server's certificate is signed by a custom CA, set the
+`SSL_CERT_FILE` environment variable to the path of the CA's certificate.
+Python versions starting from 3.11 seem to have increased security precautions
+when validating certificates of custom CAs. It might be necessary to set the
+`REQUESTS_CA_BUNDLE` environmental variable, see details
+[here](https://requests.readthedocs.io/en/latest/user/advanced/#ssl-cert-verification).
+
+``` bash
+ export NPG_PORCH_TOKEN='my_token'
+ export SSL_CERT_FILE=/path_to/my.pem
+ npg_porch_client list_pipelines --base_url https://myporch.com
+```
+
+It is possible, but not recommended, to disable this validation check.
+
+``` bash
+ export NPG_PORCH_TOKEN='my_token'
+ npg_porch_client list_pipelines --base_url https://myporch.com --no-validate_ca_cert
+```
+
+A valid JSON string is required for the `--task_json` script's argument, note
+double quotes in the example below.
+
+``` bash
+ export NPG_PORCH_TOKEN='my_token'
+ npg_porch_client update_task --base_url https://myporch.com \
+   --pipeline Snakemake_Cardinal \
+   --pipeline_url 'https://github.com/wtsi-npg/snakemake_cardinal' \
+   --pipeline_version 1.0 \
+   --task_json '{"id_run": 409, "sample": "Valxxxx", "id_study": "65"}' \
+   --status FAILED
+```

pyproject.toml

@@ -0,0 +1,55 @@
+[tool.poetry]
+name = "npg_porch_cli"
+version = "0.1.0"
+authors = [
+    "Marina Gourtovaia",
+    "Kieron Taylor",
+    "Jennifer Liddle",
+]
+description = "CLI client for communicating with npg_porch JSON API"
+readme = "README.md"
+license = "GPL-3.0-or-later"
+
+[tool.poetry.scripts]
+npg_porch_client = "npg_porch_cli.api_cli_user:run" 
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.31.0"
+
+[tool.poetry.dev-dependencies]
+black = "^22.3.0"
+pyproject-flake8 = "^7.0.0"
+flake8-bugbear = "^24.4.0"
+pytest = "^7.1.1"
+isort = { version = "^5.10.1", extras = ["colors"] }
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.isort]
+profile = "black"
+
+[tool.black]
+line_length = 88
+
+[tool.flake8]
+max-line-length = 88
+extend-select = ["B950"]
+extend-ignore = ["E501"]
+exclude = [
+    # No need to traverse our git directory
+    ".git",
+    # There's no value in checking cache directories
+    "__pycache__"
+]
+per-file-ignores = """
+        # Disable 'imported but unused'
+        __init__.py: F401
+    """
+
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]

src/npg_porch_cli/__init__.py

@@ -0,0 +1 @@
+from .api import send_request