Merge pull request #13 from f-klubben/feat/package

Add pyproject.toml

Author: krestenlaust

.github/workflows/black.yml

@@ -14,4 +14,4 @@ jobs:
     - name: Black Code Formatter
       uses: lgeiger/[email protected]
       with:
-        args: --check --target-version py312 --line-length 120 --skip-string-normalization *.py
+        args: --check --target-version py312 --line-length 120 --skip-string-normalization src tests

.github/workflows/django.yml

@@ -27,6 +27,7 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r requirements.txt
         pip install coverage  # Explicitly install coverage
+        pip install . # Install self locally for pytest
     - name: Run Tests
       run: |
         coverage run --source=. -m pytest

.gitignore

@@ -0,0 +1,6 @@
+*.pyc
+*.pyo
+/dist
+/build
+/ez_setup.py
+/*.egg-info

README.md

@@ -1,3 +1,31 @@
 # Vipps Report API
 
 This is the Vipps-MobilePay accounting API implementation from f-klubben/stregsystemet. This is an experiment to fully type the implementation to make it more robust.
+
+## Development
+
+### Tests
+
+Install pytest in your environment: `pip install pytest`
+
+
+To make Pytest successfully import the library, it has to be installed locally in editable mode.
+
+`pip install --editable .`
+
+
+You should now be able to run Pytest
+
+`pytest` (for some installations you may need to explicitly lookup the module `python -m pytest`)
+
+
+### Typechecking
+
+Static analysis is done using Mypy.
+
+Install mypy in your environment `pip install mypy`
+
+
+You should simply be anble to run Mypy
+
+`mypy .` (might need explicit invocation `python -m mypy`)

pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vipps-api"
+description = "An implementation of Vipps-MobilePay API (Supports Report API)"
+readme = "README.md"
+license = { file = "LICENSE" }
+version = "0.1.0"
+
+maintainers = [
+    { name = "F-Klubben", email = "[email protected]" }
+]
+
+authors = [
+    { name = "Falke Carlsen" },
+    { name = "Kresten Laust", email = "[email protected]" },
+    { name = "Jonas B. Andersen" },
+    { name = "Bo Andersen" },
+    { name = "Asger Weirsøe" },
+]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3 :: Only",
+    "Operating System :: OS Independent",
+]
+
+requires-python = ">= 3.10"
+
+dependencies = [
+    "Django>=2.2",
+    "requests>=2.24.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/f-klubben/vipps_api"
+Repository = "https://github.com/f-klubben/vipps_api.git"
+Issues = "https://github.com/f-klubben/vipps_api/issues"

src/vipps_api/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

vipps_api.py src/vipps_api/accounting.pyvipps_api.py renamed to src/vipps_api/accounting.py

@@ -1,10 +1,11 @@
 import pytest
 from pathlib import Path
-from vipps_api import *
 
 from unittest.mock import patch
 from http import HTTPStatus
 
+from vipps_api.accounting import *
+
 
 @pytest.fixture
 def mock_ledger_info_response():