Django app to manage multilingual documents based on django-filer.
Project description
A Django application to manage multilingual documents and display them on your site in a downloads section.
Comes with a django-cms apphook and is based on django-filer.
Installation
If you want to install the latest stable release from PyPi:
$ pip install django-document-library
If you feel adventurous and want to install the latest commit from GitHub:
$ pip install -e git://github.com/bitmazk/django-document-library.git#egg=document_library
Add document_library to your INSTALLED_APPS:
INSTALLED_APPS = ( ..., 'document_library', )
Run the South migrations:
./manage.py migrate document_library
Admin inline
You can attach documents to any model. To make things easier, you can add a tabular inline to your model’s admin which allows to attach documents.
In your project’s models.py or any file that get’s loaded early, do the following:
from yourapp.admin import YourAdmin from object_attachments.admin import ObjectAttachmentInline YourAdmin.inlines = YourAdmin.inlines[:] + [ObjectAttachmentInline]
Settings
DOCUMENT_LIBRARY_LOGIN_REQUIRED
Default: False
Set this to True if you wand to require login for the views of this app.
DOCUMENT_LIBRARY_PAGINATION_AMOUNT
Default: 1
Amount of documents display on one page.
DOCUMENT_LIBRARY_PAGINATE_BY_CATEGORIES
Default: False
Enables a special ordering of the document list to always show an equal amount of documents for each category.
Sitemaps
To add a sitemap of your documents, add the following to your urlconf:
from document_library.sitemaps import DocumentSitemap urlpatterns += patterns( '', url(r'^sitemap.xml$', 'django.contrib.sitemaps.views.sitemap', { 'sitemaps': { 'documents': DocumentSitemap, }, }), )
Contribute
If you want to contribute to this project, please perform the following steps:
# Fork this repository # Clone your fork $ mkvirtualenv -p python2.7 django-document-library $ pip install -r requirements.txt $ ./logger/tests/runtests.sh # You should get no failing tests $ git co -b feature_branch master # Implement your feature and tests # Describe your change in the CHANGELOG.txt $ git add . && git commit $ git push origin feature_branch # Send us a pull request for your feature branch
Whenever you run the tests a coverage output will be generated in tests/coverage/index.html. When adding new features, please make sure that you keep the coverage at 100%.
Roadmap
Check the issue tracker on github for milestones and features to come.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-document-library-1.5.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f62588dcb19e24d95d895ef7832c9dbfb8658959163558761449c05ba1686146 |
|
MD5 | 7ae97b20a81fbee0ead10581238e8ca3 |
|
BLAKE2b-256 | 041ec371802df6c23dc1c7a464ab5b6ea5e3b97b3c0f23bfb88d3db20ff5c2c6 |