Metadata-Version: 2.1
Name: ogn-client
Version: 1.0.1
Summary: A python module for the Open Glider Network
Home-page: https://github.com/glidernet/python-ogn-client
Author: Konstantin Gründger aka Meisterschueler, Fabian P. Schmidt aka kerel
Author-email: kerel-fs@gmx.de
License: AGPLv3
Description: # python-ogn-client
        
        [![Build Status](https://travis-ci.org/glidernet/python-ogn-client.svg?branch=master)](https://travis-ci.org/glidernet/python-ogn-client)
        [![PyPi Version](https://img.shields.io/pypi/v/ogn-client.svg)](https://pypi.python.org/pypi/ogn-client)
        [![Coverage Status](https://coveralls.io/repos/github/glidernet/python-ogn-client/badge.svg?branch=master)](https://coveralls.io/github/glidernet/python-ogn-client?branch=master)
        
        A python3 module for the [Open Glider Network](http://wiki.glidernet.org/).
        It can be used to connect to the OGN-APRS-Servers and to parse APRS-/OGN-Messages.
        
        A full featured gateway with build-in database is provided by [ogn-python](https://github.com/glidernet/ogn-python).
        
        
        ## Installation
        
        python-ogn-client is available at PyPI. So for installation simply use pip:
        
        ```
        pip install ogn-client
        ```
        
        ## Example Usage
        
        ### Parse APRS/OGN packet.
        
        ```python
        from ogn.parser import parse
        from datetime import datetime
        
        beacon = parse("FLRDDDEAD>APRS,qAS,EDER:/114500h5029.86N/00956.98E'342/049/A=005524 id0ADDDEAD -454fpm -1.1rot 8.8dB 0e +51.2kHz gps4x5",
        				reference_timestamp=datetime(2015, 7, 31, 12, 34, 56))
        ```
        
        ### Connect to OGN and display all incoming beacons.
        
        ```python
        from ogn.client import AprsClient
        from ogn.parser import parse, ParseError
        
        def process_beacon(raw_message):
            try:
                beacon = parse(raw_message)
                print('Received {aprs_type}: {raw_message}'.format(**beacon))
            except ParseError as e:
                print('Error, {}'.format(e.message))
        
        client = AprsClient(aprs_user='N0CALL')
        client.connect()
        
        try:
            client.run(callback=process_beacon, autoreconnect=True)
        except KeyboardInterrupt:
            print('\nStop ogn gateway')
            client.disconnect()
        ```
        
        ### Connect to telnet console and display all decoded beacons.
        
        ```python
        from ogn.client import TelnetClient
        from ogn.parser.telnet_parser import parse
        
        def process_beacon(raw_message):
            beacon = parse(raw_message)
            if beacon:
                print(beacon)
        
        client = TelnetClient()
        client.connect()
        
        try:
            client.run(callback=process_beacon)
        except KeyboardInterrupt:
            print('\nStop ogn gateway')
            client.disconnect()
        ```
        
        ## License
        Licensed under the [AGPLv3](LICENSE).
        
Keywords: gliding,ogn
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3
Description-Content-Type: text/markdown
Provides-Extra: dev
