# Open5GS Python API Framework
This package provides a Pythonic API for interacting with Open5GS components and configuring network parameters.
## Installation
```bash
pip install open5gs
```
## Usage
```python
from open5gs import open5gs
# Configure network parameters
ambr = open5gs.ambr(value=10000000, unit=1) # 10 Mbps
qos = open5gs.qos(index=5)
arp = open5gs.arp(priority_level=1, pre_emption_vulnerability=1, pre_emption_capability=2)
# Update configuration
open5gs.update_config(ambr=ambr, qos=qos, arp=arp)
# Get UE and UPF API URLs
UE_API_URL = open5gs.ue(8080, "send")
UPF_API_URL = open5gs.upf(8081, "receive", "sensor")
# Send data
data = {"sensor_id": 1, "temperature": 25.5, "humidity": 60}
response = open5gs.send_data(UE_API_URL, data)
print(response)
# Receive data
received_data = open5gs.receive_data(UPF_API_URL)
print(received_data)
```
For more detailed usage instructions and API reference, please refer to the documentation.
## Development
To set up the development environment:
1. Clone the repository
2. Create a virtual environment: `python -m venv venv`
3. Activate the virtual environment: `source venv/bin/activate` (Linux/Mac) or `venv\Scripts\activate` (Windows)
4. Install development dependencies: `pip install -r requirements-dev.txt`
5. Run tests: `pytest tests/`
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/ashwinsathish/open5gs-api",
"name": "open5gs-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Ashwin",
"author_email": "f20200893@pilani.bits-pilani.ac.in",
"download_url": "https://files.pythonhosted.org/packages/ab/f0/c668d108d2e9da34446fb0c50094bcde8bc85f1a9600a63714feb75ca0b8/open5gs-api-0.1.0.tar.gz",
"platform": null,
"description": "# Open5GS Python API Framework\n\nThis package provides a Pythonic API for interacting with Open5GS components and configuring network parameters.\n\n## Installation\n\n```bash\npip install open5gs\n```\n\n## Usage\n\n```python\nfrom open5gs import open5gs\n\n# Configure network parameters\nambr = open5gs.ambr(value=10000000, unit=1) # 10 Mbps\nqos = open5gs.qos(index=5)\narp = open5gs.arp(priority_level=1, pre_emption_vulnerability=1, pre_emption_capability=2)\n\n# Update configuration\nopen5gs.update_config(ambr=ambr, qos=qos, arp=arp)\n\n# Get UE and UPF API URLs\nUE_API_URL = open5gs.ue(8080, \"send\")\nUPF_API_URL = open5gs.upf(8081, \"receive\", \"sensor\")\n\n# Send data\ndata = {\"sensor_id\": 1, \"temperature\": 25.5, \"humidity\": 60}\nresponse = open5gs.send_data(UE_API_URL, data)\nprint(response)\n\n# Receive data\nreceived_data = open5gs.receive_data(UPF_API_URL)\nprint(received_data)\n```\n\nFor more detailed usage instructions and API reference, please refer to the documentation.\n\n## Development\n\nTo set up the development environment:\n\n1. Clone the repository\n2. Create a virtual environment: `python -m venv venv`\n3. Activate the virtual environment: `source venv/bin/activate` (Linux/Mac) or `venv\\Scripts\\activate` (Windows)\n4. Install development dependencies: `pip install -r requirements-dev.txt`\n5. Run tests: `pytest tests/`\n\n## License\n\nThis project is licensed under the MIT License.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python API for interacting with Open5GS components",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/ashwinsathish/open5gs-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "128355d525916016d748ea55a6d8069aa636397cbd5e7fa1aa97d6c20208947c",
"md5": "82f27e90cdad27a5f623281f5c825769",
"sha256": "337fd0d691f7a462080f46bc801ef444c0de798274a82e27f4c467152bf2133a"
},
"downloads": -1,
"filename": "open5gs_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82f27e90cdad27a5f623281f5c825769",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 1931,
"upload_time": "2024-10-09T14:20:49",
"upload_time_iso_8601": "2024-10-09T14:20:49.230450Z",
"url": "https://files.pythonhosted.org/packages/12/83/55d525916016d748ea55a6d8069aa636397cbd5e7fa1aa97d6c20208947c/open5gs_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "abf0c668d108d2e9da34446fb0c50094bcde8bc85f1a9600a63714feb75ca0b8",
"md5": "6cb63bbe3b677444749f622fcd85acad",
"sha256": "56be6eaf911a86ff50e5e9bd61eb662811e43d44eac6e7f495349eaa52773b31"
},
"downloads": -1,
"filename": "open5gs-api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6cb63bbe3b677444749f622fcd85acad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1962,
"upload_time": "2024-10-09T14:20:50",
"upload_time_iso_8601": "2024-10-09T14:20:50.460511Z",
"url": "https://files.pythonhosted.org/packages/ab/f0/c668d108d2e9da34446fb0c50094bcde8bc85f1a9600a63714feb75ca0b8/open5gs-api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 14:20:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ashwinsathish",
"github_project": "open5gs-api",
"github_not_found": true,
"lcname": "open5gs-api"
}
JSON
