{
    "info": {
        "author": "Sylwester Gruszka",
        "author_email": "gruszex@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Web Environment",
            "Framework :: Django",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python"
        ],
        "description": "Switter app description\n=======================\n\nSwitter is a drop-in Django app that gets tweets for you, keeps them cached for a short while and makes it easy to display them on your site:\n\n- **backend** part - fetches and caches tweets from Twitter 1.1 API,\n- **frontend** part - is slightly modified version of a popular **jquery.tweet.js** plugin, that uses Switter backend instead of talking directly to Twitter API,\n- **django-cms plugin** that makes use of Switter backend and forntend in an easy and pleasant way: when cached tweets are fresh enogh, it doesn't even make any ajax call, they're rendered right away.\n\n\n\nInstallation\n============\n\n* To install ::\n\n    pip install django-switter\n\n* Add ``'switter'`` to your ``INSTALLED_APPS`` setting::\n\n    INSTALLED_APPS = (\n        # other apps\n        \"switter\",\n        \"switter.plugins\",  # this one is for django-cms\n    )\n\n* Add Switter url patterns to your main urls.py ::\n\n    urlpatterns = patterns('',\n        ...\n        url(r'^switter/', include('switter.urls')),\n        ...\n    )\n\n* And update your database::\n\n    python manage.py migrate switter\n    python manage.py migrate switter.plugins\n\n\n* Or just ``syncdb`` if you don't use South migrations::\n\n    python manage.py syncdb\n\n\n\nUsage\n=====\n\n* Register a Twitter app, get your Twitter OAuth credentials and put them into your settings.py ::\n\n    SWITTER_CONSUMER_KEY = '...'\n    SWITTER_CONSUMER_SECRET = '...'\n    SWITTER_ACCESS_TOKEN = '...'\n    SWITTER_ACCESS_TOKEN_SECRET = '...'\n\n* Once installed it's pretty straighforward to use cms plugin - just add it yo your pages! ::\n\n* Fine tune Switter plugin by overriding ``cms/plugins/switter/default.html`` template ::\n\n    {# cms/plugins/switter/default.html #}\n    {% load sekizai_tags %}\n\n    <section class=\"switter\" id=\"switter-{{ object.id }}\">\n        {% if object.header %}\n            <h2>{{ object.header }}</h2>\n        {% endif %}\n\n        <ul class=\"tweets\">{# loading... #}</ul>\n    </section>\n\n    {% addtoblock \"js\" %}\n        <script type=\"text/javascript\">\n            $(function(){\n                $('#switter-{{ object.id }} .tweets').switter({\n                    // these 3 are Switter-specific:\n                    url: '{% url switter_tweets query_type=object.query_type %}',\n                    url_params: {{ object.get_jquery_ajax_data|safe }},\n                    preloaded_tweets: {{ object.get_tweets_json|safe }},\n\n                    // put the rest of your usual jquery.tweet.js configuration here...\n                    count: {{ object.count }},\n                    loading_text: \"Oooh, loading tweets...\",\n\n                    // for example fancy tweet template: \n                    template: '<p>{text}</p><a class=\"tweet_time\" href=\"{tweet_url}\">{time}</a> <a class=\"tweet_user\" href=\"{user_url}\">by @{screen_name}</a>'\n                });\n            });\n        </script>\n    {% endaddtoblock %}\n\n\n* Not using django-cms? Not a problem! Just use modified Switter plugin template code and include it in your templates ::\n\n    {# my/fancy/switter/_tweets.html to be included here and there #}\n    <section id=\"switter\">\n        <h2>Our tweets</h2>\n        <ul class=\"tweets\"></ul>\n    </section>\n\n    {# you probably want to paste this in the bottom of your base.html #}\n    <script type=\"text/javascript\">\n        // add this javascript at the bottom of your base.html template\n        $(function(){\n            // get user timeline...\n            var switter_url = '{% url switter_tweets query_type='user_timeline' %}'\n            var switter_url_params = {\n                screen_name: 'verybritishproblems',\n                count: 5,\n                exclude_replies: false, // optional\n                include_rts: true // optional\n            }\n\n            // or any Twitter search results:\n            var switter_url = '{% url switter_tweets query_type='search' %}'\n            var switter_url_params = {\n                q: 'from:verybritishproblems', // twitter search query\n                count: 5\n            }\n\n            $('#switter .tweets').switter({\n                // these 3 are Switter-specific:\n                url: switter_url, \n                url_params: switter_url_params,\n                preloaded_tweets: {{ my_cached_tweets_json|safe }}, // optional (will ajax for tweets if not present)\n\n                // put the rest of your usual jquery.tweet.js configuration here...\n                count: 5\n            });\n        });\n    </script>",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://bitbucket.org/grucha/django-switter",
        "keywords": null,
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-switter",
        "package_url": "https://pypi.org/project/django-switter/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-switter/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://bitbucket.org/grucha/django-switter"
        },
        "release_url": "https://pypi.org/project/django-switter/0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Switter is a drop-in Django app that gets tweets for you, keeps them cached for a short while and makes it easy to display them on your site. Switter provides a django-cms plugin.",
        "version": "0.1"
    },
    "last_serial": 772235,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6471caa4a75fd66aa1c273f8a176ecd6",
                    "sha256": "f8978b835583a0684d71ed75619dc5f6b2e5a8d6a6c37d672adb2202dab8bf9b"
                },
                "downloads": -1,
                "filename": "django-switter-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6471caa4a75fd66aa1c273f8a176ecd6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14567,
                "upload_time": "2013-06-16T12:30:12",
                "url": "https://files.pythonhosted.org/packages/7a/47/1980b0b2cc72232cee82a1b6078396ba411013ffafc7224c09237bae99df/django-switter-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6471caa4a75fd66aa1c273f8a176ecd6",
                "sha256": "f8978b835583a0684d71ed75619dc5f6b2e5a8d6a6c37d672adb2202dab8bf9b"
            },
            "downloads": -1,
            "filename": "django-switter-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6471caa4a75fd66aa1c273f8a176ecd6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14567,
            "upload_time": "2013-06-16T12:30:12",
            "url": "https://files.pythonhosted.org/packages/7a/47/1980b0b2cc72232cee82a1b6078396ba411013ffafc7224c09237bae99df/django-switter-0.1.tar.gz"
        }
    ]
}