Changing your settings.py¶

Modifiy your projects settings.py file following the next steps:

1. Check your INSTALLED_APPS:

INSTALLED_APPS = (
  # django required contrib apps
  'django.contrib.sites',
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
  'django.contrib.sitemaps',
  # 3rd-party required apps:
  'pagination',
  'tagging',
  'pinax_theme_bootstrap',
  # and finally:
  'planet',
)

2. Configure your database. Here is an example using mysql:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
        'NAME': 'planet',                      # Or path to database file if using sqlite3.
        'USER': '<myuser>',                      # Not used with sqlite3.
        'PASSWORD': '<mypass>',                  # Not used with sqlite3.
        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
    }
}

3. Choose a site id:

SITE_ID = 1

4. For Django 1.8 include the following context processors:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [
            '/path/to/project/templates',
        ],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                                'django.template.context_processors.i18n',
                                'django.template.context_processors.media',
                                'django.template.context_processors.static',
                                'django.template.context_processors.tz',
                'planet.context_processors.context',
            ],
        },
    },
]

If you’re still using Django 1.6.x or 1.7.x, then set TEMPLATE_CONTEXT_PROCESSORS this way:

TEMPLATE_CONTEXT_PROCESSORS = (
    'django.contrib.auth.context_processors.auth',
    'django.core.context_processors.debug',
    'django.core.context_processors.i18n',
    'django.core.context_processors.media',
    'django.core.context_processors.static',
    'django.core.context_processors.tz',
    'django.core.context_processors.request',
    'django.contrib.messages.context_processors.messages',
    'planet.context_processors.context',
)

5. Check your middlewares to include:

MIDDLEWARE_CLASSES = (
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'pagination.middleware.PaginationMiddleware',
)

Please do not forget pagination.middleware.PaginationMiddleware middleware!

5. Add planet configuration variables:

PLANET = {
    "USER_AGENT": "My Planet/1.0",
}

6. Properly configure your static files root directory:

STATIC_URL = '/static/'

7. Only for Django 1.6.x or 1.7.x set your projects templates root directory:

TEMPLATE_DIRS = (
    '/path/to/project/templates',
    # other paths...
)

and your template loaders:

TEMPLATE_LOADERS = (
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
    # some other template loaders here...
)

8. Finally in your project’s templates directory create a site_base.html template if you don’t already have one:

{% extends "base.html" %}

9. Optionally, modify cookie names so you don’t have login conflicts with other projects:

LANGUAGE_COOKIE_NAME = "myplanetlng"
SESSION_COOKIE_NAME = "myplanetid"

Congratulations! Your settings are complete. Now you’ll need to change other files in order to get a running project.

Enable planet urls¶

1. Add the planet urls include to your project’s urls.py (remember to also include admin urls so you can use the admin to manage your planet!):

from django.conf.urls import patterns, include, url

from django.contrib import admin
admin.autodiscover()

urlpatterns = patterns('',
    url(r'^', include('planet.urls')),
    url(r'^admin/', include(admin.site.urls)),
    # ... other url bits...
)

Syncdb and add some feeds!¶

1. Then create the database structure:

   ./manage.py syncdb
   

2. Add some feeds:

   python manage.py planet_add_feed http://www.economonitor.com/feed/rss/
   python manage.py planet_add_feed http://www.ft.com/rss/home/us
   

3. And surely you’ll want to add a cron entry to periodically update them all:

   30 * * * * python manage.py planet_update_all_feeds
   

This attempts to pull in new posts every 30 minutes.

4. Now you’re done. Just run:

   ./manage.py runserver
   

and browse your planet at http://localhost:8000/ in your favorite browser!

Index page¶

Post view¶

Tag view¶

django-planet demo website:¶

Running on Heroku:

• Site: https://django-planet.com/

Philosophy¶

• django-planet is BSD-licensed. All contributed code must be either
  • the original work of the author, contributed under the BSD, or...
  • work taken from another project released under a BSD-compatible license.
• GPL’d (or similar) works are not eligible for inclusion.
• django-planet’s git master branch should always be stable, production-ready & passing all tests.

Guidelines For Reporting An Issue/Feature¶

So you’ve found a bug or have a great idea for a feature. Here’s the steps you should take to help get it added/fixed in Tastypie:

• First, check to see if there’s an existing issue/pull request for the bug/feature. All issues are at https://github.com/matagus/django-planet/issues and pull reqs are at https://github.com/matagus/django-planet/pulls.
• If there isn’t one there, please file an issue. The ideal report includes:
  • A description of the problem/suggestion.
  • How to recreate the bug.
  • If relevant, including the versions of your:
    • Python interpreter
    • Django
    • django-planet
    • Optionally of the other dependencies involved
  • Ideally, creating a pull request with a (failing) test case demonstrating what’s wrong. This makes it easy for us to reproduce & fix the problem. Instructions for running the tests are at Welcome to django-planet!

Guidelines For Contributing Code¶

If you’re ready to take the plunge & contribute back some code/docs, the process should look like:

• Fork the project on GitHub into your own account.
• Clone your copy of django-planet.
• Make a new branch in git & commit your changes there.
• Push your new branch up to GitHub.
• Again, ensure there isn’t already an issue or pull request out there on it. If there is & you feel you have a better fix, please take note of the issue number & mention it in your pull request.
• Create a new pull request (based on your branch), including what the problem/feature is, versions of your software & referencing any related issues/pull requests.

In order to be merged into django-planet, contributions must have the following:

• A solid patch that:
  • is clear.
  • works across all supported versions of Python/Django.
  • follows the existing style of the code base (mostly PEP-8).
  • comments included as needed.
• A test case that demonstrates the previous flaw that now passes with the included patch.
• If it adds/changes a public API, it must also include documentation for those changes.
• Must be appropriately licensed (see “Philosophy”).
• Adds yourself to the AUTHORS file.

If your contribution lacks any of these things, they will have to be added by a core contributor before being merged into django-planet proper, which may take substantial time for the all-volunteer team to get to.

Guidelines For Core Contributors¶

If you’ve been granted the commit bit, here’s how to shepherd the changes in:

• Any time you go to work on djano-planet, please use git pull --rebase to fetch the latest changes.

• Any new features/bug fixes must meet the above guidelines for contributing code (solid patch/tests passing/docs included).

• Commits are typically cherry-picked onto a branch off master.

  • This is done so as not to include extraneous commits, as some people submit pull reqs based on their git master that has other things applied to it.

• A set of commits should be squashed down to a single commit.

  • git merge --squash is a good tool for performing this, as is git rebase -i HEAD~N.
  • This is done to prevent anyone using the git repo from accidently pulling work-in-progress commits.

• Commit messages should use past tense, describe what changed & thank anyone involved.

  “”“Added template tag to get all posts.

  Further description appears here if the change warrants an explanation as to why it was done.”“”

• For any patches applied from a contributor, please ensure their name appears in the AUTHORS file.

• When closing issues or pull requests, please reference the SHA in the closing message (i.e. Thanks! Fixed in SHA: 6b93f6). GitHub will automatically link to it.