Browse Source

Replaced all instances of kiss with kiss2

Stephen Downward 1 year ago
parent
commit
1a04402c4c
6 changed files with 29 additions and 54 deletions
  1. 9 34
      README.rst
  2. 2 2
      examples/serial_read.py
  3. 2 2
      examples/serial_write.py
  4. 3 3
      examples/socket_read.py
  5. 2 2
      examples/socket_write.py
  6. 11 11
      setup.py

+ 9 - 34
README.rst

@ -1,8 +1,8 @@
1
kiss - Python KISS Module
1
kiss2 - Python KISS Module
2 2
*************************
3 3
4
kiss is a Python Module that implementations the `KISS Protocol <https://en.wikipedia.org/wiki/KISS_(TNC)>`_ for
5
communicating with KISS-enabled devices (such as Serial or TCP TNCs).
4
kiss2 is a Python Module that implementations the `KISS Protocol <https://en.wikipedia.org/wiki/KISS_(TNC)>`_ for
5
communicating with KISS-enabled devices (such as Serial or TCP TNCs). It is based on kiss(Another python module) which is no longer maintained.
6 6
7 7
Versions
8 8
========
@ -12,7 +12,7 @@ Versions
12 12
13 13
Installation
14 14
============
15
Install from pypi using pip: ``pip install kiss``
15
Install from pypi using pip: ``pip install kiss2``
16 16
17 17
18 18
Usage Examples
@ -38,16 +38,6 @@ Run nosetests from a Makefile target::
38 38
    make test
39 39
40 40
41
See Also
42
========
43
44
* `Python APRS Module <https://github.com/ampledata/aprs>`_ Library for sending, receiving and parsing APRS Frames to and from multiple Interfaces
45
* `Python KISS Module <https://github.com/ampledata/kiss>`_ Handles interfacing-to and encoding-for various KISS Interfaces.
46
* `Python APRS Gateway <https://github.com/ampledata/aprsgate>`_ Uses Redis PubSub to run a multi-interface APRS Gateway.
47
* `Python APRS Tracker <https://github.com/ampledata/aprstracker>`_ TK.
48
* `dirus <https://github.com/ampledata/dirus>`_ Dirus is a daemon for managing a SDR to Dire Wolf interface. Manifests that interface as a KISS TCP port.
49
50
51 41
Similar Projects
52 42
================
53 43
@ -60,35 +50,20 @@ Similar Projects
60 50
* `Ham-APRS-FAP <http://search.cpan.org/dist/Ham-APRS-FAP/>`_ by aprs.fi: A Perl APRS Parser.
61 51
* `Dire Wolf <https://github.com/wb2osz/direwolf>`_ by WB2OSZ. A C-Based Soft-TNC for interfacing with sound cards. Can present as a KISS interface!
62 52
63
Build Status
64
============
65
66
Master:
67
68
.. image:: https://travis-ci.org/ampledata/kiss.svg?branch=master
69
    :target: https://travis-ci.org/ampledata/kiss
70
71
Develop:
72
73
.. image:: https://travis-ci.org/ampledata/kiss.svg?branch=develop
74
    :target: https://travis-ci.org/ampledata/kiss
75
76
77 53
Source
78 54
======
79
Github: https://github.com/ampledata/kiss
55
Github: https://git.scd31.com/laptopdude90/kiss2
80 56
81 57
Author
82 58
======
83
Greg Albrecht W2GMD oss@undef.net
59
Greg Albrecht W2GMD oss@undef.net (kiss)
60
Stephen Downward VA1QLE stephen@stephendownward.ca (kiss2)
84 61
85
http://ampledata.org/
62
https://blog.scd31.com
86 63
87 64
Copyright
88 65
=========
89
Copyright 2017 Greg Albrecht and Contributors
90
91
`Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR wb4apr@amsat.org
66
Copyright 2017 Greg Albrecht(kiss), Stephen Downward(kiss2) and Contributors
92 67
93 68
License
94 69
=======

+ 2 - 2
examples/serial_read.py

@ -29,7 +29,7 @@ Test output should be as follows:
29 29
"""
30 30
31 31
import aprs
32
import kiss
32
import kiss2
33 33
34 34
35 35
def print_frame(frame):
@ -37,7 +37,7 @@ def print_frame(frame):
37 37
38 38
39 39
def main():
40
    ki = kiss.SerialKISS(port='/dev/cu.Repleo-PL2303-00303114', speed='9600')
40
    ki = kiss2.SerialKISS(port='/dev/cu.Repleo-PL2303-00303114', speed='9600')
41 41
    ki.start()
42 42
    ki.read(callback=print_frame, readmode=True)
43 43

+ 2 - 2
examples/serial_write.py

@ -6,7 +6,7 @@ For use with programs like Dire Wolf.
6 6
"""
7 7
8 8
import aprs
9
import kiss
9
import kiss2
10 10
11 11
12 12
def main():
@ -16,7 +16,7 @@ def main():
16 16
    frame.path = [aprs.Callsign('WIDE1-1')]
17 17
    frame.text = '>Hello World!'
18 18
19
    ki = kiss.SerialKISS(port='/dev/cu.AP510-DevB', speed='9600')
19
    ki = kiss2.SerialKISS(port='/dev/cu.AP510-DevB', speed='9600')
20 20
    ki.start()
21 21
    ki.write(frame.encode_kiss())
22 22

+ 3 - 3
examples/socket_read.py

@ -31,12 +31,12 @@ Test output should be as follows:
31 31
"""
32 32
33 33
import aprs
34
import kiss
34
import kiss2
35 35
36 36
37 37
def main2():
38 38
39
    frame = kiss.strip_df_start(x)
39
    frame = kiss2.strip_df_start(x)
40 40
41 41
    for frame_slice in range(0, frame_len):
42 42
        # Is address field length correct?
@ -187,7 +187,7 @@ def print_frame(frame):
187 187
    print(aprs.Frame(frame[1:]))
188 188
189 189
def main():
190
    ki = kiss.TCPKISS(host='localhost', port=8001)
190
    ki = kiss2.TCPKISS(host='localhost', port=8001)
191 191
    ki.start()
192 192
    ki.read(callback=print_frame)
193 193

+ 2 - 2
examples/socket_write.py

@ -6,7 +6,7 @@ For use with programs like Dire Wolf.
6 6
"""
7 7
8 8
import aprs
9
import kiss
9
import kiss2
10 10
11 11
12 12
def main():
@ -16,7 +16,7 @@ def main():
16 16
    frame.path = [aprs.Callsign('WIDE1-1')]
17 17
    frame.text = '>Hello World!'
18 18
19
    ki = kiss.TCPKISS(host='localhost', port=1234)
19
    ki = kiss2.TCPKISS(host='localhost', port=1234)
20 20
    ki.start()
21 21
    ki.write(frame.encode_kiss())
22 22

+ 11 - 11
setup.py

@ -4,17 +4,17 @@
4 4
"""
5 5
Setup for the Python KISS Module.
6 6
7
Source:: https://github.com/ampledata/kiss
7
Source: https://git.scd31.com/laptopdude90/kiss2
8 8
"""
9 9
10 10
import os
11 11
import setuptools
12 12
import sys
13 13
14
__title__ = 'kiss'
15
__version__ = '7.0.0'
16
__author__ = 'Greg Albrecht W2GMD <oss@undef.net>'  # NOQA pylint: disable=R0801
17
__copyright__ = 'Copyright 2017 Greg Albrecht and Contributors'  # NOQA pylint: disable=R0801
14
__title__ = 'kiss2'
15
__version__ = '7.0.2'
16
__author__ = 'Stephen Downward VA1QLE <stephen@stephendownward.ca>'  # NOQA pylint: disable=R0801
17
__copyright__ = 'Copyright 2017 Greg Albrecht(kiss), Stephen Downward(kiss2), and Contributors'  # NOQA pylint: disable=R0801
18 18
__license__ = 'Apache License, Version 2.0'  # NOQA pylint: disable=R0801
19 19
20 20
@ -32,15 +32,15 @@ publish()
32 32
setuptools.setup(
33 33
    name=__title__,
34 34
    version=__version__,
35
    description='Python KISS Module.',
36
    author='Greg Albrecht',
37
    author_email='oss@undef.net',
38
    packages=['kiss'],
35
    description='Python KISS Module V2.',
36
    author='Stephen Downward',
37
    author_email='stephen@stephendownward.ca',
38
    packages=['kiss2'],
39 39
    package_data={'': ['LICENSE']},
40
    package_dir={'kiss': 'kiss'},
40
    package_dir={'kiss2': 'kiss2'},
41 41
    license=open('LICENSE').read(),
42 42
    long_description=open('README.rst').read(),
43
    url='https://github.com/ampledata/kiss',
43
    url='https://git.scd31.com/laptopdude90/kiss2',
44 44
    zip_safe=False,
45 45
    setup_requires=[
46 46
        'coverage >= 4.4.1',