sevdesk 0.1.0__tar.gz

sevdesk-0.1.0/LICENSE

@@ -0,0 +1,33 @@
+MIT License
+
+Copyright (c) 2025 Maximilian Clemens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+ÜBERSETZUNG, MAßGEBLICH BLEIBT ABER DIE ENGLISCHE ORIGINAL FASSUNG
+
+Copyright (c) 2025 Maximilian Clemens
+
+Jedem, der eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die „Software“) erhält, wird hiermit kostenlos die Erlaubnis erteilt, ohne Einschränkung mit der Software zu handeln, einschließlich und ohne Einschränkung der Rechte zur Nutzung, zum Kopieren, Ändern, Zusammenführen, Veröffentlichen, Verteilen, Unterlizenzieren und/oder Verkaufen von Kopien der Software, und Personen, denen die Software zur Verfügung gestellt wird, dies unter den folgenden Bedingungen zu gestatten:
+
+Der obige Urheberrechtshinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.
+
+DIE SOFTWARE WIRD OHNE MÄNGELGEWÄHR UND OHNE JEGLICHE AUSDRÜCKLICHE ODER STILLSCHWEIGENDE GEWÄHRLEISTUNG, EINSCHLIEẞLICH, ABER NICHT BESCHRÄNKT AUF DIE GEWÄHRLEISTUNG DER MARKTGÄNGIGKEIT, DER EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND DER NICHTVERLETZUNG VON RECHTEN DRITTER, ZUR VERFÜGUNG GESTELLT. DIE AUTOREN ODER URHEBERRECHTSINHABER SIND IN KEINEM FALL HAFTBAR FÜR ANSPRÜCHE, SCHÄDEN ODER ANDERE VERPFLICHTUNGEN, OB IN EINER VERTRAGS- ODER HAFTUNGSKLAGE, EINER UNERLAUBTEN HANDLUNG ODER ANDERWEITIG, DIE SICH AUS ODER IN VERBINDUNG MIT DER SOFTWARE ODER DER NUTZUNG ODER ANDEREN GESCHÄFTEN MIT DER SOFTWARE ERGEBEN. 

