| Name | django-timeline-logger JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | None |
| Summary | Generic event logger for Django models. |
| upload_time | 2024-10-30 16:09:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | The MIT License (MIT) Copyright (c) 2016 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
generic logging
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
======================
django-timeline-logger
======================
A reusable Django app to log actions and display them in a timeline
|build-status| |code-quality| |coverage| |black|
|python-versions| |django-versions| |pypi-version|
Prerequisites
=============
This project uses ``django.db.models.JSONField``, and as such, you need:
* at least Django 3.2+
* a database supporting ``django.db.models.JSONField``
* A modern setuptools version
Installation
============
Install from PyPI by running
pip install django-timeline-logger
Add ``'timeline_logger'`` to your ``INSTALLED_APPS``.
Run the migrations:
python manage.py migrate
Usage in templates
==================
A custom template tag is provided to render the message of a log entry, for example::
{% extends "timeline_logger/base.html" %}
{% load timeline %}
{% block timeline %}
<ul class="timeline__list col__22--vw">
{% for log in object_list %}
<li class="timeline__entry">
{% render_message log in_view=True %}
</li>
{% endfor %}
</ul>
{% endblock timeline %}
This way, you can pass extra context to the template used for the log object.
Documentation
=============
The extended documentation is available on `Read the Docs`_.
.. _Read the Docs: http://django-timeline-logger.readthedocs.io/en/latest/
.. |build-status| image:: https://github.com/maykinmedia/django-timeline-logger/actions/workflows/ci.yml/badge.svg
:alt: Build status
:target: https://github.com/maykinmedia/django-timeline-logger/actions/workflows/ci.yml
.. |code-quality| image:: https://github.com/maykinmedia/django-timeline-logger/actions//workflows/code_quality.yml/badge.svg
:alt: Code quality checks
:target: https://github.com/maykinmedia/django-timeline-logger/actions//workflows/code_quality.yml
.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-timeline-logger/branch/master/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/django-timeline-logger
:alt: Coverage status
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-timeline-logger.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-timeline-logger.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-timeline-logger.svg
:target: https://pypi.org/project/django-timeline-logger/
Raw data
{
"_id": null,
"home_page": null,
"name": "django-timeline-logger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "django, generic logging",
"author": null,
"author_email": "Maykin Media <support@maykinmedia.nl>",
"download_url": "https://files.pythonhosted.org/packages/ea/3c/053673b3b1a105ea20cb1a967896116dda5b12a5ecaf75a454aa77e6a20a/django_timeline_logger-5.0.0.tar.gz",
"platform": null,
"description": "======================\ndjango-timeline-logger\n======================\n\nA reusable Django app to log actions and display them in a timeline\n\n|build-status| |code-quality| |coverage| |black|\n\n|python-versions| |django-versions| |pypi-version|\n\nPrerequisites\n=============\n\nThis project uses ``django.db.models.JSONField``, and as such, you need:\n\n* at least Django 3.2+\n* a database supporting ``django.db.models.JSONField``\n* A modern setuptools version\n\n\nInstallation\n============\n\nInstall from PyPI by running\n\n pip install django-timeline-logger\n\nAdd ``'timeline_logger'`` to your ``INSTALLED_APPS``.\n\nRun the migrations:\n\n python manage.py migrate\n\n\nUsage in templates\n==================\n\nA custom template tag is provided to render the message of a log entry, for example::\n\n {% extends \"timeline_logger/base.html\" %}\n {% load timeline %}\n\n {% block timeline %}\n <ul class=\"timeline__list col__22--vw\">\n {% for log in object_list %}\n <li class=\"timeline__entry\">\n {% render_message log in_view=True %}\n </li>\n {% endfor %}\n </ul>\n {% endblock timeline %}\n\n\nThis way, you can pass extra context to the template used for the log object.\n\n\nDocumentation\n=============\n\nThe extended documentation is available on `Read the Docs`_.\n\n.. _Read the Docs: http://django-timeline-logger.readthedocs.io/en/latest/\n\n\n.. |build-status| image:: https://github.com/maykinmedia/django-timeline-logger/actions/workflows/ci.yml/badge.svg\n :alt: Build status\n :target: https://github.com/maykinmedia/django-timeline-logger/actions/workflows/ci.yml\n\n.. |code-quality| image:: https://github.com/maykinmedia/django-timeline-logger/actions//workflows/code_quality.yml/badge.svg\n :alt: Code quality checks\n :target: https://github.com/maykinmedia/django-timeline-logger/actions//workflows/code_quality.yml\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-timeline-logger/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/django-timeline-logger\n :alt: Coverage status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-timeline-logger.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-timeline-logger.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/django-timeline-logger.svg\n :target: https://pypi.org/project/django-timeline-logger/\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2016 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Generic event logger for Django models.",
"version": "5.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/django-timeline-logger/issues",
"Changelog": "https://github.com/maykinmedia/django-timeline-logger/blob/master/docs/changelog.rst",
"Documentation": "http://django-timeline-logger.readthedocs.io/en/latest/",
"Homepage": "https://github.com/maykinmedia/django-timeline-logger",
"Source Code": "https://github.com/maykinmedia/django-timeline-logger"
},
"split_keywords": [
"django",
" generic logging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "400b8d4f833b011fc2c082725c79eb6adb1e0f718e47823b7652947c4771b399",
"md5": "2457787c965190d6b6bc4dcff62fa59c",
"sha256": "edbc35eda95e9c9e1bb00dd4a7044a356f791613906597ff4390b02add6ef1e5"
},
"downloads": -1,
"filename": "django_timeline_logger-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2457787c965190d6b6bc4dcff62fa59c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 21329,
"upload_time": "2024-10-30T16:09:38",
"upload_time_iso_8601": "2024-10-30T16:09:38.004127Z",
"url": "https://files.pythonhosted.org/packages/40/0b/8d4f833b011fc2c082725c79eb6adb1e0f718e47823b7652947c4771b399/django_timeline_logger-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea3c053673b3b1a105ea20cb1a967896116dda5b12a5ecaf75a454aa77e6a20a",
"md5": "5498b982724773920bea1464caee56c5",
"sha256": "07a623bced21069df84cd872003e749186fd10288ac8fb8e70d0bd0c9461629b"
},
"downloads": -1,
"filename": "django_timeline_logger-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5498b982724773920bea1464caee56c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15522,
"upload_time": "2024-10-30T16:09:39",
"upload_time_iso_8601": "2024-10-30T16:09:39.654773Z",
"url": "https://files.pythonhosted.org/packages/ea/3c/053673b3b1a105ea20cb1a967896116dda5b12a5ecaf75a454aa77e6a20a/django_timeline_logger-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 16:09:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "django-timeline-logger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-timeline-logger"
}
