Merge pull request #2 from 4teamwork/jch/TI-3219

Modernise lexwork repository

Author: Joel-Luca

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+# From https://github.com/4teamwork/ftw-buildouts/blob/master/pycodestyle.cfg
+ignore = E121,E122,E123,E125,E126,E127,E128,E203,E301,W503,W606
+max-line-length = 125
+exclude = .git,__pycache__,venv,.tox,manage.py,include,lib,javascript,lib,node_modules,scss,bin,.eggs,wsgi.py,wsgi.py,src,migrations,docs,gever,bootstrap.py

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+## Description
+
+
+
+
+Belongs to PBI [TI-xxx].
+
+## Checklist
+
+The following checklist should help us to stick to our "definition of done":
+
+- [ ] Proposed changes include tests.
+- [ ] Good error handling with useful messages
+- [ ] Changelog added
+- [ ] Readme has been updated if changes interfere with the setup process.

.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Linting
+
+on:
+  - push
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: self-hosted
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.13
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 2.1
+      - name: Install dependencies
+        run: poetry install
+      - name: isort
+        run: poetry run isort --check-only --quiet --settings pyproject.toml .
+      - name: flake8
+        run: poetry run flake8
+      - name: black
+        run: poetry run black --check --config pyproject.toml .

CHANGELOG.md

@@ -0,0 +1,2 @@
+# We don't release this package. This dummy MANIFEST.in stops zest.releaser
+# from complaining.

MANIFEST.in

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+git pull
+poetry run fullrelease
+poetry publish --build

bin/release

@@ -0,0 +1 @@
+!.gitignore

changes/.gitignore

@@ -0,0 +1 @@
+Modernise the GitHub Repository and add the lexwork client to pip. (`TI-3219 <https://4teamwork.atlassian.net/browse/TI-3219>`_)

changes/TI-3219.feature

@@ -1 +1,3 @@
+__all__ = ["APIClient"]
+
 from .client import APIClient

lexwork/__init__.py

@@ -45,6 +45,8 @@ def sign_pdf(self, file_like, reason, file_name=None):
         return response.json().get("result", {"signed_data": ""}).get("signed_data")
 
     def _make_request(self, path, method="get", **kwargs):
-        response = getattr(self.session, method)(urljoin(self.url, self.base_api_path, path), **kwargs)
+        response = getattr(self.session, method)(
+            urljoin(self.url, self.base_api_path, path), **kwargs
+        )
         response.raise_for_status()
         return response