===============
django-discover
===============

Purpose
=======
This package expose the discover models, made to allow users to discover existent or new features with ease.

Installation
============

The ``django-discover`` package is only available on the Magency private pypi server.

.. code-block:: sh

    pip install -i https://login:password@pypi.magency.ninja/some/index django-discover


Development
===========


The code can be found on the `Magency mhr-python-external-modules repository
<https://github.com/magencydigital/mhr-python-external-modules>`_

Install the required packages:

.. code-block:: sh

    pip install  -i https://login:password@pypi.magency.ninja/some/index -r requirements-dev.txt


To run tests, simply launch the ``runtests.sh`` script.

And for pylint:

.. code-block:: sh

    PYTHONPATH="$PYTHONPATH:." pylint django-discover tests


When ready, update the version in ``django-discover/__init__py`` then create the package:

.. code-block:: sh

    ./setup.py sdist bdist_wheel

You can now upload it to ``devpi``:

.. code-block:: sh

    devpi use https://login:password@pypi.magency.ninja
    devpi login yourlogin
    devpi use yourlogin/dev
    devpi upload dist/django-discover-VERSION*


Support
=======

python>=3.4
django>=1.9
