Skip to content
This repository has been archived by the owner on Feb 11, 2019. It is now read-only.

Commit

Permalink
Initial skeleton.
Browse files Browse the repository at this point in the history
  • Loading branch information
hodgestar committed Jun 19, 2015
0 parents commit 590252b
Show file tree
Hide file tree
Showing 11 changed files with 184 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .travis.yml
@@ -0,0 +1,25 @@
language: python
python:
- "2.6"
- "2.7"
env:
# Test against the latest version of Twisted.
- TWISTED_VERSION="Twisted"
matrix:
include:
# Test against the oldest version of Twisted that we claim to support
# This is a separate matrix inclusion to avoid spawning unnecessary builds.
- python: "2.7"
env: TWISTED_VERSION="Twisted==13.1.0"
# Test on pypy without coverage, because it's unnecessary and very slow.
- python: "pypy"
env: TWISTED_VERSION="Twisted" NO_COVERAGE="1"
install:
- "pip install ${TWISTED_VERSION}"
- "pip install -r requirements.txt --use-wheel"
- "pip install coveralls --use-wheel"
script:
- if [ -z "$NO_COVERAGE" ]; then COVERAGE_CMD="coverage run --source=vxyowsup"; else COVERAGE_CMD=""; fi
- VUMITEST_REDIS_DB=1 $COVERAGE_CMD `which trial` vxyowsup
after_success:
- if [ -z "$NO_COVERAGE" ]; then coveralls; fi
5 changes: 5 additions & 0 deletions AUTHORS
@@ -0,0 +1,5 @@
Jeremy Thurgood <jeremy@praekelt.com>
Justin van der Merwe <justinvdm@lavabit.com>
Rudi Giesler <rudi@praekelt.com>
Simon Cross <simon.cross@praekeltfoundation.org>
Simon de Haan <simon@praekeltfoundation.org>
28 changes: 28 additions & 0 deletions CONTRIBUTING.rst
@@ -0,0 +1,28 @@
How to contribute to Vumi Yowsup
================================

Vumi Yowsup is an Open Source software project under the BSD license.
We love contributions!

Here's a quick guide on how to contribute to the project:

1. Fork the repository
2. Run the tests, we'll only accept pull requests with passing tests.
Ensure that the tests run with ``trial vxyowsup`` and that you're starting
with a clean slate.
3. Make your changes to your forked repository and ensure that tests are
added where necessary.
4. Make the tests pass.
5. Push to your fork and submit a pull request!
(For bonus points use hub_ if you're turning an
existing issue into a pull request)

At this point you're waiting on us. We like to comment on pull-requests
and where needed possibly request some changes, improvements or alternatives.

Please ensure that your code is PEP8_ compliant and you use 4 spaces
for indentation, tabs are right out.


.. _PEP8: http://www.python.org/dev/peps/pep-0008/
.. _hub: http://defunkt.io/hub/
28 changes: 28 additions & 0 deletions LICENSE
@@ -0,0 +1,28 @@
Copyright (c) Praekelt Foundation and individual contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the Praekelt Foundation nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
11 changes: 11 additions & 0 deletions MANIFEST.in
@@ -0,0 +1,11 @@
# Source distribution files.
include .coveragerc
include AUTHORS
include CONTRIBUTING.rst
include LICENSE
include README.rst
include requirements.txt
include setup.py

# Prune stray bytecode files.
global-exclude *.pyc
26 changes: 26 additions & 0 deletions README.rst
@@ -0,0 +1,26 @@
Vumi Yowsup
===========

A WhatsApp transport for `Vumi`_ built on `Yowsup`_.

.. _Vumi: http://github.com/praekelt/vumi
.. _Yowsup: https://github.com/tgalal/yowsup

|vxyowsup-ci|_ |vxyowsup-cover|_

.. |vxyowsup-ci| image:: https://travis-ci.org/praekelt/vumi-yowsub.png?branch=develop
.. _vxyowsup-ci: https://travis-ci.org/praekelt/vumi-yowsub

.. |vxyowsub-cover| image:: https://coveralls.io/repos/praekelt/vumi-yowsub/badge.png?branch=develop
.. _vxyowsub-cover: https://coveralls.io/r/praekelt/vumi-yowsub

You can contact the Vumi development team in the following ways:

* via *email* by joining the the `vumi-dev@googlegroups.com`_ mailing list
* on *irc* in *#vumi* on the `Freenode IRC network`_

.. _vumi-dev@googlegroups.com: https://groups.google.com/forum/?fromgroups#!forum/vumi-dev
.. _Freenode IRC network: https://webchat.freenode.net/?channels=#vumi

Issues can be filed in the GitHub issue tracker. Please don't use the issue
tracker for general support queries.
3 changes: 3 additions & 0 deletions requirements.txt
@@ -0,0 +1,3 @@
# Our dependencies are all specified in setup.py.

-e .
27 changes: 27 additions & 0 deletions setup.py
@@ -0,0 +1,27 @@
from setuptools import setup, find_packages

setup(
name="vxyowsup",
version="0.0.1a",
url='http://github.com/praekelt/vumi-yowsup',
license='BSD',
description="A WhatsApp transport for Vumi.",
long_description=open('README.rst', 'r').read(),
author='Praekelt Foundation',
author_email='dev@praekeltfoundation.org',
packages=find_packages(),
include_package_data=True,
install_requires=[
'vumi',
'Twisted>=13.1.0',
],
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: POSIX',
'Programming Language :: Python',
'Topic :: Software Development :: Libraries :: Python Modules',
'Topic :: System :: Networking',
],
)
20 changes: 20 additions & 0 deletions utils/bump-version.sh
@@ -0,0 +1,20 @@
#!/bin/bash
VER="$1"

if [[ "x${VER}" = "x" ]]
then
echo "Usage: $0 <version number>"
echo " e.g. $0 0.1.0"
exit 1
fi

function inplace_sed {
# Note: we don't use sed -i -e ... because it isn't supported by FreeBSD
# sed on OS X.
suffix=".inplace.bak"
sed -i"$suffix" -e "$1" "$2"
rm "$2$suffix"
}

inplace_sed "s/\(version[ ]*=[ ]*[\"']\)\(.*\)\([\"'].*\)/\1${VER}\3/" setup.py
inplace_sed "s/^\(__version__[ ]*=[ ]*[\"']\)\(.*\)\([\"'].*\)/\1${VER}\3/" vxyowsup/__init__.py
6 changes: 6 additions & 0 deletions utils/publish.sh
@@ -0,0 +1,6 @@
#!/bin/sh -e

rm dist/* || true
python setup.py sdist bdist_wheel
python setup.py register
twine-upload dist/*
5 changes: 5 additions & 0 deletions vxyowsup/__init__.py
@@ -0,0 +1,5 @@
"""Vumi WhatsApp transport build using Yowsup."""

__version__ = "0.0.1a"

__all__ = []

0 comments on commit 590252b

Please sign in to comment.