README.rst 1.49 KB
Newer Older
Laury Bueno's avatar
Laury Bueno committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
=============================
Django Courses
=============================

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

.. image:: https://travis-ci.org/hacklabr/django-courses.svg?branch=master
    :target: https://travis-ci.org/hacklabr/django-courses

.. image:: https://codecov.io/gh/hacklabr/django-courses/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/hacklabr/django-courses

A smart Django application to offer MOOC courses functionality

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

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

Quickstart
----------

Install Django Courses::

    pip install django-courses

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django_courses.apps.DjangoCoursesConfig',
        ...
    )

Add Django Courses's URL patterns:

.. code-block:: python

    from django_courses import urls as django_courses_urls


    urlpatterns = [
        ...
        url(r'^', include(django_courses_urls)),
        ...
    ]

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