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

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.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

django_literature_knowledgebase-0.7.1-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.1.tar.gz.

File metadata

File hashes

Hashes for django-literature-knowledgebase-0.7.1.tar.gz
Algorithm Hash digest
SHA256 cae786fc9ee8298a5413c65dc73bb783cab46a7064cd1bac369a8f4bb91bfb1e
MD5 1e20bb7ba80e3ad2282d7ff2b4d5cab1
BLAKE2b-256 5dd851eea61b47b437fc18bbe4a30a79aa0d77ec852df024f8c697687b8213a4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for django_literature_knowledgebase-0.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5e4cfb56eab6da7c50c81a00bf758158f41358fd0a3b138fb22fa0c4a97c8406
MD5 c125e6b5e0f784c202aa5fa8b314dd42
BLAKE2b-256 c0d9f6fc12780a7178a7ce149136f66956b2afe913e86aab7687850f940f91fd

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