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`:
.. code-block:: python
INSTALLED_APPS = (
...
'literature_knowledgebase',
...
)
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.
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`:
.. code-block:: python
INSTALLED_APPS = (
...
'literature_knowledgebase',
...
)
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.
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d492ccd8b24fcb060c92c3fbae25fa812c1d1f7115ff826d18cfe522d1f93e9 |
|
MD5 | c037bccca0551e3c3beeec30c344c29f |
|
BLAKE2b-256 | ccd89d94d8aa4bbc3767b09fa9cd65e1c63a79fdaf43f85cc9aa63da272e058f |
Close
Hashes for django_literature_knowledgebase-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3de6fa02f63c7ea6d67854bc01e7c6100f4d8b8b476a4ba7c2f0392ad8ab7893 |
|
MD5 | 196e9399d6733827e2c31f619078f54f |
|
BLAKE2b-256 | 10c330d3b05e3bea0e78b44e8194f70e8e34b27358ec7a3356aea984c63faf2a |