sevdesk-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: sevdesk
+Version: 0.1.0
+Summary: A Python client for the sevDesk API, automatically generated from the OpenAPI specification
+Author: Claude, ChatGPT, Copilot
+Author-email: Maximilian Clemens <maximilian.clemens@gamma.red>
+License: MIT
+Project-URL: Homepage, https://github.com/MaximilianClemens/python-sevdesk
+Project-URL: Repository, https://github.com/MaximilianClemens/python-sevdesk
+Project-URL: Issues, https://github.com/MaximilianClemens/python-sevdesk/issues
+Keywords: sevdesk,api,client,accounting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic
+Requires-Dist: requests
+Requires-Dist: PyYAML
+Requires-Dist: jinja2
+Dynamic: license-file
+
+# sevDesk API Client (Inoffiziell)
+
+Ein Python-Client für die sevDesk API, automatisch generiert aus der OpenAPI-Spezifikation. Dies ist notwendig, da sich die sevdesk-Spezifikation mit dem Standard OpenApi-Generator nicht parsen lässt.
+
+## ⚠️ Wichtige Hinweise
+
+- **Dies ist KEINE offizielle sevDesk Library**
+- Ich arbeite nicht für sevDesk und bin nicht mit sevDesk verbunden
+- **Nutzung auf eigene Gefahr**
+- Keine Garantie für Funktionalität oder Vollständigkeit
+- Bei Problemen mit Markenrechten oder dem Library-Namen kontaktieren Sie mich bitte
+- Falls sich offizielle Vertreter von sevDesk am Namen der Library stören, bin ich bereit, diesen zu übertragen oder die Library unter einem anderen Namen zu veröffentlichen
+
+## Installation
+
+```bash
+pip install sevdesk
+```
+
+## Anforderungen
+
+- Python 3.8+
+- pydantic
+- requests
+- pyyaml
+- jinja2
+
+## Verwendung
+
+### Client initialisieren
+
+```python
+from sevdesk import Client
+
+# API Token von sevDesk Dashboard holen
+client = Client('your-api-token-here')
+```
+
+### Kontakte abrufen
+
+```python
+# Alle Kontakte abrufen
+contacts = client.contact.getContacts()
+
+for contact in contacts:
+    print(f"ID: {contact.id_}")
+    print(f"Name: {contact.name or f'{contact.surename} {contact.familyname}'}")
+    print(f"Kundennummer: {contact.customerNumber}")
+    print(f"Status: {contact.status}")
+    print("-" * 40)
+```
+
+### Neuen Kontakt erstellen
+
+```python
+from sevdesk.models.contact import Contact
+from sevdesk.converters.category import Category
+
+# Organisation erstellen
+company = Contact(
+    name="Acme Corporation GmbH",
+    category=Category(id_=3, objectName="Category")
+)
+new_company = client.contact.createContact(body=company)
+print(f"Organisation erstellt mit ID: {new_company.id_}")
+
+# Person erstellen
+person = Contact(
+    surename="Max",
+    familyname="Mustermann",
+    gender="m",
+    category=Category(id_=3, objectName="Category")
+)
+new_person = client.contact.createContact(body=person)
+print(f"Person erstellt mit ID: {new_person.id_}")
+```
+
+### Rechnungen abrufen
+
+```python
+# Alle Rechnungen abrufen
+invoices = client.invoice.getInvoices()
+
+for invoice in invoices:
+    print(f"Rechnungsnummer: {invoice.invoiceNumber}")
+    print(f"Datum: {invoice.invoiceDate}")
+    print(f"Betrag: {invoice.sumGross} {invoice.currency}")
+    print(f"Status: {invoice.status}")
+    print("-" * 40)
+```
+
+### Angebote abrufen
+
+```python
+# Alle Angebote abrufen
+orders = client.order.getOrders()
+
+for order in orders:
+    print(f"Angebotsnummer: {order.orderNumber}")
+    print(f"Datum: {order.orderDate}")
+    print(f"Betrag: {order.sumGross} {order.currency}")
+    print(f"Status: {order.status}")
+    print("-" * 40)
+```
+
+### Kontakt aktualisieren
+
+```python
+from sevdesk.models.contactupdate import ContactUpdate
+
+# Kontakt aktualisieren
+update_data = ContactUpdate(
+    name="Neue Firma GmbH"
+)
+updated = client.contact.updateContact(contactId=123456, body=update_data)
+print(f"Kontakt aktualisiert: {updated.name}")
+```
+
+### Kontakt löschen
+
+```python
+# Kontakt löschen
+client.contact.deleteContact(contactId=123456)
+print("Kontakt gelöscht")
+```
+
+## Verfügbare Controller
+
+Der Client lädt automatisch alle verfügbaren Controller aus der OpenAPI-Spezifikation:
+
+- `client.contact` - Kontaktverwaltung
+- `client.invoice` - Rechnungsverwaltung
+- `client.order` - Angebotsverwaltung
+- `client.voucher` - Belegverwaltung
+- `client.part` - Artikelverwaltung
+- ... und viele mehr
+
+Alle Endpoints sind als Methoden verfügbar und vollständig typisiert für IDE-Unterstützung.
+
+## Code neu generieren
+
+Falls sich die sevDesk API ändert:
+
+```bash
+# Neue openapi.yaml herunterladen
+# Dann Generator ausführen:
+python -m generator
+```
+
+Dies generiert automatisch:
+- Models in `sevdeskapi/models/`
+- Converter in `sevdeskapi/converters/`
+- Controller in `sevdeskapi/controllers/`
+
+Das wird zeitnah über Github Actions abgebildet!
+
+## Lizenz  / Haftungsausschluss
+
+MIT License - Siehe LICENSE Datei
+

sevdesk-0.1.0/README.md

