Go to file
Régis Behmo d65a7a1b38 Fix version information in bundle
`./dist/tutor --version` raises an error:

Traceback (most recent call last):
  File "main", line 4, in <module>
  File "tutor/cli.py", line 21, in main
  File "click/core.py", line 764, in __call__
  File "click/core.py", line 716, in main
  File "click/core.py", line 641, in make_context
  File "click/core.py", line 1089, in parse_args
  File "click/core.py", line 940, in parse_args
  File "click/core.py", line 1477, in handle_parse_result
  File "click/core.py", line 96, in invoke_param_callback
  File "click/decorators.py", line 270, in callback
RuntimeError: Could not determine version
[1659] Failed to execute script main

To address this, we pass the version value directly to click.

This is for issue #156.
2019-02-10 19:29:37 +01:00
.github Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
bin Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
docs Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
requirements Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
tutor Fix version information in bundle 2019-02-10 19:29:37 +01:00
.gitignore Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
.travis.yml Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
CHANGELOG.md Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
README.rst Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00
setup.py Fix version information in bundle 2019-02-10 19:29:37 +01:00
tutor.spec Tutor v3 complete rewrite 2019-02-09 20:30:01 +01:00

README.rst

Tutor 🎓 Open edX 1-click install for everyone
==============================================

.. image:: https://img.shields.io/travis/regisb/tutor.svg
    :alt: Build status
    :target: https://travis-ci.org/regisb/tutor

.. image:: https://img.shields.io/github/issues/regisb/tutor.svg
    :alt: GitHub issues
    :target: https://github.com/regisb/tutor/issues

.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
    :alt: GitHub closed issues
    :target: https://github.com/regisb/tutor/issues?q=is%3Aclosed

.. image:: https://img.shields.io/github/license/regisb/tutor.svg
    :alt: AGPL License
    :target: https://www.gnu.org/licenses/agpl-3.0.en.html

**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.

.. image:: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE.png
    :alt: asciicast
    :target: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE

Quickstart
----------

1. `Download <https://github.com/regisb/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path.
2. Run ``tutor local quickstart``
3. You're done!

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

Extensive documentation is available online: http://docs.tutor.overhang.io/

Contributing
------------

We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!