Merge pull request #135 from oslokommune/alignment

Align project files with our other packages

Author: simenheg

.gitignore

@@ -1,25 +1,12 @@
-.venv/
-.tox/
-*.egg
-*.egg-info
+.build_venv/
+.tox
+.venv
+*egg*
 *.pyc
-*__pycache__*
+
 .idea/
 
-# Distribution
 build/
-develop-eggs/
 dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-.installed.cfg
-MANIFEST
+*egg-info/
+__pycache__*

CHANGELOG.md

@@ -1,3 +1,7 @@
+## ?.?.? - Unreleased
+
+* Fixed credentials cache handling.
+
 ## 3.3.0 - 2025-06-20
 
 * Added support for Python 3.13.

Makefile

@@ -1,19 +1,55 @@
-.PHONY: all
-all: clean test bump-patch build publish-module
+GLOBAL_PY := python3
+BUILD_VENV ?= .build_venv
+BUILD_PY := $(BUILD_VENV)/bin/python
 
 .PHONY: init
-init:
-	python3 -m pip install tox black pip-tools wheel twine bumpversion
-	python3 -m piptools compile
-	python3 -m pip install -rrequirements.txt
+init: $(BUILD_VENV)
+
+$(BUILD_VENV):
+	$(GLOBAL_PY) -m venv $(BUILD_VENV)
+	$(BUILD_PY) -m pip install -U pip
+
+###
+# Development
+##
 
 .PHONY: format
-format:
-	python3 -m black .
+format: $(BUILD_VENV)/bin/black
+	$(BUILD_PY) -m black .
 
 .PHONY: test
-test:
-	python3 -m tox -p auto
+test: $(BUILD_VENV)/bin/tox
+	$(BUILD_PY) -m tox -p auto -o
+
+.PHONY: upgrade-deps
+upgrade-deps: $(BUILD_VENV)/bin/pip-compile
+	$(BUILD_VENV)/bin/pip-compile -U
+
+###
+# Releases
+##
+
+.PHONY: bump-version-patch
+bump-version-patch: $(BUILD_VENV)/bin/bump2version is-git-clean
+	$(BUILD_VENV)/bin/bump2version patch
+
+.PHONY: bump-version-minor
+bump-version-minor: $(BUILD_VENV)/bin/bump2version is-git-clean
+	$(BUILD_VENV)/bin/bump2version minor
+
+.PHONY: bump-version-major
+bump-version-major: $(BUILD_VENV)/bin/bump2version is-git-clean
+	$(BUILD_VENV)/bin/bump2version major
+
+.PHONY: build
+build: $(BUILD_VENV)/bin/setuptools $(BUILD_VENV)/bin/twine $(BUILD_VENV)/bin/wheel is-git-clean format test
+	$(BUILD_PY) setup.py sdist bdist_wheel
+
+.PHONY: publish
+publish: $(BUILD_VENV)/bin/twine
+	username=$$(op read op://Dataspeilet/pypi-upload-token/username) &&\
+	password=$$(op read op://Dataspeilet/pypi-upload-token/credential) &&\
+	$(BUILD_PY) -m twine upload -u $$username -p $$password dist/*
 
 .PHONY: is-git-clean
 is-git-clean:
@@ -31,16 +67,12 @@ clean:
 	rm -rf *.egg-info
 	rm -rf .tox
 
-.PHONY: bump-patch
-bump-patch: is-git-clean
-	bumpversion patch
+###
+# Python build dependencies
+##
 
-.PHONY: build
-build:
-	python3 setup.py sdist bdist_wheel
+$(BUILD_VENV)/bin/pip-compile: $(BUILD_VENV)
+	$(BUILD_PY) -m pip install -U pip-tools
 
-.PHONY: publish-module
-publish-module:
-	username=$$(op read op://Dataspeilet/pypi-upload-token/username) &&\
-	password=$$(op read op://Dataspeilet/pypi-upload-token/credential) &&\
-	python -m twine upload -u $$username -p $$password dist/*
+$(BUILD_VENV)/bin/%: $(BUILD_VENV)
+	$(BUILD_PY) -m pip install -U $*

okdata/sdk/auth/auth.py

@@ -93,7 +93,7 @@ def refresh_access_token(self):
             try:
                 tokens = self.token_provider.refresh_token(self._refresh_token)
             except TokenRefreshError as e:
-                log.warn(f"Error refreshing token: {e}")
+                log.warning(f"Error refreshing token: {e}")
 
         if not tokens:
             tokens = self.token_provider.new_token()
@@ -109,7 +109,7 @@ def refresh_access_token(self):
                 )
 
         self._access_token = tokens["access_token"]
-        self.file_cache.write_credentials(credentials=self)
+        self.file_cache.write_credentials(credentials=str(self))
 
     def __repr__(self):
         return json.dumps(

okdata/sdk/file_cache.py

@@ -11,11 +11,11 @@ def __init__(self, config):
         self.credentials_cache_enabled = config.get("cacheCredentials")
         self.env = config.get("env")
 
-    def write_credentials(self, credentials):
+    def write_credentials(self, credentials: str):
         if self.credentials_cache_enabled:
             filename = f"client_credentials-{self.env}.json"
             log.debug(f"Writing credentials to cache: {filename}")
-            write_to_okdata_cache(content=str(credentials), filename=filename)
+            write_to_okdata_cache(content=credentials, filename=filename)
         else:
             log.debug("Skipping write_credentials: cache is not enabled")
 

pyproject.toml

@@ -1,18 +1,21 @@
 [tool.black]
-target-version = ["py39", "py310", "py311", "py312"]
+target-version = ["py39", "py310", "py311", "py312", "py313"]
 # Keep exclude in sync with flake8 config in tox.ini
 exclude = '''
 /(
       \.git
     | \.tox
     | node_modules
     | __pycache__
+    | libs
+    | \*\.pyc
+    | \.cache
     | \.eggs
     | .*\.egg
     | .*\.egg-info
     | env
     | venv
-    | \.venv
+    | \..*venv
     | \.serverless
 )/
 '''

tests/file_cache_test.py

@@ -1,3 +1,5 @@
+import json
+
 from okdata.sdk.file_cache import FileCache
 from okdata.sdk.config import Config
 
@@ -8,14 +10,14 @@ def test_write_client_credentials():
     fc = FileCache(config)
     fc.credentials_cache_enabled = True
     cc = {"access_token": "yo", "refresh_token": "bro"}
-    fc.write_credentials(cc)
-    assert cc.__eq__(fc.read_credentials())
+    fc.write_credentials(json.dumps(cc))
+    assert cc == fc.read_credentials()
 
 
 def test_disable_cache():
     fc = FileCache(config)
     fc.credentials_cache_enabled = False
     cc = {"access_token": "yo-bro", "refresh_token": "zup-dawg"}
-    fc.write_credentials(cc)
+    fc.write_credentials(json.dumps(cc))
 
     assert fc.read_credentials() is None

tox.ini

@@ -51,10 +51,13 @@ exclude =
     .tox,
     node_modules,
     __pycache__,
+    libs,
+    *.pyc,
+    .cache,
     .eggs,
     *.egg,
     *.egg-info,
     env,
     venv,
-    .venv,
+    .*venv,
     .serverless