@@ -0,0 +1,160 @@
+# sevDesk API Client (Inoffiziell)
+
+Ein Python-Client für die sevDesk API, automatisch generiert aus der OpenAPI-Spezifikation. Dies ist notwendig, da sich die sevdesk-Spezifikation mit dem Standard OpenApi-Generator nicht parsen lässt.
+
+## ⚠️ Wichtige Hinweise
+
+- **Dies ist KEINE offizielle sevDesk Library**
+- Ich arbeite nicht für sevDesk und bin nicht mit sevDesk verbunden
+- **Nutzung auf eigene Gefahr**
+- Keine Garantie für Funktionalität oder Vollständigkeit
+- Bei Problemen mit Markenrechten oder dem Library-Namen kontaktieren Sie mich bitte
+- Falls sich offizielle Vertreter von sevDesk am Namen der Library stören, bin ich bereit, diesen zu übertragen oder die Library unter einem anderen Namen zu veröffentlichen
+
+## Installation
+
+```bash
+pip install sevdesk
+```
+
+## Anforderungen
+
+- Python 3.8+
+- pydantic
+- requests
+- pyyaml
+- jinja2
+
+## Verwendung
+
+### Client initialisieren
+
+```python
+from sevdesk import Client
+
+# API Token von sevDesk Dashboard holen
+client = Client('your-api-token-here')
+```
+
+### Kontakte abrufen
+
+```python
+# Alle Kontakte abrufen
+contacts = client.contact.getContacts()
+
+for contact in contacts:
+    print(f"ID: {contact.id_}")
+    print(f"Name: {contact.name or f'{contact.surename} {contact.familyname}'}")
+    print(f"Kundennummer: {contact.customerNumber}")
+    print(f"Status: {contact.status}")
+    print("-" * 40)
+```
+
+### Neuen Kontakt erstellen
+
+```python
+from sevdesk.models.contact import Contact
+from sevdesk.converters.category import Category
+
+# Organisation erstellen
+company = Contact(
+    name="Acme Corporation GmbH",
+    category=Category(id_=3, objectName="Category")
+)
+new_company = client.contact.createContact(body=company)
+print(f"Organisation erstellt mit ID: {new_company.id_}")
+
+# Person erstellen
+person = Contact(
+    surename="Max",
+    familyname="Mustermann",
+    gender="m",
+    category=Category(id_=3, objectName="Category")
+)
+new_person = client.contact.createContact(body=person)
+print(f"Person erstellt mit ID: {new_person.id_}")
+```
+
+### Rechnungen abrufen
+
+```python
+# Alle Rechnungen abrufen
+invoices = client.invoice.getInvoices()
+
+for invoice in invoices:
+    print(f"Rechnungsnummer: {invoice.invoiceNumber}")
+    print(f"Datum: {invoice.invoiceDate}")
+    print(f"Betrag: {invoice.sumGross} {invoice.currency}")
+    print(f"Status: {invoice.status}")
+    print("-" * 40)
+```
+
+### Angebote abrufen
+
+```python
+# Alle Angebote abrufen
+orders = client.order.getOrders()
+
+for order in orders:
+    print(f"Angebotsnummer: {order.orderNumber}")
+    print(f"Datum: {order.orderDate}")
+    print(f"Betrag: {order.sumGross} {order.currency}")
+    print(f"Status: {order.status}")
+    print("-" * 40)
+```
+
+### Kontakt aktualisieren
+
+```python
+from sevdesk.models.contactupdate import ContactUpdate
+
+# Kontakt aktualisieren
+update_data = ContactUpdate(
+    name="Neue Firma GmbH"
+)
+updated = client.contact.updateContact(contactId=123456, body=update_data)
+print(f"Kontakt aktualisiert: {updated.name}")
+```
+
+### Kontakt löschen
+
+```python
+# Kontakt löschen
+client.contact.deleteContact(contactId=123456)
+print("Kontakt gelöscht")
+```
+
+## Verfügbare Controller
+
+Der Client lädt automatisch alle verfügbaren Controller aus der OpenAPI-Spezifikation:
+
+- `client.contact` - Kontaktverwaltung
+- `client.invoice` - Rechnungsverwaltung
+- `client.order` - Angebotsverwaltung
+- `client.voucher` - Belegverwaltung
+- `client.part` - Artikelverwaltung
+- ... und viele mehr
+
+Alle Endpoints sind als Methoden verfügbar und vollständig typisiert für IDE-Unterstützung.
+
+## Code neu generieren
+
+Falls sich die sevDesk API ändert:
+
+```bash
+# Neue openapi.yaml herunterladen
+# Dann Generator ausführen:
+python -m generator
+```
+
+Dies generiert automatisch:
+- Models in `sevdeskapi/models/`
+- Converter in `sevdeskapi/converters/`
+- Controller in `sevdeskapi/controllers/`
+
+Das wird zeitnah über Github Actions abgebildet!
+
+## Lizenz  / Haftungsausschluss
+
+MIT License - Siehe LICENSE Datei
+

