Metadata-Version: 2.1
Name: django-rest-avatar
Version: 0.1.0
Summary: A django app for handling user avatars using Django Rest Framework
Home-page: https://github.com/bodgerbarnett/django-rest-avatar
Author: Simon Barnett
Author-email: sbarnett@acresofspace.co.uk
License: BSD
Keywords: django-rest-avatar
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: django (>=2.2.13)
Requires-Dist: djangorestframework (>=3.10)
Requires-Dist: django-appconf (>=1.0.4)
Requires-Dist: Pillow (>=8.1.0)

=============================
django-rest-avatar
=============================

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

.. image:: https://travis-ci.org/bodgerbarnett/django-rest-avatar.svg?branch=master
    :target: https://travis-ci.org/bodgerbarnett/django-rest-avatar

.. image:: https://codecov.io/gh/bodgerbarnett/django-rest-avatar/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/bodgerbarnett/django-rest-avatar

A django app for handling user avatars using Django Rest Framework

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

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

Quickstart
----------

Install django-rest-avatar::

    pip install django-rest-avatar

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'rest_avatar.apps.DjangoRestAvatarConfig',
        ...
    )

Add django-rest-avatar's URL patterns:

.. code-block:: python

    from rest_avatar import urls as rest_avatar_urls


    urlpatterns = [
        ...
        url(r'^', include(rest_avatar_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




History
-------

0.1.0 (2021-02-22)
++++++++++++++++++

* First release on PyPI.


