From 8763a7b3ec454809327c7795540ccbf3e449e996 Mon Sep 17 00:00:00 2001
From: kthoden <kthoden@gwdg.de>
Date: Sat, 21 Sep 2019 12:53:04 +0200
Subject: [PATCH] New structure for Django module

---
 .gitignore                                    |  3 +
 LICENSE                                       |  1 +
 MANIFEST.in                                   |  5 ++
 README.md => README.rst                       | 29 ++++++++-
 {examples => docs/examples}/2846030.atom      |  0
 {examples => docs/examples}/catalog.atom      |  0
 {examples => docs/examples}/opensearch.xml    |  0
 {examples => docs/examples}/selection.atom    |  0
 .../examples/textbooks.atom                   |  0
 {validators => docs/validators}/atom.rnc      |  0
 .../validators}/opds_catalog.rnc              |  0
 opds/__init__.py                              |  0
 opds/admin.py                                 |  8 +++
 opds/apps.py                                  |  6 ++
 opds/models.py                                | 15 +++++
 opds/templates/eoaseries/index.html           | 63 +++++++++++++++++++
 opds/tests.py                                 |  3 +
 opds/urls.py                                  |  9 +++
 opds/views.py                                 | 18 ++++++
 setup.py                                      | 36 +++++++++++
 20 files changed, 195 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore
 create mode 100644 LICENSE
 create mode 100644 MANIFEST.in
 rename README.md => README.rst (51%)
 rename {examples => docs/examples}/2846030.atom (100%)
 rename {examples => docs/examples}/catalog.atom (100%)
 rename {examples => docs/examples}/opensearch.xml (100%)
 rename {examples => docs/examples}/selection.atom (100%)
 rename textbooks.atom => docs/examples/textbooks.atom (100%)
 rename {validators => docs/validators}/atom.rnc (100%)
 rename {validators => docs/validators}/opds_catalog.rnc (100%)
 create mode 100644 opds/__init__.py
 create mode 100644 opds/admin.py
 create mode 100644 opds/apps.py
 create mode 100644 opds/models.py
 create mode 100644 opds/templates/eoaseries/index.html
 create mode 100644 opds/tests.py
 create mode 100644 opds/urls.py
 create mode 100644 opds/views.py
 create mode 100644 setup.py

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..a3fbdbf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/opds/migrations/
+/dist/
+/django_opds.egg-info/
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..65eddd9
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+Coffeeware
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..3d6e7c5
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,5 @@
+include LICENSE
+include README.rst
+recursive-include opds/static *
+recursive-include opds/templates *
+recursive-include docs *
\ No newline at end of file
diff --git a/README.md b/README.rst
similarity index 51%
rename from README.md
rename to README.rst
index 0e3ac03..45463e0 100644
--- a/README.md
+++ b/README.rst
@@ -1,5 +1,32 @@
-# OPDS for EOA
+=====
+OPDS module for Django
+=====
+
+The OPDS is a Django app and provides and endpoint for OPDS applications
+
+Quick start
+-----------
+
+1. Add "opds" to your INSTALLED_APPS setting like this::
+
+    INSTALLED_APPS = [
+        ...
+        'opds',
+    ]
+
+2. Run `python manage.py migrate` to create the opds models.
+
+
+
+====
+OPDS for EOA
+====
 
 Examples downloaded from <http://www.feedbooks.com/opensearch.xml>, <http://www.feedbooks.com/store/selection.atom> and <http://www.feedbooks.com/catalog.atom>. A title feed was at http://www.feedbooks.com/item/2846030.atom
 
 `textbooks.atom` was manually coded following above examples. It is currently active at http://www.edition-open-access.de/textbooks.atom and can be harvested by programs like [Readium2](https://github.com/readium/readium-desktop/releases).
