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)
++++++++++++++++++
* Added REST API filters.
* Added URLs to pubmed article and NCBI utils.
0.2.1 (2018-01-09)
++++++++++++++++++
* Fixed issues with migrations
0.2.2 (2018-01-12)
++++++++++++++++++
* Fixed route names for SimpleRouter.
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)
++++++++++++++++++
* Added REST API filters.
* Added URLs to pubmed article and NCBI utils.
0.2.1 (2018-01-09)
++++++++++++++++++
* Fixed issues with migrations
0.2.2 (2018-01-12)
++++++++++++++++++
* Fixed route names for SimpleRouter.
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.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecbe8c33864678bb90441cb394379653255c4e3190a413b1879a54616fd9d148 |
|
MD5 | c108c84d78e38422e6cd39a5ac1a7bdf |
|
BLAKE2b-256 | 08c69a6d14738759def528bb84950cf3836f17b2e1fcc83c9347608f6cc7a055 |
Close
Hashes for django_literature_knowledgebase-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16263a1ee00ba3d5ba273353449577067914a77992a374553314c178cd928561 |
|
MD5 | 2cd6497c1164b7854ca58c83c68ef0a1 |
|
BLAKE2b-256 | 0c88f6786b707447358d4c7c7429b4905051b3b754834d05f375f4b16aef6417 |