Migrate to pyproject.toml and update related files

.github/workflows/ci.yml

@@ -37,6 +37,7 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install .[dev]
         pip install coverage
         pip install -r requirements.txt
     - name: Setup test config and CouchDB database server

.gitignore

@@ -24,3 +24,26 @@
 /test/test_config.ini
 # Schema files needed for testing
 /test/adapter/schemas
+
+
+# Python build artifacts
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg

pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools>=40.8.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "basyx-python-sdk"
+version = "0.1.0"  # Replace with your actual version
+description = "The Eclipse BaSyx Python SDK, an implementation of the Asset Administration Shell for Industry 4.0 systems"
+authors = [
+    {name = "The Eclipse BaSyx Authors", email = "[email protected]"}  # Replace with a real email
+]
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+]
+requires-python = ">=3.6"
+dependencies = [
+    "python-dateutil>=2.8,<3",
+    "lxml>=4.2,<5",
+    "urllib3>=1.26,<2.0",
+    "pyecma376-2>=0.2.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/eclipse-basyx/basyx-python-sdk"
+
+[project.scripts]
+aas-compliance-check = "basyx.aas.compliance_tool.cli:main"
+
+[tool.setuptools.packages.find]
+exclude = ["test", "test.*"]
+
+[tool.setuptools.package-data]
+"basyx" = ["py.typed"]
+"basyx.aas.examples.data" = ["TestFile.pdf"]

requirements.txt

@@ -5,3 +5,7 @@ types-python-dateutil
 pyecma376-2>=0.2.4
 urllib3>=1.26,<2.0
 lxml-stubs~=0.5.1
+
+jsonschema~=4.7
+types-python-dateutil
+lxml-stubs~=0.5.1

setup.py

@@ -1,48 +1,16 @@
-#!/usr/bin/env python3
-# Copyright (c) 2019-2024 the Eclipse BaSyx Authors
-#
-# This program and the accompanying materials are made available under the terms of the MIT License, available in
-# the LICENSE file of this project.
-#
-# SPDX-License-Identifier: MIT
+from setuptools import setup, find_packages
 
-import setuptools
-from basyx.aas import __version__
-
-with open("README.md", "r", encoding='utf-8') as fh:
-    long_description = fh.read()
-
-setuptools.setup(
+# Metadata is now in pyproject.toml, but we need this file for backwards compatibility
+setup(
     name="basyx-python-sdk",
-    version=__version__,
-    author="The Eclipse BaSyx Authors",
-    description="The Eclipse BaSyx Python SDK, an implementation of the Asset Administration Shell for Industry 4.0 "
-                "systems",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/eclipse-basyx/basyx-python-sdk",
-    packages=setuptools.find_packages(exclude=["test", "test.*"]),
-    zip_safe=False,
+    packages=find_packages(exclude=["test", "test.*"]),
     package_data={
         "basyx": ["py.typed"],
         "basyx.aas.examples.data": ["TestFile.pdf"],
     },
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-        "Development Status :: 5 - Production/Stable",
-    ],
     entry_points={
         'console_scripts': [
-            "aas-compliance-check = basyx.aas.compliance_tool.cli:main"
+            "aas-compliance-check=basyx.aas.compliance_tool.cli:main"
         ]
     },
-    python_requires='>=3.8',
-    install_requires=[
-        'python-dateutil>=2.8,<3',
-        'lxml>=4.2,<5',
-        'urllib3>=1.26,<2.0',
-        'pyecma376-2>=0.2.4',
-    ]
-)
+)