Commit fda8a387 authored by Adrian Pino's avatar Adrian Pino Committed by GitHub
Browse files

Merge pull request #83 from SunriseOpenOperatorPlatform/refactor/build-pypi-package 

Refactor repository for pypi package built
parents 2f037fa0 5b48aa69

.github/workflows/ci.yaml

+3 −1
Original line number Diff line number Diff line
@@ -18,7 +18,9 @@ jobs: 
      uses: actions/checkout@v4



    - name: Install dependencies

      run: pip install -r requirements.txt

      run: |

        pip install -r requirements.txt

        pip install -e .



    - name: "Run test: validate edge cloud clients instantiation"

      run: pytest -v tests/common/test_invoke_edgecloud_clients.py

.gitignore

+3 −1
Original line number Diff line number Diff line
@@ -3,6 +3,8 @@ 
.pytest_cache

.pyc

__pycache__/

tmp/

.vscode/

.log

.tar.gz

/dist

src/sunrise6g_opensdk.egg-info/

README.md

+3 −3
Original line number Diff line number Diff line
@@ -7,9 +7,9 @@ Thank you for contributing to this project. Please follow the guidelines below t 


### Directory Structure

Each contribution should be made in the appropriate directory:

- **EdgeCloud Adapters** → `src/edgecloud/clients/`

- **Network Adapters** → `src/network/clients/`

- **O-RAN Adapters** → `src/o-ran/clients/`

- **EdgeCloud Adapters** → `src/sunrise6g-opendk/edgecloud/clients/`

- **Network Adapters** → `src/sunrise6g-opendk/network/clients/`

- **O-RAN Adapters** → `src/sunrise6g-opendk/oran/clients/`



### Testing (Mandatory)

To merge a feature branch into `main`, the adapter **must pass the unit tests**. Instructions to do so available at [TESTING.md](docs/TESTING.md)

examples/basic_usage.py

+1 −3
Original line number Diff line number Diff line 
from src.common.sdk import Sdk as sdkclient



# Note: that is equivalent to "from sunrise6g-sdk import Sdk as sdkclient"

from sunrise6g_opensdk import Sdk as sdkclient





def main():

pyproject.toml

0 → 100644
+63 −0
Original line number Diff line number Diff line 
[build-system]

requires = ["setuptools>=61.0", "wheel"]

build-backend = "setuptools.build_meta"



[project]

name = "sunrise6g-opensdk"

version = "0.9.2"

description = "Open source SDK to abstract CAMARA/GSMA Transformation Functions (TFs) for Edge Cloud platforms, 5G network cores and Open RAN."

keywords = [

  "Federation",

  "Transformation Functions",

  "TFs",

  "CAMARA",

  "GSMA OPG",

  "Open source",

  "OpenSDK",

  "SDK",

  "SUNRISE-6G",

  "6G",

  "ETSI",

  "Edge Cloud Platform",

  "5G Core",

  "Open RAN",

  "O-RAN",

]

authors = [

  { name="Adrian Pino", email="adrian.pino@i2cat.net" }

]

readme = "README.md"

requires-python = ">=3.7"

license = { text = "Apache-2.0" }

classifiers = [

  "Operating System :: OS Independent",

  "Programming Language :: Python",

  "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",

  "Programming Language :: Python :: 3.13",

  "Topic :: Software Development :: Libraries :: Python Modules",

]

dependencies = [

  "auto_mix_prep==0.2.0",

  "colorlog==6.8.2",

  "pydantic==2.11.3",

  "requests==2.32.3",

]



[project.urls]

Homepage = "https://sunrise6g.eu/"

Repository = "https://github.com/OpenOperatorPlatform/OpenSDK"



[tool.setuptools.packages.find]

where = ["src"]

include = ["sunrise6g_opensdk*"]



[tool.setuptools.package-data]

sunrise6g_opensdk = ["py.typed"]



[bdist_wheel]

universal = 1