{
    "info": {
        "author": "Philipp Rautenberg",
        "author_email": "rautenberg@mpisoc.mpg.de",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "=========\nRenuntius\n=========\n\n``renuntius`` is a RESTful webservice for sending messages.\n\nInstallation\n============\n\nThis application was tested, using the following versions:\n\n  * python==2.7\n  * flask==0.9\n  * flask-restless==0.9.3\n  * flask-sqlalchemy==0.16\n\n\nInstallation with pip\n---------------------\n\nUsing ``pip`` is probably the easiest way to install ``renuntius``::\n\n    pip install renuntius\n\nLocal application\n-----------------\n\nIn order to run the application, write the following python-code (e.g.:\n``start_renuntius.py``)::\n\n    from renuntius.messaging import flask, db, app, Message\n\n    db.create_all()\n\n    manager = flask.ext.restless.APIManager(app, flask_sqlalchemy_db=db)\n    manager.create_api(Message, methods=['GET', 'POST'])\n\n    app.run(host=localhost, port=5001)\n\n**Note**: Within the application folder you need a ``config.py``, like::\n\n    # Database\n    SQLALCHEMY_DATABASE_URI = 'sqlite:////tmp/renuntius.sqlite'\n    SQLALCHEMY_ECHO = True\n\n    # E-Mail-Server\n    SMTP_SERVER = 'MAILSERVER.DOMAIN.ORG'\n    SMTP_SERVER_PORT = 25\n\n    # Messages\n    SERVICE_PREAMBLE = u\"This message was automatically generated.\"\n    FROM_DEFAULT = u'\"IT-Renuntius\" <renuntius@DOMAIN.ORG>'\n\nPlease adjust this ``config.py`` to your own settings.\n\nFinally::\n\n    python start_renuntius.py\n\n\nSpecial use case: PostgreSQL\n----------------------------\n\nIn order to be able to use a postgresql server, you need to install\n``psycopg2``. To install ``psycopg2`` within a virtualenv under linux, do the\nfollowing::\n\n  sudo aptitude install libpq-dev python-dev\n  pip install psycopg2\n\nExample ``config.py`` for postgresql (you probably want to specify the\n``SCHEMA``!)::\n\n    # Database\n    SQLALCHEMY_DATABASE_URI = 'postgresql://_ren_admin@ama-prod/mucam'\n    SCHEMA = 'renuntius'\n    SQLALCHEMY_ECHO = False\n\n    # E-Mail-Server\n    SMTP_SERVER = 'MAILSERVER.DOMAIN.ORG'\n    SMTP_SERVER_PORT = 25\n\n    # Messages\n    SERVICE_PREAMBLE = u\"This message was automatically generated.\"\n    FROM_DEFAULT = u'\"IT-Renuntius\" <renuntius@DOMAIN.ORG>'\n\nQuickstart\n==========\n\nSending an E-Mail via ``renuntius``::\n\n    POST http://localhost:5001/api/messages/\n\n    {\"header_from\":     \"other_service@domain.org\",\n     \"header_to\":       \"admins@domain.org\",\n     \"header_subject\":  \"Sent by Renuntius\",\n     \"content\":         \"Everything works fine!\",\n     \"service\":         \"other_service\"\n    }\n\n**Note**: For firefox use ``RESTClient`` add-on to easily ``POST``.\n\nGetting a list of all messages::\n\n    GET http://localhost:5001/api/messages/\n\n(Try `<http://localhost:5001/api/messages/>`_ within your default browser)\n\nQuerying for specific messages::\n\n    GET http://localhost:5001/api/messages/?q={\"filters\":[{\"name\": \"header_from\", \"op\": \"==\", \"val\":\"other_service@domain.org\"}]}\n\nFor a detailed specification of how to use filters, please look at\n`flask-restless <https://flask-restless.readthedocs.org/en/latest/searchformat.html>`_\n\n\nCopyright License\n=================\n\nFor information, see the files LICENSE.txt in this directory.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/MUCAM/Renuntius",
        "keywords": null,
        "license": "LICENSE.txt",
        "maintainer": null,
        "maintainer_email": null,
        "name": "Renuntius",
        "package_url": "https://pypi.org/project/Renuntius/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/Renuntius/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/MUCAM/Renuntius"
        },
        "release_url": "https://pypi.org/project/Renuntius/0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Renuntius is a RESTful webservice for sending messages.",
        "version": "0.1"
    },
    "last_serial": 785531,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2376e9acf0d64c5ffd94e4e35e271604",
                    "sha256": "aff8460d353d36695ded23cf649989f9f5e2ddfd19bbd16658076a9606ca1a00"
                },
                "downloads": -1,
                "filename": "Renuntius-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "2376e9acf0d64c5ffd94e4e35e271604",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4252,
                "upload_time": "2013-03-28T10:51:21",
                "url": "https://files.pythonhosted.org/packages/92/e0/4ca090c9953981b459c455821f4bf2ff669a1acf3a3a73276ea5f90c9093/Renuntius-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "2376e9acf0d64c5ffd94e4e35e271604",
                "sha256": "aff8460d353d36695ded23cf649989f9f5e2ddfd19bbd16658076a9606ca1a00"
            },
            "downloads": -1,
            "filename": "Renuntius-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2376e9acf0d64c5ffd94e4e35e271604",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4252,
            "upload_time": "2013-03-28T10:51:21",
            "url": "https://files.pythonhosted.org/packages/92/e0/4ca090c9953981b459c455821f4bf2ff669a1acf3a3a73276ea5f90c9093/Renuntius-0.1.tar.gz"
        }
    ]
}