Skip to main content

Django app for creating a knowledge base of curated literature

Project description

=============================
Django Curated Literature Knowledge Base
=============================

.. image:: https://badge.fury.io/py/django-literature-knowledgebase.svg
:target: https://badge.fury.io/py/django-literature-knowledgebase

.. image:: https://travis-ci.org/chopdgd/django-literature-knowledgebase.svg?branch=develop
:target: https://travis-ci.org/chopdgd/django-literature-knowledgebase

.. image:: https://codecov.io/gh/chopdgd/django-literature-knowledgebase/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/chopdgd/django-literature-knowledgebase

.. image:: https://pyup.io/repos/github/chopdgd/django-literature-knowledgebase/shield.svg
:target: https://pyup.io/repos/github/chopdgd/django-literature-knowledgebase/
:alt: Updates

.. image:: https://pyup.io/repos/github/chopdgd/django-literature-knowledgebase/python-3-shield.svg
:target: https://pyup.io/repos/github/chopdgd/django-literature-knowledgebase/
:alt: Python 3

Django app for creating a knowledge base of curated literature

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

The full documentation is at https://django-literature-knowledgebase.readthedocs.io.

Quickstart
----------

Install Django Curated Literature Knowledge Base::

pip install django-literature-knowledgebase

Add it to your `INSTALLED_APPS` (along with DRF and django-filters):

.. code-block:: python

INSTALLED_APPS = (
...
'rest_framework',
'django_filters',
...
'literature_knowledgebase',
'user_activities',
...
)

Add Django Curated Literature Knowledge Base's URL patterns:

.. code-block:: python

from literature_knowledgebase import urls as literature_knowledgebase_urls


urlpatterns = [
...
url(r'^', include(literature_knowledgebase_urls, namespace='literature_knowledgebase')),
...
]

Features
--------

* TODO

Running Tests
-------------

Does the code actually work?

::

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits
-------

Tools used in rendering this package:

* Cookiecutter_
* `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.1.0 (2017-12-29)
++++++++++++++++++

* First release on PyPI.
* Initial models and REST API.

0.2.0 (2018-01-05)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.1.0...v0.2.0>`_

* Added REST API filters.
* Added URLs to pubmed article and NCBI utils.

0.2.1 (2018-01-09)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.2.0...v0.2.1>`_

* Fixed issues with migrations

0.2.2 (2018-01-12)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.2.1...v0.2.2>`_

* Fixed route names for SimpleRouter.

0.3.0 (2018-02-09)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.2.2...v0.3.0>`_

* updated requirements to the latest.

0.4.0 (2018-04-03)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.3.0...v0.4.0>`_

* Added support for GraphQL

0.5.0 (2018-04-07)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.4.0...v0.5.0>`_

* Added support for Django 2.0 and Python 3.6
* Dropped support for Django < 1.11 and Python 2.7, 3.3, 3.4

0.5.1 (2018-04-18)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.5.0...v0.5.1>`_

* Updated 3rd party libs

0.5.2 (2018-05-16)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.5.1...v0.5.2>`_

* Updated 3rd party libs
* Updated setup.py to read requirements from requirements.txt

0.6.0 (2018-06-01)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.5.2...v0.6.0>`_

* Dropped support for GraphQL

0.6.1 (2018-08-13)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.6.0...v0.6.1>`_

* Updated 3rd party requirements. Some requirements had changed so it was causing failures

0.6.2 (2018-10-29)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.6.1...v0.6.2>`_

* Updated 3rd party requirements.

0.7.0 (2018-12-05)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.6.2...v0.7.0>`_

* Added attribute to save PDF for an article
* Added REST API to summarize all details from eutils (efetch and esummary) into a single API call

0.7.1 (2018-12-05)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.7.0...v0.7.1>`_

* Added REST API to summarize all details from eutils (efetch and esummary) into a single API call

0.7.2 (2019-01-08)
++++++++++++++++++

`Full Changelog <https://github.com/chopdgd/django-literature-knowledgebase/compare/v0.7.1...v0.7.2>`_

* Updated 3rd party requirements.

Project details


Download files

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

Source Distribution

django-literature-knowledgebase-0.7.2.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

django_literature_knowledgebase-0.7.2-py2.py3-none-any.whl (12.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-literature-knowledgebase-0.7.2.tar.gz.

File metadata

File hashes

Hashes for django-literature-knowledgebase-0.7.2.tar.gz
Algorithm Hash digest
SHA256 f62fc6bd1a21e3c6aec85457cb9e6ef76404e42ddef9215258b6c616e140a11a
MD5 ec540a8709925d6cddac72b13212d47c
BLAKE2b-256 80fb8d6008018eb46d0291fcfc9e40e806b827fc63378d78ca35487524c075ae

See more details on using hashes here.

Provenance

File details

Details for the file django_literature_knowledgebase-0.7.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_literature_knowledgebase-0.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ebe20d4bf0fe53307e319e22b7ce83d564ca5a1ab4dacb7263ad5e11821765d8
MD5 d992baee31c8e5eb1cc86277a7078f91
BLAKE2b-256 7aa8b0411ea99ae5da1ced11ce739d7664613a7bd8edd2f6c52f606866965412

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page