chore(cleanup): cleanup for release as pystun3

Author: TheKevJames

.circleci/config.yml

@@ -0,0 +1,67 @@
+version: 2
+
+jobs:
+  lint2:
+    docker:
+    - image: python:2.7.14
+    steps:
+    - checkout
+    - run: pip install prospector
+    - run: prospector
+
+  lint3:
+    docker:
+    - image: python:3.6.4
+    steps:
+    - checkout
+    - run: pip install prospector
+    - run: prospector
+
+  test27:
+    docker:
+    - image: python:2.7.14
+    steps:
+    - checkout
+    - run: pip install nose
+    - run: nosetests --with-coverage --cover-package=stun --cover-inclusive ./tests
+
+  test34:
+    docker:
+    - image: python:3.4.8
+    steps:
+    - checkout
+    - run: pip install nose
+    - run: nosetests --with-coverage --cover-package=stun --cover-inclusive ./tests
+
+  test35:
+    docker:
+    - image: python:3.5.5
+    steps:
+    - checkout
+    - run: pip install nose
+    - run: nosetests --with-coverage --cover-package=stun --cover-inclusive ./tests
+
+  test36:
+    docker:
+    - image: python:3.6.4
+    steps:
+    - checkout
+    - run: pip install nose
+    - run: nosetests --with-coverage --cover-package=stun --cover-inclusive ./tests
+
+workflows:
+  version: 2
+  run-jobs:
+    jobs:
+    - lint2
+    - lint3
+    - test27
+    - test34
+    - test35
+    - test36
+
+experimental:
+  notify:
+    branches:
+      only:
+      - master

.gitignore

@@ -1,8 +1,8 @@
-.coverage
 *.pkl
 *.pyc
 *.swp
-pystun.egg-info
-build
-dist
-env/
+.coverage
+build/
+dist/
+pystun3.egg-info
+venv/

.travis.yml

@@ -1,5 +1,9 @@
 Changelog
 ---------
+1.0.0 (2018/06/12)
+******************
+- Release as ``pystun3`` with support for Python 3.
+
 0.1.0 (2014/11/07)
 ******************
 - Drop support for Python 2.6 and earlier.

CHANGELOG.rst

@@ -1,33 +1,29 @@
-.. image:: https://travis-ci.org/jtriley/pystun.svg?branch=master
-    :target: https://travis-ci.org/jtriley/pystun
+PyStun3
+=======
+A Python STUN client for getting NAT type and external IP. Supports Python
+versions 2 and 3.
 
-.. image:: https://coveralls.io/repos/jtriley/pystun/badge.png
-   :target: https://coveralls.io/r/jtriley/pystun
+This project has been forked several times:
+- `original project by gaohawk`_
+- `taken over by jtriley`_
+- `forked and patched to support py3 by zoumi`_
+- and, finally, forked by `TalkIQ`_
 
-
-PyStun
-======
-A Python STUN client for getting NAT type and external IP
-
-This is a fork of pystun originally created by gaohawk (http://code.google.com/p/pystun/)
-
-PyStun follows RFC 3489: http://www.ietf.org/rfc/rfc3489.txt
-
-A server following STUN-bis hasn't been found on internet so RFC3489 is the
-only implementation.
+PyStun follows `RFC 3489`_. A server following STUN-bis hasn't been found on
+internet so RFC3489 is the only implementation.
 
 Installation
 ------------
 To install the latest version::
 
-    $ pip install pystun
+    $ pip install pystun3
 
 or download/clone the source and install manually using::
 
-    $ cd /path/to/pystun/src
+    $ cd /path/to/pystun3/src
     $ python setup.py install
 
-If you're hacking on pystun you should use the 'develop' command instead::
+If you're hacking on ``pystun3`` you should use the 'develop' command instead::
 
     $ python setup.py develop
 
@@ -38,16 +34,16 @@ Usage
 -----
 From command line::
 
-    $ pystun
+    $ pystun3
     NAT Type: Full Cone
     External IP: <your-ip-here>
     External Port: 54320
 
 Pass --help for more options::
 
-    % pystun --help
-    usage: pystun [-h] [-d] [-H STUN_HOST] [-P STUN_PORT] [-i SOURCE_IP]
-                  [-p SOURCE_PORT] [--version]
+    % pystun3 --help
+    usage: pystun3 [-h] [-d] [-H STUN_HOST] [-P STUN_PORT] [-i SOURCE_IP]
+                   [-p SOURCE_PORT] [--version]
 
     optional arguments:
       -h, --help            show this help message and exit
@@ -68,8 +64,8 @@ From Python::
     nat_type, external_ip, external_port = stun.get_ip_info()
 
 This will rotate through an internal list of STUN servers until a response is
-found. If no response is found you will get "Blocked" as the *nat_type* and
-**None** for *external_ip* and *external_port*.
+found. If no response is found you will get ``"Blocked"`` as the ``nat_type``
+and ``None`` for ``external_ip`` and ``external_port``.
 
 If you prefer to use a specific STUN server::
 
@@ -91,3 +87,9 @@ Read the code for more details...
 LICENSE
 -------
 MIT
+
+.. _forked and patched to support py3 by zoumi: https://github.com/zoumi/pystun
+.. _original project by gaohawk: http://code.google.com/p/pystun/
+.. _RFC 3489: http://www.ietf.org/rfc/rfc3489.txt
+.. _taken over by jtriley: https://github.com/jtriley/pystun
+.. _TalkIQ: https://github.com/talkiq

Makefile

@@ -9,14 +9,14 @@ def main():
     README = open(os.path.join(src, 'README.rst')).read()
 
     setup(
-        name='pystun',
+        name='pystun3',
         version=stun.__version__,
         packages=find_packages(),
         zip_safe=False,
         license='MIT',
-        author='Justin Riley (original author: gaohawk)',
-        author_email='justin.t.riley@gmail.com',
-        url='http://github.com/jtriley/pystun',
+        author='TalkIQ (original authors: gaohawk, Justin Riley)',
+        author_email='engineering@talkiq.com',
+        url='http://github.com/talkiq/pystun3',
         description='A Python STUN client for getting NAT type and external IP (RFC 3489)',
         long_description=README,
         keywords='STUN NAT',
@@ -32,7 +32,7 @@ def main():
         test_suite='tests',
         entry_points={
             'console_scripts': [
-                'pystun=stun.cli:main'
+                'pystun3=stun.cli:main'
             ]
         }
     )