{
    "info": {
        "author": "Praekelt Foundation",
        "author_email": "dev@praekeltfoundation.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Web Environment",
            "Framework :: Django",
            "Framework :: Twisted",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: POSIX",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Topic :: Communications",
            "Topic :: Internet",
            "Topic :: System :: Networking"
        ],
        "description": "Vumi Go\n=======\n\nDocumentation available online at http://vumi-go.readthedocs.org/ and in the `docs` directory of the repository.\n\n|vumigo-ci|_ |vumigo-cover|_ |vumigo-waffle|_\n\n.. |vumigo-ci| image:: https://travis-ci.org/praekelt/vumi-go.png?branch=develop\n.. _vumigo-ci: https://travis-ci.org/praekelt/vumi-go\n\n.. |vumigo-cover| image:: https://coveralls.io/repos/praekelt/vumi-go/badge.png?branch=develop\n.. _vumigo-cover: https://coveralls.io/r/praekelt/vumi-go\n\n.. |vumigo-waffle| image:: https://badge.waffle.io/praekelt/vumi-go.png?label=ready\n.. _vumigo-waffle: https://waffle.io/praekelt/vumi-go\n\n\nInstalling\n~~~~~~~~~~\n\nInstall the dependencies::\n\n    $ virtualenv --no-site-packages ve\n    $ source ve/bin/activate\n    (ve)$ pip install -r requirements.pip\n\nOther stuff that's required:\n\n* Redis_\n* RabbitMQ_, after you've installed this run `sudo ./utils/rabbitmq.setup.sh` to set the correct permissions for the vumi RabbitMQ user.\n* Riak_, install as described in: http://wiki.basho.com/Installation.html\n\nAfter installing Riak_, you will need to edit the `/etc/riak/app.config` file: set the storage backend to `eleveldb` instead of `bitcask`, and enable `riak_search`.\n\n.. note::\n    There is a Vagrantfile in the Vumi_ repository that can be used for Vumi Go as well.\n\n\nBootstrapping a development environment\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAfter having installed the dependencies with pip and ensuring that Redis_,\nRiak_ and RabbitMQ_ are running execute the following command:\n\n::\n\n    (ve)$ ./setup_env.sh\n\nThis will generate all the necessary config files for running a set of\nstandard applications and Telnet transports emulating a USSD and SMS\nconnection.\n\nTo start some sample conversations such as Wikipedia execute the\nfollowing command::\n\n    (ve)$ ./setup_env/build/go_startup_env.sh\n\nNext start everything using Supervisord_::\n\n    (ve)$ supervisord -c setup_env/build/go_supervisord.conf\n    (ve)$ supervisorctl -c setup_env/build/go_supervisord.conf\n\nNow you should be able to login to the Vumi UI at http://localhost:8000 using\nthe account details as specified in `setup_env/accounts.yaml`.\n\nThe default accounts created are:\n\n================= ==========\n    Username       Password\n================= ==========\nuser1@example.org password\nuser2@example.org password\n================= ==========\n\nBy default the Wikipedia USSD service is configured to be running on\nlocalhost 8081.\n\n::\n\n    $ telnet localhost 8081\n    Trying 127.0.0.1...\n    Connected to localhost.\n    Escape character is '^]'.\n    Please provide \"to_addr\":\n    *120*10001#\n    Please provide \"from_addr\":\n    simon\n    [Sending all messages to: *120*10001# and from: simon]\n    What would you like to search Wikipedia for?\n    ...\n\nThe SMS delivery part uses 'longcode-10001' as the virtual address and\nthe outbound SMSes as part of the USSD Wikipedia are sent to that address.\n\n\nUsing GTalk as a transport for testing\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo ease local development we often use GTalk. You will need at least two\nGtalk addresses, one will be used for the Vumi transport the other you\nwill need to use with your normal Gtalk client to interact with the service.\n\nStart the XMPP transport with the following command::\n\n    (ve)$ twistd -n vumi_worker \\\n    >      --worker-class=vumi.transports.xmpp.XMPPTransport\n    >      --config=path/to/xmpp-config.yaml\n\nThe configuration for the XMPP transport should have the following parameters::\n\n    transport_name: <desired transport name> # change this\n    username: <your username> # change this\n    password: <your password> # change this\n    host: talk.google.com\n    port: 5222\n    status: chat\n    status_message: Vumi Go!\n\n    middleware:\n        - logging_mw: vumi.middleware.logging.LoggingMiddleware\n        - gtalk_tagging_mw: vumi.middleware.tagger.TaggingMiddleware\n\n    logging_mw:\n        log_level: debug\n\n    gtalk_tagging_mw:\n       incoming:\n         addr_pattern: '^(.+\\@.+)/?.*$'\n         tagpool_template: 'xmpp'\n         tagname_template: '\\1'\n       outgoing:\n         tagname_pattern: '.*'\n         msg_template: {}\n\nFor you to be able to use this account for messaging you will need to add\nit to the `tagpools.yaml` file. Do this by adding the following below\n`ussd_tagpool` under `pools`::\n\n    xmpp_tagpool:\n      tags:\n        - xmpp@example.org # change this\n      metadata:\n        display_name: \"Google Talk\"\n        delivery_class: gtalk\n        transport_type: xmpp\n        user_selects_tag: true\n        server_initiated: true\n        client_initiated: true\n        transport_name: <name of your transport> # change this\n        msg_options: {}\n\nNext update the Tagpool Manager with this new configuration::\n\n    (ve)$ ./go-admin.sh go_setup_env \\\n            --config-file=./setup_env/config.yaml \\\n            --tagpool-file=./setup_env/tagpools.yaml\n\nAnd give your account access to this new tagpool::\n\n    (ve)$ ./go-admin go_assign_tagpool \\\n            --email-address=user1@example.org \\\n            --tagpool=xmpp_tagpool \\\n            --max-keys=0\n\n.. _Redis: http://redis.io\n.. _RabbitMQ: http://rabbitmq.com\n.. _Riak: http://wiki.basho.com/Riak.html\n.. _Vumi: https://github.com/praekelt/vumi\n.. _Supervisord: http://www.supervisord.org",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/praekelt/vumi-go",
        "keywords": null,
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "vumi-go",
        "package_url": "https://pypi.org/project/vumi-go/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/vumi-go/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://github.com/praekelt/vumi-go"
        },
        "release_url": "https://pypi.org/project/vumi-go/0.5.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Vumi Go",
        "version": "0.5.0"
    },
    "last_serial": 2516284,
    "releases": {
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0cd56dac5894bc99725300d2179923c6",
                    "sha256": "f923d83582fa5a7f359cc1452a7816042296211f0fc5247bf3185f22cd06d53b"
                },
                "downloads": -1,
                "filename": "vumi_go-0.5.0-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "0cd56dac5894bc99725300d2179923c6",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 522381,
                "upload_time": "2014-08-19T14:06:49",
                "url": "https://files.pythonhosted.org/packages/76/97/3c7c9355458c514ac323382f4778b25f047b40b867602d0f90868dd2c67b/vumi_go-0.5.0-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d2dce67b536604125010bcaf9b64b34d",
                    "sha256": "00891ea4642aaac343ebc9ee09ed1c483a845c403c6a637195d8e446081a5f51"
                },
                "downloads": -1,
                "filename": "vumi-go-0.5.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d2dce67b536604125010bcaf9b64b34d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 354840,
                "upload_time": "2014-08-19T14:06:38",
                "url": "https://files.pythonhosted.org/packages/81/45/c1d12d170c757366042b5a20a500e37b9c7139b8c198f85a94d92a07e6dc/vumi-go-0.5.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0cd56dac5894bc99725300d2179923c6",
                "sha256": "f923d83582fa5a7f359cc1452a7816042296211f0fc5247bf3185f22cd06d53b"
            },
            "downloads": -1,
            "filename": "vumi_go-0.5.0-py2-none-any.whl",
            "has_sig": false,
            "md5_digest": "0cd56dac5894bc99725300d2179923c6",
            "packagetype": "bdist_wheel",
            "python_version": "py2",
            "requires_python": null,
            "size": 522381,
            "upload_time": "2014-08-19T14:06:49",
            "url": "https://files.pythonhosted.org/packages/76/97/3c7c9355458c514ac323382f4778b25f047b40b867602d0f90868dd2c67b/vumi_go-0.5.0-py2-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d2dce67b536604125010bcaf9b64b34d",
                "sha256": "00891ea4642aaac343ebc9ee09ed1c483a845c403c6a637195d8e446081a5f51"
            },
            "downloads": -1,
            "filename": "vumi-go-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d2dce67b536604125010bcaf9b64b34d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 354840,
            "upload_time": "2014-08-19T14:06:38",
            "url": "https://files.pythonhosted.org/packages/81/45/c1d12d170c757366042b5a20a500e37b9c7139b8c198f85a94d92a07e6dc/vumi-go-0.5.0.tar.gz"
        }
    ]
}