Welcome to dj-announcement-api Documentation!
=============================================


.. |br| raw:: html

   <br />


.. image:: https://img.shields.io/github/license/lazarus-org/dj-announcement-api
    :target: https://github.com/lazarus-org/dj-announcement-api/blob/main/LICENSE
    :alt: License

.. image:: https://img.shields.io/pypi/v/dj-announcement-api
    :target: https://pypi.org/project/dj-announcement-api/
    :alt: PyPI release

.. image:: https://img.shields.io/readthedocs/dj-announcement-api
    :target: https://dj-announcement-api.readthedocs.io/en/latest/
    :alt: Documentation

.. image:: https://img.shields.io/badge/pylint-10/10-brightgreen?logo=python&logoColor=blue
   :target: https://www.pylint.org/
   :alt: Pylint

.. image:: https://img.shields.io/pypi/pyversions/dj-announcement-api
    :target: https://pypi.org/project/dj-announcement-api/
    :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/djversions/dj-announcement-api
    :target: https://pypi.org/project/dj-announcement-api/
    :alt: Supported Django versions

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=yellow
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

.. image:: https://img.shields.io/github/issues/lazarus-org/dj-announcement-api
    :target: https://github.com/lazarus-org/dj-announcement-api/issues
    :alt: Open Issues

.. image:: https://img.shields.io/github/last-commit/lazarus-org/dj-announcement-api
    :target: https://github.com/lazarus-org/dj-announcement-api/commits/main
    :alt: Last Commit

.. image:: https://img.shields.io/github/languages/top/lazarus-org/dj-announcement-api
    :target: https://github.com/lazarus-org/dj-announcement-api
    :alt: Languages

.. image:: https://img.shields.io/codecov/c/github/lazarus-org/dj-announcement-api/main
   :target: https://codecov.io/gh/lazarus-org/dj-announcement-api
   :alt: Coverage



|br|

The `dj-announcement-api <https://github.com/lazarus-org/dj-announcement-api/>`_ is a versatile Django package developed by Lazarus to simplify the management and distribution of announcements via a robust API.

The package allows users to create and manage detailed, categorized announcements, target specific audiences, and schedule announcements with customizable publication and expiration dates.
It offers flexibility, scalability, and performance optimizations, making it ideal for dynamic needs in modern Django applications.

Supported Versions
------------------

`dj-announcement-api` supports the following combinations of Django, REST Framework and Python versions:

==========  ==============  ===========================
Django      REST Framework  Python
==========  ==============  ===========================
4.2         3.14, 3.15      3.9, 3.10, 3.11, 3.12, 3.13
5.0         3.14, 3.15      3.10, 3.11, 3.12, 3.13
5.1         3.14, 3.15      3.10, 3.11, 3.12, 3.13
==========  ==============  ===========================

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

The documentation is organized into the following sections:

.. toctree::
   :maxdepth: 2

   quick_start
   api_guide
   usage
   settings
   examples
   roles
   contributing

Need Help?
----------

If you have questions or have trouble using the app please file a bug report at:

https://github.com/lazarus-org/dj-announcement-api/issues


Indices and tables
==================

* :ref:`search`
* :ref:`genindex`
* :ref:`modindex`