# Wirepas Gateway Transport Service
[](https://wirepas-gateway.readthedocs.io/en/latest/?badge=latest)
## Building the wheel
To build the source distribution and wheel file, make sure you have the
wheel package installed
```shell
pip install wheel
```
and then run
```shell
py3clean .
python3 setup.py clean --all
python3 setup.py sdist bdist_wheel
```
A convenience script is available from the [utils folder][here_utils_wheel].
## Installation
Before you attempt to build and install this package, please ensure that
you have [all the requirements met][wm_gateway_requirements].
We highly recommend that you make your installation under a python virtual
environment such as [virtualenv][virtualenv] or [pipenv][pipenv].
To install this package run (use -e for development mode)
```shell
pip install [-e] .
```
## Running inside a virtual environment
When running inside a virtual environment you will need to provide access
to system libraries. You can achieve this by using *--system-site-packages*
when setting up your environment or through [vext][vext].
If you opt to install [vext][vext], please install the
[PyGObject][pygobject] module with:
```shell
pip install vext vext.gi
```
You also need to ensure that the following packages are installed inside
the virtual environment (as well as their system dependencies):
```shell
pip install pygobject gobject
```
## Starting the service
Please read on
[how to configure and start the transport service][wm_gateway_transport_conf]
[wm_gateway_transport_conf]: https://github.com/wirepas/gateway/blob/master/README.md#transport-service-configuration
[wm_gateway_requirements]: https://github.com/wirepas/gateway/blob/master/README.md#linux-requirements
[here_utils_wheel]: https://github.com/wirepas/gateway/blob/update-readme/python_transport/utils/generate_wheel.sh
[virtualenv]: https://docs.python.org/3/tutorial/venv.html
[pipenv]: https://github.com/pypa/pipenv
[vext]: https://github.com/stuaxo/vext
[pygobject]: https://pygobject.readthedocs.io/en/latest/index.html
Raw data
{
"_id": null,
"home_page": "https://github.com/wirepas/gateway",
"name": "wirepas-gateway",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "wirepas connectivity iot mesh",
"author": "Wirepas Ltd",
"author_email": "opensource@wirepas.com",
"download_url": "https://files.pythonhosted.org/packages/61/29/23d902b41ff4d15d7df168933cbf4e20240657180bbf06c0fd05882580b2/wirepas_gateway-1.4.5.tar.gz",
"platform": null,
"description": "# Wirepas Gateway Transport Service\n[](https://wirepas-gateway.readthedocs.io/en/latest/?badge=latest)\n\n## Building the wheel\n\nTo build the source distribution and wheel file, make sure you have the\nwheel package installed\n\n```shell\n pip install wheel\n```\nand then run\n\n```shell\n py3clean .\n python3 setup.py clean --all\n python3 setup.py sdist bdist_wheel\n```\n\nA convenience script is available from the [utils folder][here_utils_wheel].\n\n## Installation\n\nBefore you attempt to build and install this package, please ensure that\nyou have [all the requirements met][wm_gateway_requirements].\n\nWe highly recommend that you make your installation under a python virtual\nenvironment such as [virtualenv][virtualenv] or [pipenv][pipenv].\n\nTo install this package run (use -e for development mode)\n\n```shell\n pip install [-e] .\n```\n\n## Running inside a virtual environment\n\nWhen running inside a virtual environment you will need to provide access\nto system libraries. You can achieve this by using *--system-site-packages*\nwhen setting up your environment or through [vext][vext].\n\nIf you opt to install [vext][vext], please install the\n[PyGObject][pygobject] module with:\n\n```shell\n pip install vext vext.gi\n```\n\nYou also need to ensure that the following packages are installed inside\nthe virtual environment (as well as their system dependencies):\n\n```shell\n pip install pygobject gobject\n```\n\n## Starting the service\n\nPlease read on\n[how to configure and start the transport service][wm_gateway_transport_conf]\n\n[wm_gateway_transport_conf]: https://github.com/wirepas/gateway/blob/master/README.md#transport-service-configuration\n[wm_gateway_requirements]: https://github.com/wirepas/gateway/blob/master/README.md#linux-requirements\n[here_utils_wheel]: https://github.com/wirepas/gateway/blob/update-readme/python_transport/utils/generate_wheel.sh\n\n[virtualenv]: https://docs.python.org/3/tutorial/venv.html\n[pipenv]: https://github.com/pypa/pipenv\n[vext]: https://github.com/stuaxo/vext\n\n[pygobject]: https://pygobject.readthedocs.io/en/latest/index.html\n",
"bugtrack_url": null,
"license": "Apache-2",
"summary": "Wirepas gateway transport service that connects the local dbus to a remote MQTT broker.",
"version": "1.4.5",
"project_urls": {
"Homepage": "https://github.com/wirepas/gateway"
},
"split_keywords": [
"wirepas",
"connectivity",
"iot",
"mesh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "612923d902b41ff4d15d7df168933cbf4e20240657180bbf06c0fd05882580b2",
"md5": "8d696169cc98c8ce8fcea3a323a395d6",
"sha256": "0546f1b5ed17142cc4cf72e59f65993d7e0b3e249cbc1fbed654ac7b0bbb9b26"
},
"downloads": -1,
"filename": "wirepas_gateway-1.4.5.tar.gz",
"has_sig": false,
"md5_digest": "8d696169cc98c8ce8fcea3a323a395d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38887,
"upload_time": "2024-08-02T13:47:09",
"upload_time_iso_8601": "2024-08-02T13:47:09.101361Z",
"url": "https://files.pythonhosted.org/packages/61/29/23d902b41ff4d15d7df168933cbf4e20240657180bbf06c0fd05882580b2/wirepas_gateway-1.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 13:47:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wirepas",
"github_project": "gateway",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wirepas-gateway"
}
JSON