sevdesk-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sevdesk"
+dynamic = ["version"]
+description = "A Python client for the sevDesk API, automatically generated from the OpenAPI specification"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    { name = "Maximilian Clemens", email = "maximilian.clemens@gamma.red" },
+    { name = "Claude" },
+    { name = "ChatGPT" },
+    { name = "Copilot" },
+]
+keywords = ["sevdesk", "api", "client", "accounting"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "pydantic",
+    "requests",
+    "PyYAML",
+    "jinja2",
+]
+
+[project.urls]
+Homepage = "https://github.com/MaximilianClemens/python-sevdesk"
+Repository = "https://github.com/MaximilianClemens/python-sevdesk"
+Issues = "https://github.com/MaximilianClemens/python-sevdesk/issues"
+
+[tool.setuptools.dynamic]
+version = {attr = "sevdesk.VERSION"}
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["sevdesk*"]

sevdesk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sevdesk-0.1.0/sevdesk/__init__.py

@@ -0,0 +1,3 @@
+VERSION = "0.1.0"
+
+from sevdesk.client import Client

sevdesk-0.1.0/sevdesk/base/basecontroller.py

@@ -0,0 +1,102 @@
+import inspect
+from typing import get_type_hints, get_origin, get_args
+
+class BaseController:
+    def __init__(self, client):
+        self.client = client
+    
+    @staticmethod
+    def parse_response(response, return_type):
+        """Wandelt die Response in das entsprechende Model um"""
+        if return_type is None:
+            return response
+        
+        # Hole den ursprünglichen Typ (ohne list[] wrapper)
+        origin = get_origin(return_type)
+        
+        # Wenn es eine Liste ist
+        if origin is list:
+            args = get_args(return_type)
+            if args:
+                model_class = args[0]
+                # Response sollte eine Liste von Dicts sein
+                if isinstance(response, dict) and 'objects' in response:
+                    # sevDesk API struktur: {"objects": [...]}
+                    return [model_class(**item) if isinstance(item, dict) else item 
+                            for item in response['objects']]
+                elif isinstance(response, list):
+                    return [model_class(**item) if isinstance(item, dict) else item 
+                            for item in response]
+        
+        # Einzelnes Model
+        elif hasattr(return_type, '__bases__'):  # Check if it's a class
+            if isinstance(response, dict):
+                # sevDesk API struktur kann auch {"objects": {...}} sein
+                if 'objects' in response and isinstance(response['objects'], dict):
+                    return return_type(**response['objects'])
+                else:
+                    return return_type(**response)
+        
+        return response
+    
+    @staticmethod
+    def request(method, path):
+        def decorator(func):
+            def wrapper(self, *args, **kwargs):
+                # Args in kwargs umwandeln
+                sig = inspect.signature(func)
+                bound_args = sig.bind(self, *args, **kwargs)
+                bound_args.apply_defaults()
+                
+                # Entferne 'self' aus den arguments
+                all_kwargs = dict(bound_args.arguments)
+                all_kwargs.pop('self', None)
+                
+                gen = func(self, **all_kwargs)
+                
+                try:
+                    # Pre-request: bis zum yield ausführen
+                    next(gen)
+                    # veränderte parameter übernehmen
+                    for arg in all_kwargs.copy():
+                        # gi_frame HACK
+                        if gen.gi_frame:
+                            all_kwargs[arg] = gen.gi_frame.f_locals[arg]
+                    
+                    response = self.client.request(method, path, all_kwargs)
+                    
+                    # Return Type aus der Funktion auslesen
+                    try:
+                        type_hints = get_type_hints(func)
+                        return_type = type_hints.get('return', None)
+                    except Exception:
+                        return_type = None
+                    
+                    # Response in Model umwandeln
+                    parsed_response = BaseController.parse_response(response, return_type)
+                    
+                    # Gebe das Ergebnis direkt zurück
+                    return parsed_response
+                    
+                except StopIteration:
+                    return None
+                    
+            wrapper.__name__ = func.__name__
+            return wrapper
+        return decorator
+
+    @staticmethod
+    def get(path):
+        return BaseController.request('get', path)
+
+    @staticmethod
+    def post(path):
+        return BaseController.request('post', path)
+
+    @staticmethod
+    def put(path):
+        return BaseController.request('put', path)
+
+    @staticmethod
+    def delete(path):
+        return BaseController.request('delete', path)

sevdesk-0.1.0/sevdesk/client.py

