{ "info": { "author": "CDH @ Princeton", "author_email": "cdhdevteam@princeton.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5" ], "description": "djiffy\n======\n\n.. sphinx-start-marker-do-not-remove\n\nDjango application to index and display IIIF Manifests for books\n\n.. image:: https://travis-ci.org/Princeton-CDH/djiffy.svg?branch=master\n :target: https://travis-ci.org/Princeton-CDH/djiffy\n :alt: Build Status\n.. image:: https://codecov.io/gh/Princeton-CDH/djiffy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/Princeton-CDH/djiffy\n :alt: Code Coverage\n.. image:: https://landscape.io/github/Princeton-CDH/djiffy/master/landscape.svg?style=flat\n :target: https://landscape.io/github/Princeton-CDH/djiffy/master\n :alt: Code Health\n.. image:: https://requires.io/github/Princeton-CDH/djiffy/requirements.svg?branch=master\n :target: https://requires.io/github/Princeton-CDH/djiffy/requirements/?branch=master\n :alt: Requirements Status\n.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg\n :target: https://saythanks.io/to/cdhdevteam\n\n**djiffy** is intended to be a reusable `Django`_ application for\nworking with digitized book content provided via `IIIF Presentation`_\nmanifests. This is an *alpha* version and it does *not* yet support\nthe full IIIF Presentation specification.\n\n.. Note::\n djiffy is compatible with Django 1.10 and 1.11, but is *not* yet compatible\n with Django 2.0.\n\n\n.. _Django: https://www.djangoproject.com/\n.. _IIIF Presentation: http://iiif.io/api/presentation/2.1/\n\n\nInstallation\n------------\n\nUse pip to install::\n\n pip install djiffy\n\n\nYou can also install from GitHub. Use a branch or tag name, e.g.\n``@develop`` or ``@1.0``, to install a specific tagged release or branch::\n\n pip install git+https://github.com/Princeton-CDH/djiffy.git@develop#egg=djiffy\n\n\nConfiguration\n-------------\n\nAdd `djiffy` to installed applications and make sure that `django.contrib.humanize`\nis also enabled::\n\n INSTALLED_APPS = (\n ...\n 'django.contrib.humanize',\n 'dal',\n 'dal_select2',\n 'djiffy',\n ...\n )\n\n\nInclude the default djiffy urls at the desired base url with the namespace\n`djiffy`::\n\n urlpatterns = [\n ...\n url(r'^iiif-books/', include('djiffy.urls', namespace='djiffy')),\n ...\n ]\n\nRun migrations to create database tables::\n\n python manage.py migrate\n\n.. NOTE::\n\n The templates included require that you have a url configured with\n the name ``site-index``.\n\n\nIf you are need to use djiffy to access manifests that require an\nauthorization token, use **DJIFFY_AUTH_TOKENS** in your project settings\nto configure each domain that requires an auth token. The configuration\nshould be formatted like this::\n\n DJIFFY_AUTH_TOKENS = {\n 'example.com': 'myauthtoken',\n }\n\nUsage\n-----\n\nImport IIIF content using the `import_manifest` manage command. This\ncommand can take an IIIF Collection or single Manifest, via local file\nor URL. Imported content can be viewed in Django admin.::\n\n python manage.py import_manifest http://url.for/iiif/manifest\n python manage.py import_manifest /path/to/local/collection\n\n\nDevelopment instructions\n------------------------\n\nThis git repository uses `git flow`_ branching conventions.\n\n.. _git flow: https://github.com/nvie/gitflow\n\nInitial setup and installation:\n\n- recommended: create and activate a python 3.5 virtualenv::\n\n virtualenv djiffy -p python3.5\n source djiffy/bin/activate\n\n- pip install the package with its python dependencies::\n\n pip install -e .\n\n\nUnit Testing\n^^^^^^^^^^^^\n\nUnit tests are written with `py.test `_ but use some\nDjango test classes for convenience and compatibility with django test suites.\nRunning the tests requires a minimal settings file for Django required\nconfigurations.\n\n- Copy sample test settings and add a **SECRET_KEY**::\n\n cp ci/testsettings.py testsettings.py\n\n- To run the tests, either use the configured setup.py test command::\n\n python setup.py test\n\n- Or install test requirements and use py.test directly::\n\n pip install -e '.[test]'\n py.test\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Princeton-CDH/djiffy", "keywords": "", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "djiffy", "package_url": "https://pypi.org/project/djiffy/", "platform": "", "project_url": "https://pypi.org/project/djiffy/", "project_urls": { "Homepage": "https://github.com/Princeton-CDH/djiffy" }, "release_url": "https://pypi.org/project/djiffy/0.5.0/", "requires_dist": [ "django (<2.0,>=1.10)", "requests", "piffle", "attrdict", "jsonfield", "django-autocomplete-light", "rdflib", "rdflib-jsonld", "sphinx; extra == 'docs'", "pytest; extra == 'test'", "pytest-django; extra == 'test'", "pytest-cov; extra == 'test'", "mysqlclient; extra == 'test'" ], "requires_python": "", "summary": "Django app for IIIF Presentation book content", "version": "0.5.0" }, "last_serial": 5820268, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "1839c8e9e158d31e37cdb247336b7f95", "sha256": "0e41d432420eb73f21d9d5f5f4024b5446e3d3b15ddf96e36761bb3da066dca2" }, "downloads": -1, "filename": "djiffy-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1839c8e9e158d31e37cdb247336b7f95", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 375309, "upload_time": "2017-07-27T20:58:43", "url": "https://files.pythonhosted.org/packages/aa/c0/9b644141885407ebcc88c9128bfac356c0a41e2de5b96bcc26f7633d1746/djiffy-0.2.0-py3-none-any.whl" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "8b9d9bab86df1bb1581422d6a2af4200", "sha256": "4afd00a04ff1f8653dac3c4ca59a1606e3658d42b9005527e23fb67d5570ce3d" }, "downloads": -1, "filename": "djiffy-0.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8b9d9bab86df1bb1581422d6a2af4200", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 373413, "upload_time": "2018-05-02T19:09:13", "url": "https://files.pythonhosted.org/packages/b1/7c/3482ade639ef99d0f8cded6c024ee38bd5b6abf2060bf197320f8dd4bc4c/djiffy-0.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "602a0c1f306c058c12297bd48beafa70", "sha256": "4c8628af7ecfa79e4766436baa853284b60b9b4fab6f1fe41dbb5572808e71c0" }, "downloads": -1, "filename": "djiffy-0.4.1.tar.gz", "has_sig": false, "md5_digest": "602a0c1f306c058c12297bd48beafa70", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 318327, "upload_time": "2018-05-02T19:09:38", "url": "https://files.pythonhosted.org/packages/c3/a2/0db94facb953d97449024ca15eba8ae03c71a62ab7aedefcceb908b285be/djiffy-0.4.1.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "1763b4bb22f49ffc58b391778330b340", "sha256": "ef528d40db44b053e4ab6c4b4a3466d8168946bf2a8735734737dcc13cf54f1c" }, "downloads": -1, "filename": "djiffy-0.5.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1763b4bb22f49ffc58b391778330b340", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 379937, "upload_time": "2018-06-22T15:54:37", "url": "https://files.pythonhosted.org/packages/bf/98/e0ec40ab200391d2d5a1eba66926849a3a6d9965a1b9b7e6c926f6e69503/djiffy-0.5.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eea5ae1308320a933198b403091c1944", "sha256": "4c8d8d22da8183da9a5d5716a0a317ededfe4d3b0966afcd8da06ce2498b1453" }, "downloads": -1, "filename": "djiffy-0.5.0.tar.gz", "has_sig": false, "md5_digest": "eea5ae1308320a933198b403091c1944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322837, "upload_time": "2018-06-22T15:54:39", "url": "https://files.pythonhosted.org/packages/f9/a0/861585dde57dd4359ddbbb9c0b6cc4880d70a843f4b1d9daeda04359a7bf/djiffy-0.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1763b4bb22f49ffc58b391778330b340", "sha256": "ef528d40db44b053e4ab6c4b4a3466d8168946bf2a8735734737dcc13cf54f1c" }, "downloads": -1, "filename": "djiffy-0.5.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1763b4bb22f49ffc58b391778330b340", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 379937, "upload_time": "2018-06-22T15:54:37", "url": "https://files.pythonhosted.org/packages/bf/98/e0ec40ab200391d2d5a1eba66926849a3a6d9965a1b9b7e6c926f6e69503/djiffy-0.5.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eea5ae1308320a933198b403091c1944", "sha256": "4c8d8d22da8183da9a5d5716a0a317ededfe4d3b0966afcd8da06ce2498b1453" }, "downloads": -1, "filename": "djiffy-0.5.0.tar.gz", "has_sig": false, "md5_digest": "eea5ae1308320a933198b403091c1944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 322837, "upload_time": "2018-06-22T15:54:39", "url": "https://files.pythonhosted.org/packages/f9/a0/861585dde57dd4359ddbbb9c0b6cc4880d70a843f4b1d9daeda04359a7bf/djiffy-0.5.0.tar.gz" } ] }