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
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
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
Built Distribution
Close
Hashes for django-literature-knowledgebase-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cba2af0072ab6ad6245ccfb9e6dcec7f5eec42f165cba4211e574dd6d2d8470f |
|
MD5 | e207e451d0ddb683153e2101e0475b5d |
|
BLAKE2b-256 | a40d4c80f2d79d4fe5a830bd2f85046dcb8d0875066fe56a3daf51a35cf37e13 |
Close
Hashes for django_literature_knowledgebase-0.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cfe46a487f777421cbf2619d4119569569dcf619f35452be414aeac6280aeca |
|
MD5 | 44704a0131de5eafa0420a122ef4caf2 |
|
BLAKE2b-256 | c302a099c140cf32f34faac363b7cea6e38054a804c10ab42595c3a22b5807d6 |