@@ -0,0 +1,81 @@
+import requests
+import re
+import importlib
+from pathlib import Path
+
+class Client:
+
+    def __init__(self, api_token, api_base='https://my.sevdesk.de/api/v1', session=None):
+        self.api_token = api_token
+        self.api_base = api_base
+        self.session = session
+        if not self.session:
+            self.session = requests.Session()
+
+        # Automatisch alle Controller laden
+        self._load_controllers()
+
+    def _load_controllers(self):
+        """Lädt automatisch alle Controller aus dem controllers Verzeichnis"""
+        controllers_dir = Path(__file__).parent / "controllers"
+        
+        if not controllers_dir.exists():
+            return
+        
+        for controller_file in controllers_dir.glob("*_controller.py"):
+            # z.B. "contact_controller.py" -> "contact"
+            controller_name = controller_file.stem.replace("_controller", "")
+            
+            try:
+                # Dynamisch importieren
+                module = importlib.import_module(f"sevdesk.controllers.{controller_file.stem}")
+                
+                # Finde die Controller-Klasse im Modul (endet mit "Controller")
+                controller_class = None
+                for attr_name in dir(module):
+                    attr = getattr(module, attr_name)
+                    if (isinstance(attr, type) and 
+                        attr_name.endswith("Controller") and 
+                        attr_name != "BaseController"):
+                        controller_class = attr
+                        break
+                
+                if controller_class:
+                    # Als Attribut setzen: self.contact = ContactController(self)
+                    setattr(self, controller_name, controller_class(self))
+                else:
+                    print(f"Warning: No controller class found in {controller_file.stem}")
+                
+            except (ImportError, AttributeError) as e:
+                print(f"Warning: Could not load controller {controller_name}: {e}")
+
+    def request(self, method, path, params):
+        url_params = re.findall(r"{(\w+)}", path)
+        request_path = path.format(**params)
+        
+        request_params = {
+            k: v for k, v in params.items()
+            if k not in url_params and
+            k != 'body' and
+            v} # v not None
+        request_url = f'{self.api_base}{request_path}'
+        request_body = params.get('body', None)
+        if request_body:
+            request_body = request_body.model_dump(by_alias=True, exclude_none=True)
+
+        # print('request_params', request_params)
+        # print('request_url', request_url)
+        # print('request_body', request_body)
+
+        response = self.session.request(
+            method=method,
+            url=request_url,
+            params=request_params,
+            json=request_body,
+            headers={
+                'Authorization': self.api_token
+            }
+        )
+        # print(response.status_code)
+        # print(response.text)
+        return response.json()

sevdesk-0.1.0/sevdesk/controllers/accountingcontact_controller.py

@@ -0,0 +1,33 @@
+from sevdesk.base.basecontroller import BaseController
+from typing import Optional
+from sevdesk.models.accountingcontact import AccountingContact
+from sevdesk.models.accountingcontactresponse import AccountingContactResponse
+from sevdesk.models.accountingcontactupdate import AccountingContactUpdate
+
+class AccountingContactController(BaseController):
+
+    @BaseController.get("/AccountingContact")
+    def getAccountingContact(self, contact_id: Optional[str] = None, contact_objectName: Optional[str] = None) -> list[AccountingContactResponse]:
+        """Retrieve accounting contact"""
+        return (yield)
+
+    @BaseController.post("/AccountingContact")
+    def createAccountingContact(self, body: AccountingContact) -> AccountingContactResponse:
+        """Create a new accounting contact"""
+        return (yield)
+
+    @BaseController.get("/AccountingContact/{accountingContactId}")
+    def getAccountingContactById(self, accountingContactId: int) -> list[AccountingContactResponse]:
+        """Find accounting contact by ID"""
+        return (yield)
+
+    @BaseController.put("/AccountingContact/{accountingContactId}")
+    def updateAccountingContact(self, accountingContactId: int, body: AccountingContactUpdate) -> AccountingContactResponse:
+        """Update an existing accounting contact"""
+        return (yield)
+
+    @BaseController.delete("/AccountingContact/{accountingContactId}")
+    def deleteAccountingContact(self, accountingContactId: int):
+        """Deletes an accounting contact"""
+        return (yield)
+

sevdesk-0.1.0/sevdesk/controllers/basics_controller.py

@@ -0,0 +1,9 @@
+from sevdesk.base.basecontroller import BaseController
+
+class BasicsController(BaseController):
+
+    @BaseController.get("/Tools/bookkeepingSystemVersion")
+    def bookkeepingSystemVersion(self):
+        """Retrieve bookkeeping system version"""
+        return (yield)
+