# Django Literature
[](https://github.com/SSJenny90/django-literature/actions/workflows/build.yml)
[](https://github.com/SSJenny90/django-literature/actions/workflows/docs.yml)
[](https://codecov.io/gh/SSJenny90/django-literature)
Streamline the handling of citable literature in your Django web applications.
Documentation
-------------
The full documentation is at https://ssjenny90.github.io/django-literature/
About
---------
Django Literature is designed to facilitate the management and organization of citable literature within your Django project by providing a set of tools and models that enable you to easily handle literature citations, references, and related metadata in your projects.
Features
-----------
- **Literature Models**: The package offers pre-built Django models for literature references, authors, journals, and other relevant entities. These models allow developers to store and manage literature-related information in their applications' databases.
- **Integration**: Django Literature easily integrates with existing models in a Django project, enabling the association of literature references with other data objects, such as articles, blog posts, or research papers.
- **Efficient Querying**: Django Literature provides intuitive query methods that allow developers to retrieve literature references based on various criteria, such as author, title, journal, or publication year. This makes it easy to search and filter the literature database.
- **Citation Generation**: The package offers utilities to generate citations in various formats, such as APA, MLA, or Chicago style. This feature simplifies the process of programmatically generating citations for references within the Django application.
- **Admin Interface**: Django Literature includes an admin interface that allows authorized users to manage literature references conveniently. The interface provides CRUD (Create, Read, Update, Delete) operations for literature objects and ensures data integrity.
Quickstart
----------
Install Django Literature::
pip install django-literature
Add it to your `INSTALLED_APPS`:
INSTALLED_APPS = (
...
'literature',
...
)
Add Django Literature's URL patterns:
urlpatterns = [
...
path('', include("literature.urls")),
...
]
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
-------
Raw data
{
"_id": null,
"home_page": "https://github.com/SSJenny90/django-literature",
"name": "django-literature",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "django,literature,publications,scientific,research",
"author": "Sam Jennings",
"author_email": "samuel.scott.jennings@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/40/42/7ad8dc5dbca028bbe28cf85e09a0d2e10b47518295f32a77fd605822cb50/django_literature-0.1.7.tar.gz",
"platform": null,
"description": "# Django Literature \n\n[](https://github.com/SSJenny90/django-literature/actions/workflows/build.yml)\n[](https://github.com/SSJenny90/django-literature/actions/workflows/docs.yml)\n[](https://codecov.io/gh/SSJenny90/django-literature)\n\n\n\n\nStreamline the handling of citable literature in your Django web applications.\n\nDocumentation\n-------------\n\nThe full documentation is at https://ssjenny90.github.io/django-literature/\n\nAbout\n---------\n\nDjango Literature is designed to facilitate the management and organization of citable literature within your Django project by providing a set of tools and models that enable you to easily handle literature citations, references, and related metadata in your projects.\n\nFeatures\n-----------\n\n- **Literature Models**: The package offers pre-built Django models for literature references, authors, journals, and other relevant entities. These models allow developers to store and manage literature-related information in their applications' databases.\n\n- **Integration**: Django Literature easily integrates with existing models in a Django project, enabling the association of literature references with other data objects, such as articles, blog posts, or research papers.\n\n- **Efficient Querying**: Django Literature provides intuitive query methods that allow developers to retrieve literature references based on various criteria, such as author, title, journal, or publication year. This makes it easy to search and filter the literature database.\n\n- **Citation Generation**: The package offers utilities to generate citations in various formats, such as APA, MLA, or Chicago style. This feature simplifies the process of programmatically generating citations for references within the Django application.\n\n- **Admin Interface**: Django Literature includes an admin interface that allows authorized users to manage literature references conveniently. The interface provides CRUD (Create, Read, Update, Delete) operations for literature objects and ensures data integrity.\n\nQuickstart\n----------\n\nInstall Django Literature::\n\n pip install django-literature\n\nAdd it to your `INSTALLED_APPS`:\n\n\n INSTALLED_APPS = (\n ...\n 'literature',\n ...\n )\n\nAdd Django Literature's URL patterns:\n\n urlpatterns = [\n ...\n path('', include(\"literature.urls\")),\n ...\n ]\n\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n source <YOURVIRTUALENV>/bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\n\nDevelopment commands\n---------------------\n\n pip install -r requirements_dev.txt\n invoke -l\n\n\nCredits\n-------\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A scientific literature management tool for Django",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://github.com/SSJenny90/django-literature"
},
"split_keywords": [
"django",
"literature",
"publications",
"scientific",
"research"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "117e0272c17ea7269031380153bc356295272f160fb75336edfbdcf9dc6a3aa3",
"md5": "b0935611a4e698ef902dd8efe22e803b",
"sha256": "3cdbc80839544c64370e9fd6c7a31eb96e2e70367297eb02a9fa6fc972b1bec4"
},
"downloads": -1,
"filename": "django_literature-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0935611a4e698ef902dd8efe22e803b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 3814273,
"upload_time": "2023-07-18T18:25:47",
"upload_time_iso_8601": "2023-07-18T18:25:47.674974Z",
"url": "https://files.pythonhosted.org/packages/11/7e/0272c17ea7269031380153bc356295272f160fb75336edfbdcf9dc6a3aa3/django_literature-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40427ad8dc5dbca028bbe28cf85e09a0d2e10b47518295f32a77fd605822cb50",
"md5": "a68eb67823a96d23dccd947bf3560438",
"sha256": "a81279338069e6fb89170d19dc6f7e31e84ce131dd6b6d449ee38ea731e99154"
},
"downloads": -1,
"filename": "django_literature-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "a68eb67823a96d23dccd947bf3560438",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3788645,
"upload_time": "2023-07-18T18:25:49",
"upload_time_iso_8601": "2023-07-18T18:25:49.273396Z",
"url": "https://files.pythonhosted.org/packages/40/42/7ad8dc5dbca028bbe28cf85e09a0d2e10b47518295f32a77fd605822cb50/django_literature-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-18 18:25:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SSJenny90",
"github_project": "django-literature",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "django-literature"
}
JSON
