Metadata-Version: 2.0
Name: fun-cmd
Version: 0.2.0
Summary: Convenience tool to handle FUN services
Home-page: https://github.com/openfun/fun-cmd
Author: Open FUN (France Universite Numerique)
Author-email: fun.dev@fun-mooc.fr
License: AGPL 3.0
Description-Content-Type: UNKNOWN
Keywords: Django,Open edX,MOOC
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Provides-Extra: dev
Requires-Dist: nose; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'

=======
FUN-CMD
=======

A command-line tool for OpenFUN. fun-cmd was designed as a helpful tool to run
frequently-used OpendEdx commands in development and test modes.

.. image:: https://circleci.com/gh/openfun/fun-cmd/tree/master.svg?style=svg
    :target: https://circleci.com/gh/openfun/fun-cmd/tree/master

Install
=======

You should install fun-cmd in your OpenEdx virtual box::

    pip install --extra-index-url https://pypi.fury.io/openfun fun-cmd


Available commands
==================

Run all fun-apps tests::

    fun lms.test test ../fun-apps

Run tests from a FUN application::

    fun lms.test test ../fun-apps/backoffice

Start a shell::

    fun lms.dev shell

Install requirements (including FUN requirements)::

    fun lms.dev requirements

Process assets, static collection::

    fun lms.dev assets

Install requirements, process assets and start an lms instance::

    fun lms.dev run

If you just want to run the lms instance::

    fun lms.dev run --fast

Contribute
==========

Don't forget to run (and write) tests::

    nosetests