Metadata-Version: 2.1
Name: django-literature
Version: 0.1.0
Summary: A scientific literature management tool for Django
License: MIT
Author: Sam Jennings
Author-email: samuel.scott.jennings@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: django-model-utils (>=4.3.1,<5.0.0)
Requires-Dist: django-sortedm2m (>=3.1.1,<4.0.0)
Requires-Dist: django-taggit (>=3.1.0,<4.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/x-rst

=============================
Django Literature
=============================

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

.. image:: https://travis-ci.org/SSJenny90/django-literature.svg?branch=master
    :target: https://travis-ci.org/SSJenny90/django-literature

.. image:: https://codecov.io/gh/SSJenny90/django-literature/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/SSJenny90/django-literature

A scientific literature management app for Django

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

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

Quickstart
----------

Install Django Literature::

    pip install django-literature

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'literature.apps.LiteratureConfig',
        ...
    )

Add Django Literature's URL patterns:

.. code-block:: python

    from literature import urls as literature_urls


    urlpatterns = [
        ...
        url(r'^', include(literature_urls)),
        ...
    ]

Features
--------

* TODO

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

Does the code actually work?

::

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


Development commands
---------------------

::

    pip install -r requirements_dev.txt
    invoke -l


Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

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

