Skip to content

Commit

Permalink
Add setup and README files
Browse files Browse the repository at this point in the history
  • Loading branch information
Emmanuel Blot committed May 22, 2011
1 parent 219bb4d commit 482f889
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 1 deletion.
5 changes: 5 additions & 0 deletions AUTHORS
@@ -0,0 +1,5 @@
Main developers:

* Emmanuel Blot <emmanuel.blot@free.fr>

Contributors:
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2009 Emmanuel Blot <manu.blot@gmail.com>
Copyright (c) 2009-2011 Emmanuel Blot <emmanuel.blot@free.fr>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
48 changes: 48 additions & 0 deletions README.rst
@@ -0,0 +1,48 @@
=========
PyKMaze
=========

Abstract
~~~~~~~~

Geonaute Keymaze 500/700 GPS watch devices are shipped with a Windows-only
application software.

Pykmaze alleviates this issue and allows to transfer data from/to the device
with any host.

Features
~~~~~~~~

Pykmaze is a pure Python command-line application that does not offer a
graphical interface as the original application software does, but nevertheless
allows to download recorded tracks and upload waypoints.

Its produces and reads Google Earth .KML file, so that tracks and waypoints may
be observed and edited with the Google Earth application.

Important notice
----------------
The Keymaze 500/700 protocol has been reverse-engineered from scratch. Pykmaze
code is not based on published information and may fail to comply with the
communication protocol the Keymaze device expects.

Use it at your own risk.

Supported devices
~~~~~~~~~~~~~~~~~

Although it seems that Keymaze 500 and 700 share the same communication
protocol, no test has been run with Keymaze 700 GPS devices yet. It seems that
the Geonaute device is a rebranded GlobalSat GH-615B device, so pykmaze might
also be able to communicate with these devices.

Pykmaze is not compatible with earlier devices such as Keymaze 300 that may
use a different communication protocol. Check out the gpsd4_ project
if you're looking for Keymaze 300 device support. Both projects are fully
unrelated.

For now, pykmaze has been successfully run on an Intel Mac OS X Snow Leopard
64-bit host. It should run fine on any Linux host.

.. _gpsd4: http://gpsd4.tuxfamily.org
57 changes: 57 additions & 0 deletions setup.py
@@ -0,0 +1,57 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (c) 2008-2011 Emmanuel Blot <emmanuel.blot@free.fr>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

from distutils.core import setup


def _read(fname):
import os
return open(os.path.join(os.path.dirname(__file__), fname)).read()

setup(
name='pykmaze',
version='0.2.0',
description='Keymaze 500-700 communicator',
author='Emmanuel Blot',
author_email='emmanuel.blot@free.fr',
license='MIT',
keywords = 'keymaze kml kmz gps',
url='http://github.com/eblot/pykmaze',
download_url='https://github.com/eblot/pykmaze/tarball/master',
packages=['pykmaze'],
requires=['serial (>= 2.5)'],
classifiers=[
'Development Status :: 4 - Beta',
'Environment :: Console',
'Intended Audience :: End Users/Desktop',
'Intended Audience :: Healthcare Industry',
'License :: OSI Approved :: MIT License',
'Operating System :: MacOS :: MacOS X',
'Operating System :: POSIX',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Topic :: Scientific/Engineering :: Medical Science Apps.',
'Topic :: Utilities'
],
long_description=_read('README.rst'),
)

0 comments on commit 482f889

Please sign in to comment.