Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

An app to create per-paragraph comments on content (created via Blogging App)

Project Description
=====================================
PirateLearner Annotations App
=====================================

A per-paragraph commenting app that enables you to:

- Create annotations (like those in medium.com) on per-paragraph basis
- Delete annotations

This app is designed to work with the PirateLearner Blogging App, which powers the unique ID generation for each content paragraph.

**Requirements**

- `Python`_ 2.7.
- `Django`_ 1.6.x.
- `Django Rest Framework`_ 3.1.0
- `pi-blogging`_ 0.1.0b1

**Installation**

Use pip for installing the app:

`pip install pi-annotations --pre`

or download zip file from github `here`_

after installation, add rest_framework and annotations to your installed apps and also make sure that requirements are also installed -

| INSTALLED_APPS = (
| ...
| 'reversion',
| 'crispy_forms',
| 'blogging',
| 'taggit',
| 'ckeditor',
| 'django_select2',
| 'annotations',
| 'rest_framework',
| ...
| )

Also add blogging urls in your projects urls.py -

| urlpatterns = i18n_patterns('',
| ...
| url(r'^annotations/', include('annotations.urls', namespace='annotations')),
| ...
| )

after this just run ``python manage.py syncdb`` for creation of database tables.

NOTE: For setting up blogging app, refer to its `documentation`_.

**Usage**


The documentation may be found at `Read The Docs`_.

.. _Python: https://www.python.org/
.. _Django: https://www.djangoproject.com/
.. _here: https://github.com/PirateLearner/blogging/archive/master.zip
.. _`documentation`: http://blogging.readthedocs.org/en/latest/
.. _`Read The Docs`: http://annotations.readthedocs.org/en/latest/
Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pi-annotations-0.1.0.tar.gz (26.9 kB) Copy SHA256 Checksum SHA256 Source Mar 26, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting