django-user-activities 1.2.0
Django app for dealing with User activities (likes, tags, comments, etc.)
License: MIT
Keywords: django-user-activities

=============================
Django User Activities
=============================

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

.. image:: https://travis-ci.org/chopdgd/django-user-activities.svg?branch=develop
    :target: https://travis-ci.org/chopdgd/django-user-activities

.. image:: https://codecov.io/gh/chopdgd/django-user-activities/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/chopdgd/django-user-activities

.. image:: https://pyup.io/repos/github/chopdgd/django-user-activities/shield.svg
    :target: https://pyup.io/repos/github/chopdgd/django-user-activities/
    :alt: Updates

.. image:: https://pyup.io/repos/github/chopdgd/django-user-activities/python-3-shield.svg
    :target: https://pyup.io/repos/github/chopdgd/django-user-activities/
    :alt: Python 3

Django app for dealing with User activities (likes, tags, comments, etc.)

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

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

Quickstart
----------

Install Django User Activities::

    pip install django-user-activities

Add it to your `INSTALLED_APPS` (along with DRF and django-filters):

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'rest_framework',
        'django_filters',
        ...
        'user_activities',
        ...
    )

Add Django User Activities's URL patterns:

.. code-block:: python

    from user_activities import urls as user_activities_urls


    urlpatterns = [
        ...
        url(r'^', include(user_activities_urls, namespace='user_activities')),
        ...
    ]

Using Activity, Comment, or Review in your models:

.. code-block:: python

    from django.contrib.contenttypes.fields import GenericRelation
    from django.db import models


    class ExampleModel(models.Model):
        ...
        comments = GenericRelation('user_activities.Comment')
        user_activities = GenericRelation('user_activities.Activity')

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.2.0 (2017-12-28)
++++++++++++++++++

* First release on PyPI.
* Initial models and REST API.

0.3.0 (2017-01-05)
++++++++++++++++++

`0.3.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.2.0...v0.3.0>`_

* Improved REST API filters.

0.3.1 (2017-01-09)
++++++++++++++++++

`0.3.1 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.3.0...v0.3.1>`_

* Fixed issues with migrations.

0.3.2 (2017-01-12)
++++++++++++++++++

`0.3.2 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.3.1...v0.3.2>`_

* Fixed route names for SimpleRouter.

0.4.0 (2017-02-06)
++++++++++++++++++

`0.4.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.3.2...v0.4.0>`_

* Optimized API
* Added additional filters to API
* Made updates to dependencies library

0.4.1 (2017-02-09)
++++++++++++++++++

`0.4.1 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.4.0...v0.4.1>`_

* Fixed changelog
* Made updates to dependencies library

0.5.0 (2017-04-07)
++++++++++++++++++

`0.5.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.4.0...v0.5.0>`_

* Fixed changelog
* Made updates to dependencies library

0.5.1 (2017-04-18)
++++++++++++++++++

`0.5.1 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.0...v0.5.1>`_

* Made updates to dependencies library

0.5.2 (2017-05-16)
++++++++++++++++++

`0.5.2 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.1...v0.5.2>`_

* Updated setup.py to read requirments.txt

0.5.3 (2018-08-13)
++++++++++++++++++

`0.5.3 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.2...v0.5.3>`_

* Updated 3rd party requirements. Some requirements had changed so it was causing failures

0.5.4 (2018-10-29)
++++++++++++++++++

`0.5.4 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.3...v0.5.4>`_

* Updated 3rd party requirements.

0.5.5 (2018-12-18)
++++++++++++++++++

`0.5.5 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.4...v0.5.5>`_

* Minor model change to make text not required in Comment/Review models

0.5.6 (2019-02-08)
++++++++++++++++++

`0.5.6 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.5...v0.5.6>`_

* Updated 3rd party requirements.
* Updated testing to properly use py.text fixtures

0.5.7 (2019-04-10)
++++++++++++++++++

`0.5.7 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.6...v0.5.7>`_

* Updated 3rd party requirements.
* Updated travis to use xenial distribution. Django 2.1 dropped support for SQLite < 3.8.3

0.5.8 (2019-05-31)
++++++++++++++++++

`0.5.8 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.7...v0.5.8>`_

* Updated packaged to mirror new cookiecutter template

0.5.9 (2019-07-26)
++++++++++++++++++

`0.5.9 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.8...v0.5.9>`_

* Updated 3rd party requirements.

0.5.10 (2019-08-09)
+++++++++++++++++++

`0.5.10 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.9...v0.5.10>`_

* Updated 3rd party requirements.

0.5.11 (2019-09-09)
+++++++++++++++++++

`0.5.11 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.10...v0.5.11>`_

* Updated 3rd party requirements.

1.0.0 (2019-11-01)
+++++++++++++++++++

`1.0.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v0.5.11...v1.0.0>`_

* First production release

1.1.0 (2019-11-26)
+++++++++++++++++++

`1.1.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v1.0.0...v1.1.0>`_

* Updated character limit to comments/reviews

1.2.0 (2020-01-24)
+++++++++++++++++++

`1.2.0 Changelog <https://github.com/chopdgd/django-user-activities/compare/v1.1.0...v1.2.0>`_

* Changed comment fields to TextField