Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saschwarz/django-periodicals

A Django application for periodical/magazine websites with fully cross linked indices on Periodical, Issue, Article, Author, Article Series and Tags. Provides full text search of article titles and descriptions. A complete set of templates are provided. A sitemap is also dynamically generated.
https://github.com/saschwarz/django-periodicals

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/saschwarz/django-periodicals
Owner: saschwarz
License: bsd-3-clause
Created: 2013-11-23T00:50:51.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2016-12-27T02:17:34.000Z (almost 8 years ago)
Last Synced: 2024-10-04T06:52:50.258Z (about 2 months ago)
Language: Python
Homepage: http://googility.com/periodicals/
Size: 306 KB
Stars: 7
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE

Awesome Lists containing this project

README

=============================
django-periodicals
=============================

.. image:: https://badge.fury.io/py/django-periodicals.png
:target: http://badge.fury.io/py/django-periodicals

.. image:: https://travis-ci.org/saschwarz/django-periodicals.png?branch=master
:target: https://travis-ci.org/saschwarz/django-periodicals

.. image:: https://coveralls.io/repos/saschwarz/django-periodicals/badge.png?branch=master
:target: https://coveralls.io/r/saschwarz/django-periodicals?branch=master

.. image:: https://pypip.in/d/django-periodicals/badge.png
:target: https://crate.io/packages/django-periodicals?version=latest

Documentation
-------------

The full documentation is at http://django-periodicals.rtfd.org.

Features
--------

I developed ``django-periodicals`` to provide a searchable index for a printed/online magazine. I wanted all the meta data to be fully cross linked. So users can easily browse all articles for an author, all articles in an issue, all articles in a series/category, all articles tagged with a keyword and so forth.

I turned it in to a standalone application when I ported it to Django 1.5. Here are the features:

* Provides Django models for Periodicals, Issues, Articles, Authors, Tags and Links to external material.

* A full set of templates are provided including:

* Individual Periodical pages with yearly indices.

* Fully cross-linked indexes of Authors, Issues, Article Series, Tags, and Articles.

* Search across Article titles and descriptions.

* Tagging:

* Per article.

* Index pages per tag.

* Tag cloud.

* Moderated user added links of blog posts and other web resources to each Issue and Article. Spam protection by `reCAPTCHA `_ and requiring approval by the admin. This feature can be disabled via setting.

* Django admin forms for data entry.

* Sitemap support.

* Support for Python 2.6, 2.7 and Django 1.5 and 1.6.

* Travis CI unit tests.

* See ``django-periodicals`` in action at `Googility `_.

Quickstart
----------

You can install from GitHub and try out a fully functional demo with data: :ref:`try-the-demo-project`.

Otherwise simply install from a package using ``pip`` which will install it's `PyPi `_ packaged dependencies.

.. code-block :: bash

pip install django-periodicals

Install two packages manually to get newer versions than are currently in PyPi:

.. code-block :: bash

$ pip install -e git://github.com/saschwarz/django-recaptcha.git#egg=django-recaptcha

$ pip install -e git://github.com/nemith/[email protected]#egg=django_tagging-dev

Install a search backend for use by `Haystack `_. To start install Whoosh:

.. code-block :: bash

$ pip install Whoosh

settings.py
+++++++++++

Add ``periodicals`` and the other applications it uses to ``INSTALLED_APPS``:

.. code-block :: python

INSTALLED_APPS = (
...
'haystack',
'tagging',
'captcha',
'periodicals',
)

Configure your Haystack backend. Here is an example using `Whoosh `_:

.. code-block :: python

HAYSTACK_CONNECTIONS = {
'default': {
'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
'PATH': os.path.join(os.path.abspath(os.path.dirname(__file__)), 'whoosh_periodicals_index'),
'STORAGE': 'file',
'POST_LIMIT': 128 * 1024 * 1024,
'INCLUDE_SPELLING': True,
'BATCH_SIZE': 100,
},
}

Configure your reCAPTCHA keys - only used when users add links to Articles or Issues:

.. code-block :: python

RECAPTCHA_PRIVATE_KEY = "your-recaptcha-private-key"
RECAPTCHA_PUBLIC_KEY = "your-recaptcha-public-key"

urls.py
+++++++

Choose a URL prefix at which to base the application:

.. code-block :: python

...
import periodicals

urlpatterns = patterns('',
...
url(r'^admin/', include(admin.site.urls)),
url(r'^periodicals/', include(periodicals.urls)),
)

Management Commands
+++++++++++++++++++

Create the application's database tables:

.. code-block :: bash

$ python manage.py syncdb