+
+As an Django app
+----------------
+- views will direct the browser to the app
+- files need to be created
diff --git a/examples/2846030.atom b/docs/examples/2846030.atom
similarity index 100%
rename from examples/2846030.atom
rename to docs/examples/2846030.atom
diff --git a/examples/catalog.atom b/docs/examples/catalog.atom
similarity index 100%
rename from examples/catalog.atom
rename to docs/examples/catalog.atom
diff --git a/examples/opensearch.xml b/docs/examples/opensearch.xml
similarity index 100%
rename from examples/opensearch.xml
rename to docs/examples/opensearch.xml
diff --git a/examples/selection.atom b/docs/examples/selection.atom
similarity index 100%
rename from examples/selection.atom
rename to docs/examples/selection.atom
diff --git a/textbooks.atom b/docs/examples/textbooks.atom
similarity index 100%
rename from textbooks.atom
rename to docs/examples/textbooks.atom
diff --git a/validators/atom.rnc b/docs/validators/atom.rnc
similarity index 100%
rename from validators/atom.rnc
rename to docs/validators/atom.rnc
diff --git a/validators/opds_catalog.rnc b/docs/validators/opds_catalog.rnc
similarity index 100%
rename from validators/opds_catalog.rnc
rename to docs/validators/opds_catalog.rnc
diff --git a/opds/__init__.py b/opds/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/opds/admin.py b/opds/admin.py
new file mode 100644
index 0000000..f0a668f
--- /dev/null
+++ b/opds/admin.py
@@ -0,0 +1,8 @@
+# -*- coding: utf-8; mode: python -*-
+
+from django.contrib import admin
+from .models import Catalogue
+
+
+# Register your models here:
+admin.site.register(Catalogue)
diff --git a/opds/apps.py b/opds/apps.py
new file mode 100644
index 0000000..d218f27
--- /dev/null
+++ b/opds/apps.py
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class OPDSConfig(AppConfig):
+    name = 'opds'
+    verbose_name = 'OPDS module'
diff --git a/opds/models.py b/opds/models.py
new file mode 100644
index 0000000..494ade8
--- /dev/null
+++ b/opds/models.py
@@ -0,0 +1,15 @@
+from django.db import models
+from cms.models import CMSPlugin, Model
+
+class Catalogue(Model):
+    name = models.CharField(
+        max_length=200,
+        unique=True
+    )
+    description = models.CharField(
+        max_length=1000
+    )
+
+    # functions:
+    def __str__(self):
+        return self.name
diff --git a/opds/templates/eoaseries/index.html b/opds/templates/eoaseries/index.html
new file mode 100644
index 0000000..e15cf2e
--- /dev/null
+++ b/opds/templates/eoaseries/index.html
@@ -0,0 +1,63 @@
+{% extends "base.html" %}
+{% load menu_tags %}
+
+{% block title %}{{ request.site.name }}{% endblock %}
+
+{% block breadcrumb %}
+{% show_breadcrumb %}
+{% endblock %}
+
+{% block content %}
+<main class="main">
+  <div class="container">
+    <div class="main-content">
+      <div class="accordion"><a class="accordion__showall" href="#">Show All</a>
+        {% for serie in allseries %}
+        <div class="accordion__item"><a class="accordion__title" id="{{ serie }}">
+            <h2>{{ serie|capfirst }}</h2></a>
+          <div class="accordion__content">
+            <section>
+              {% if serie == 'sources' %}
+              <p>Each volume of the Sources series typically presents a primary source—relevant for the history and development of knowledge—in facsimile, transcription, or translation. The original sources are complemented by an introduction and by commentaries reflecting original scholarly work. The sources reproduced in this series may be rare books, manuscripts, documents or data that are not readily accessible in libraries and archives.</p>
+              {% elif serie == 'studies' %}
+              <p>Each volume of the <em>Studies</em> series is dedicated to a key subject in the history and development of knowledge, bringing together perspectives from different fields and combining source-based empirical research with theoretically guided approaches. The studies are typically working group volumes presenting integrative approaches to problems ranging from the globalization of knowledge to the nature of spatial thinking.</p>
+              {% elif serie == 'proceedings' %}
+              <p>Each volume of the Proceedings series presents the results of a scientific meeting on current issues and supports, at the same time, further cooperation on these issues by offering an electronic platform with further resources and the possibility for comments and interactions.</p>
+              {% elif serie == 'textbooks' %}
+              <p>Each volume of the Textbooks series presents concise and synthetic information on a wide range of current research topics, both introductory and advanced. They use the new publication channel to offer students affordable access to highlevel scientific and scholarly overviews. The textbooks are prepared and updated by experts in the relevant fields and supplemented by additional online materials.</p>
+              {% endif %}
+            </section>
+            {% if Listofpublications %}
+            {% for Publication in Listofpublications %}
+            {% if Publication.Serie == serie %}
+            <div class="project-teaser">
+              <div class="project-teaser__image"><img src="/media/{{ Publication.Coversmallright }}" data-object-fit="cover"/></div>
+              <div class="project-teaser-info">
+                <div class="project-teaser-info__category">{{ Publication.get_Serie_display }} {{ Publication.Number }}</div>
+                <h2 class="project-teaser-info__title">{{ Publication.Title|safe }}</h2>
+                <div class="project-teaser-info__description">{{ Publication.Descriptionshort }}</div>
+                <div class="project-teaser-info-authors">
+                  {% if Publication.Publicationauthor1 %} <a class="project-teaser-info__author-link" href="/author/{{ Publication.Publicationauthor1number }}.html">{{ Publication.Publicationauthor1 }}</a>{% if Publication.Publicationauthor2 %}, <a class="project-teaser-info__author-link" href="/author/{{ Publication.Publicationauthor2number }}.html">{{ Publication.Publicationauthor2 }}</a>{% if Publication.Publicationauthor3 %}, <a class="project-teaser-info__author-link" href="/author/{{ Publication.Publicationauthor3number }}.html">{{ Publication.Publicationauthor3 }}</a>{% if Publication.Publicationauthor4 %}, <a class="project-teaser-info__author-link" href="/author/{{ Publication.Publicationauthor4number }}.html">{{ Publication.Publicationauthor4 }}</a>{% if Publication.Publicationauthor5 %}, <a class="project-teaser-info__author-link" href="/author/{{ Publication.Publicationauthor5number }}.html">{{ Publication.Publicationauthor5 }}</a>
+                  {% endif %}
+                  {% endif %}
+                  {% endif %}
+                  {% endif %}
+                  {% endif %}
+                  {% if Publication.Publicationauthorsuffix %}
+                  {{ Publication.Publicationauthorsuffix }}
+                  {% endif %}</div>
+                <div class="project-teaser-info__buttons"><a class="link" href="/{{ Publication.Serie }}/{{ Publication.Number }}/index.html"><span class="link__label">More</span></a>
+                </div>
+              </div>
+            </div>
+            {% endif %}
+            {% endfor %}
+            {% endif %}
+          </div>
+        </div>
+        {% endfor %}
+      </div>
+    </div>
+  </div>
+</main>
+{% endblock %}
diff --git a/opds/tests.py b/opds/tests.py
new file mode 100644
index 0000000..7ce503c
--- /dev/null
+++ b/opds/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/opds/urls.py b/opds/urls.py
new file mode 100644
index 0000000..3ef4bdc
--- /dev/null
+++ b/opds/urls.py
@@ -0,0 +1,9 @@
+#-*- coding: utf-8 -*-
+from django.conf.urls import url
+
+from . import views
+
+app_name = "opds"
+urlpatterns = [
+    url(r'', views.index),
+]
diff --git a/opds/views.py b/opds/views.py
new file mode 100644
index 0000000..178aa54
--- /dev/null
+++ b/opds/views.py
@@ -0,0 +1,18 @@
+#-*- coding: utf-8 -*-
+from django.urls import reverse
+from django.http import HttpResponse, Http404, HttpResponseRedirect
+from django.shortcuts import get_object_or_404, render
+from django.views import generic
+from eoapublications.models import *
+
+from .models import Catalogue
+
+def index(request):
+    allseries = set(Publication.objects.values_list("Serie", flat=True))
+    Listofpublications = Publication.objects.filter(Published=True).order_by('-Number').order_by('Serie')
+    Content = {
+        'Listofpublications' : Listofpublications,
+        'allseries' : sorted(allseries),
+        'Series' : Series
+    }
+    return render(request, 'eoaseries/index.html', Content)
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..b6239bf
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,36 @@
+# -*- coding: utf-8; mode: python -*-
+
+import os
+from setuptools import find_packages, setup
+
+with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
+    README = readme.read()
+
+# allow setup.py to be run from any path
+os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
+
+setup(
+    name='opds',
+    version='1.0',
+    packages=find_packages(),
+    include_package_data=True,
+    license='Coffeeware',  # example license
+    description='A Django app to provide an OPDS endpoint for book browsing.',
+    long_description=README,
+    url='http://www.edition-open-access.de/',
+    author='Klaus Thoden',
+    author_email='kthoden@mpiwg-berlin.mpg.de',
+    classifiers=[
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Framework :: Django :: 1.8',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Coffeeware',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+    ],
+)