Metadata-Version: 2.1
Name: wirepas-gateway
Version: 1.4.2
Summary: Wirepas gateway transport service that connects the local dbus to a remote MQTT broker.
Home-page: https://github.com/wirepas/gateway
Author: Wirepas Ltd
Author-email: opensource@wirepas.com
License: Apache-2
Description: # Wirepas Gateway Transport Service
        [![Documentation Status](https://readthedocs.org/projects/wirepas-gateway/badge/?version=latest)](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
        
Keywords: wirepas connectivity iot mesh
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
