Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Commit

Permalink
Various cleanup and small updates
Browse files Browse the repository at this point in the history
  • Loading branch information
posita committed Mar 14, 2017
1 parent f7f9ed7 commit 503f9a5
Show file tree
Hide file tree
Showing 55 changed files with 1,245 additions and 1,488 deletions.
19 changes: 9 additions & 10 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
#-*- encoding: utf-8; mode: ini -*-
# -*- encoding: utf-8; mode: ini -*-

#=========================================================================
# Copyright (c) 2015 Matt Bogosian <mtb19@columbia.edu>.
#
# Please see the accompanying LICENSE (or LICENSE.txt) file for rights and
# restrictions governing use of this software. All rights not expressly
# waived or licensed are reserved. If such a file did not accompany this
# software, then please contact the author before viewing or using this
# =======================================================================
# Copyright and other protections apply. Please see the accompanying
# ``LICENSE`` and ``CREDITS`` files for rights and restrictions governing
# use of this software. All rights not expressly waived or licensed are
# reserved. If those files are missing or appear to be modified from their
# originals, then please contact the author before viewing or using this
# software in any capacity.
#=========================================================================
# ========================================================================

[run] #-------------------------------------------------------------------
[run] # -----------------------------------------------------------------

omit =
.eggs/*
Expand Down
51 changes: 23 additions & 28 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,35 +1,30 @@
#-*- encoding: utf-8 -*-
# -*- encoding: utf-8 -*-

#=========================================================================
# Copyright (c) 2015 Matt Bogosian <mtb19@columbia.edu>.
#
# Please see the accompanying LICENSE (or LICENSE.txt) file for rights and
# restrictions governing use of this software. All rights not expressly
# waived or licensed are reserved. If such a file did not accompany this
# software, then please contact the author before viewing or using this
# =======================================================================
# Copyright and other protections apply. Please see the accompanying
# ``LICENSE`` and ``CREDITS`` files for rights and restrictions governing
# use of this software. All rights not expressly waived or licensed are
# reserved. If those files are missing or appear to be modified from their
# originals, then please contact the author before viewing or using this
# software in any capacity.
#=========================================================================
# ========================================================================

# Various build/test entities
__pycache__
/.cache/
/.coverage
/.eggs/
/.hypothesis/
/.tox/
/build/
/dist/
/docs/_build/
/docs/_static/
/htmlcov/
__pycache__/
_trial_temp
.coverage
.eggs
.hypothesis
.tox
.venv
.venv-*
.virtualenv
*_flymake.py
*.egg
*.egg-info
build
dist
docs/_build
docs/modules.rst
docs/txsocketio.rst
docs/txsocketio.*.rst
htmlcov
*.egg-info/

# Compiled objects
*.class
Expand All @@ -40,7 +35,7 @@ htmlcov
*.py[co]
*.so
dropin.cache
node_modules
node_modules/

# Packages
*.7z
Expand Down Expand Up @@ -68,8 +63,8 @@ nohup.out
.~*
.DS_Store
.DS_Store?
.Spotlight-V100
.Trashes
.Spotlight-V100/
.Trashes/
desktop.ini
ehthumbs.db
Thumbs.db
Expand Down
89 changes: 44 additions & 45 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,64 +1,63 @@
#-*- encoding: utf-8; mode: yaml -*-

#=========================================================================
# Copyright (c) 2015 Matt Bogosian <mtb19@columbia.edu>.
#
# Please see the accompanying LICENSE (or LICENSE.txt) file for rights and
# restrictions governing use of this software. All rights not expressly
# waived or licensed are reserved. If such a file did not accompany this
# software, then please contact the author before viewing or using this
# -*- encoding: utf-8; mode: yaml -*-

# =======================================================================
# Copyright and other protections apply. Please see the accompanying
# ``LICENSE`` and ``CREDITS`` files for rights and restrictions governing
# use of this software. All rights not expressly waived or licensed are
# reserved. If those files are missing or appear to be modified from their
# originals, then please contact the author before viewing or using this
# software in any capacity.
#=========================================================================
# ========================================================================

sudo: false
language: python
python: "3.4"

install:
- pip install coveralls tox
python:
- "2.7"
- "3.3"
- "3.4"
- "3.5"
- "3.6"
- "pypy"
- "pypy3"

# Grrr; <https://github.com/travis-ci/travis-ci/issues/1519> is closed
# without a fix
env:
- TOX_ENV=py27-twisted_15_3-ssl_no
- TOX_ENV=py27-twisted_15_3-ssl_yes
- TOX_ENV=py27-twisted_15_3-ssl_yes TEST_INSIGHT=1
- TOX_ENV=py27-twisted_15_4-ssl_no
- TOX_ENV=py27-twisted_15_4-ssl_yes
- TOX_ENV=py27-twisted_15_4-ssl_yes TEST_INSIGHT=1
- TOX_ENV=py27-twisted_trunk-ssl_no
- TOX_ENV=py27-twisted_trunk-ssl_yes

- TOX_ENV=pypy-twisted_15_3-ssl_no
- TOX_ENV=pypy-twisted_15_3-ssl_yes
- TOX_ENV=pypy-twisted_15_4-ssl_no
- TOX_ENV=pypy-twisted_15_4-ssl_yes
- TOX_ENV=pypy-twisted_trunk-ssl_no
- TOX_ENV=pypy-twisted_trunk-ssl_yes
- TWISTED="16" SSL="no"
- TWISTED="16" SSL="yes"
- TWISTED="17.1" SSL="no"
- TWISTED="17.1" SSL="yes"
- TWISTED="trunk" SSL="no"
- TWISTED="trunk" SSL="yes"

- TOX_ENV=py33-twisted_trunk-ssl_no
- TOX_ENV=py33-twisted_trunk-ssl_yes

- TOX_ENV=py34-twisted_trunk-ssl_no
- TOX_ENV=py34-twisted_trunk-ssl_yes
install:
- pip install coveralls tox-travis

matrix:
allow_failures:
- env: TOX_ENV=py27-twisted_15_3-ssl_yes TEST_INSIGHT=1
- env: TOX_ENV=py27-twisted_15_4-ssl_yes TEST_INSIGHT=1
# 3.6 is experimental (needs pylint >= 2.0)
- python: "3.6"

# PyPy w/ SSL is experimental
- python: "pypy"
env: TWISTED="16" SSL="yes"

- python: "pypy"
env: TWISTED="17.1" SSL="yes"

- python: "pypy"
env: TWISTED="trunk" SSL="yes"

# PyPy3 is experimental
- python: "pypy3"

# Twisted trunk is experimental
- env: TOX_ENV=py27-twisted_trunk-ssl_no
- env: TOX_ENV=py27-twisted_trunk-ssl_yes
- env: TOX_ENV=pypy-twisted_trunk-ssl_no
- env: TOX_ENV=pypy-twisted_trunk-ssl_yes
- env: TOX_ENV=py33-twisted_trunk-ssl_no
- env: TOX_ENV=py33-twisted_trunk-ssl_yes
- env: TOX_ENV=py34-twisted_trunk-ssl_no
- env: TOX_ENV=py34-twisted_trunk-ssl_yes
- env: TWISTED="trunk"

script:
- tox -e "${TOX_ENV}"
- ./runintegrations.sh
- tox
# - ./helpers/runintegrations.sh

after_success:
- coveralls
43 changes: 27 additions & 16 deletions CREDITS
Original file line number Diff line number Diff line change
@@ -1,19 +1,30 @@
Written by Matt Bogosian <https://github.com/posita>.
``CREDITS``
===========

The following individuals or entities have created and contributed
derivative works of this software. By adding your name to this list, you
transfer all title, license, and any other rights to your contributions to
this software to its owner. You further warrant and agree that: (1) your
contributions are exclusively your own creations and no one else has any
right or claim to them; (2) once accepted, your contributions become the
exclusive property of this software' owner and you retain no rights to
them; and (3) you indemnify and hold harmless this software's owner of
against any colorable claim of infringement by a third party for this
software's owner's otherwise lawful use of your contribution, whether or
not such use was contemplated by you at the time you made the
contribution.
Contributors
------------

Contributors:
The following individuals or entities have contributed to this software.

* Aaron Gallagher <_@habnab.it> (see txsocketio.tls and <https://tm.tl/#5642>)
* Roy Hyunjin Han <https://github.com/invisibleroads> (see <https://github.com/invisibleroads/socketIO-client>)
By adding your name to this list, you grant a nonexclusive, perpetual
license to your contributions to this software under the same terms as its
:doc:`LICENSE <LICENSE>`. Further, you warrant that your contributions to
this software are exclusively your own creations and no one else has any
superior right or claim to them. Finally, you agree to indemnify and hold
harmless this software's owner against any colorable claim of infringement
by a third party for this software's owner's otherwise lawful use of your
contribution, whether or not such use was contemplated by you at the time
you made it.

.. Entry format:
.. * `NAME <CONTACT_URL>`__ (see `REPO_URL <REPO_URL>`__)

Influences
----------

The following individuals or entities provided information useful in
making this software. To the best of the author's knowledge, any portion
of this software deriving from such information is properly licensed under
the terms of this software's :doc:`LICENSE <LICENSE>`.

* `Roy Hyunjin Han <https://github.com/invisibleroads>`__ (see <https://github.com/invisibleroads/socketIO-client>)
11 changes: 10 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
``LICENSE``
===========

The MIT License (MIT)
---------------------

Copyright |(c)| 2015-2017 `Matt Bogosian`_ (|@posita|_).

Copyright (c) 2015 Matt Bogosian <mtb19@columbia.edu>.
.. |(c)| unicode:: u+a9
.. _`Matt Bogosian`: mailto:matt@bogosian.net?Subject=modwalk
.. |@posita| replace:: **@posita**
.. _`@posita`: https://github.com/posita

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
Expand Down
15 changes: 15 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# -*- encoding: utf-8 -*-

# ========================================================================
# Copyright and other protections apply. Please see the accompanying
# ``LICENSE`` and ``CREDITS`` files for rights and restrictions governing
# use of this software. All rights not expressly waived or licensed are
# reserved. If those files are missing or appear to be modified from their
# originals, then please contact the author before viewing or using this
# software in any capacity.
# ========================================================================

include \
CREDITS \
LICENSE \
test/requirements.txt
17 changes: 6 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,15 @@
It looks like crap in a text editor, but it has no effect on rendering, and it allows much more useful diffs.
Thank you!
Copyright |(c)| 2015 `Matt Bogosian`_ (|@posita|_).

.. |(c)| unicode:: u+a9
.. _`Matt Bogosian`: mailto:mtb19@columbia.edu?Subject=txsocketio
.. |@posita| replace:: **@posita**
.. _`@posita`: https://github.com/posita

Please see the accompanying |LICENSE|_ (or |LICENSE.txt|_) file for rights and restrictions governing use of this software.
Copyright and other protections apply.
Please see the accompanying |LICENSE|_ and |CREDITS|_ file(s) for rights and restrictions governing use of this software.
All rights not expressly waived or licensed are reserved.
If such a file did not accompany this software, then please contact the author before viewing or using this software in any capacity.
If those files are missing or appear to be modified from their originals, then please contact the author before viewing or using this software in any capacity.

.. |LICENSE| replace:: ``LICENSE``
.. _`LICENSE`: LICENSE
.. |LICENSE.txt| replace:: ``LICENSE.txt``
.. _`LICENSE.txt`: LICENSE
.. |CREDITS| replace:: ``CREDITS``
.. _`CREDITS`: CREDITS

.. image:: https://travis-ci.org/posita/txsocketio.svg?branch=master
:target: https://travis-ci.org/posita/txsocketio?branch=master
Expand Down Expand Up @@ -67,6 +61,7 @@ Jeff Knupp (|@jeffknupp|_) `describes how <https://www.jeffknupp.com/blog/2013/0
``txsocketio`` is a `Socket.IO client <https://github.com/socketio/socket.io-client>`_ implementation for `Twisted <https://twistedmatrix.com/>`_.
It is licensed under the `MIT License <https://opensource.org/licenses/MIT>`_.
See the |LICENSE|_ file for details.
Source code is `available on GitHub <https://github.com/posita/txsocketio>`__.
See `the docs <https://txsocketio.readthedocs.org/en/master/>`__ for more information.

Expand Down
1 change: 1 addition & 0 deletions docs/CREDITS.rst
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = txrc
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 comments on commit 503f9a5

Please sign in to comment.