Commits

Dan Carroll  committed 1434bb7

Adding initial readme, authors, and license

  • Participants
  • Parent commits ea70ea2

Comments (0)

Files changed (3)

+Django-activitysync was created in February 2011 by Dan Carroll <dan@dancarroll.org>.
+
+Copyright (c) 2011, Dan Carroll
+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 this project 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 OWNER 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.
+====================
+Django Activity Sync
+====================
+
+Django-activitysync is an easy to use social activity aggregator for Django
+projects.
+
+It can be used to store and display activity from a range of social networks
+(such as Twitter, Reddit, Google Reader, etc). Unlike other utilities for
+accessing and displaying activity, django-activitysync separates rendering
+from activity updating. All activity information is stored in the project's
+database using Django models, providing great performance for page requests.
+Updating activities happens through a Django management command, which can
+be automated by using a utility like cron.
+
+
+--------
+Features
+--------
+
+- Currently supports the following activity providers:
+
+    * `Twitter`_
+    * `Google Reader`_
+    * `Reddit`_
+
+- Providers are implemented using a simple, common interface, making it very
+  easy to add support for additional networks
+
+
+------------
+Dependencies
+------------
+Dependencies that *must* be meet to use the application:
+
+- Twitter support depends on python-twitter_
+
+- Google Reader and Reddit support depend on feedparser_
+
+
+------------
+Installation
+------------
+
+From pypi_::
+
+    $ pip install django-activitysync
+
+or::
+
+    $ easy_install django-activitysync
+
+or clone from Bitbucket_::
+
+    $ hg clone https://bitbucket.org/dancarroll/django-activitysync
+
+and add social_auth to PYTHONPATH::
+
+    $ export PYTHONPATH=$PYTHONPATH:$(pwd)/django-activitysync/
+
+or::
+
+    $ cd django-activitysync
+    $ sudo python setup.py install
+
+
+-------------
+Configuration
+-------------
+- Add activitysync to PYTHONPATH and installed applications::
+
+    INSTALLED_APPS = (
+        ...
+        'activitysync'
+    )
+
+- Add desired providers to ACTIVITYSYNC_PROVIDERS setting::
+
+    ACTIVITYSYNC_PROVIDERS = (
+        'activitysync.providers.googlereader.GoogleReaderProvider',
+        'activitysync.providers.twitterprovider.TwitterProvider',
+        'activitysync.providers.redditprovider.RedditProvider',
+    )
+
+- Setup provider settings (dependent on which providers are added). Settings
+  required for built-in providers are::
+
+    TWITTER_USERNAME        = ''
+    REDDIT_USERNAME         = ''
+    GOOGLEREADER_SHARED_RSS = '' # URL of your shared items RSS
+    GOOGLEREADER_PUBLIC_URL = '' # URL to public page
+
+- Sync database to create needed models::
+
+    ./manage syncdb
+
+  or (if you have South installed)::
+
+    ./manage migrate activitysync
+
+
+.. _Twitter: http://twitter.com/
+.. _Google Reader: http://www.google.com/reader/
+.. _Reddit: http://reddit.com/
+.. _pypi: http://pypi.python.org/pypi/django-activitysync/
+.. _Bitbucket: https://bitbucket.org/dancarroll/django-activitysync
+