tutor-android


Nametutor-android JSON
Version 19.0.0 PyPI version JSON
download
home_pagehttps://github.com/overhangio/tutor-android
SummaryAndroid mobile app plugin for Tutor
upload_time2024-12-16 19:40:07
maintainerEdly
docs_urlNone
authorEdly
requires_python>=3.9
licenseAGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Android application plugin for `Tutor <https://docs.tutor.edly.io>`__
=========================================================================

This is a plugin to easily build an Android mobile application for your `Open edX <https://open.edx.org>`__ instance.

Installation
------------

::

    tutor plugins install android

Usage
-----

Enable the plugin and start the platform::

    tutor plugins enable android
    tutor local launch

The ``.apk`` file will then be available for download at http(s)://mobile.LMS_HOST/app.apk. When running locally, this will be: http://mobile.local.openedx.io/app.apk. You can forward this address to your students for download.

Building a custom Android app
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The Android app is built from the `official openedx-app-android repository <https://github.com/openedx/openedx-app-android/>`__. To change this repository or the app version, you can simply build a different docker image with::

    tutor images build \
        --build-arg ANDROID_APP_REPOSITORY=https://github.com/mycustomfork/openedx-app-android \
        --build-arg ANDROID_APP_VERSION=master \
        android

Alternatively, you can build an image from a local checked-out fork of openedx-app-android::

    tutor mounts add /path/to/openedx-app-android
    tutor local launch

Making courses visible in app
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default, courses are not visible in the mobile app. To make them available, go to Studio → YOUR COURSE → Settings → Advanced Settings and set ``Mobile Course Available`` to true.


Releasing an Android app
~~~~~~~~~~~~~~~~~~~~~~~~

**Note**: this is an untested feature.

Releasing an Android app on the Play Store requires to build the app in release mode. To do so, modify the following Tutor settings::

    tutor config save \
      --set ANDROID_RELEASE_STORE_PASSWORD=yourstorepassword \
      --set ANDROID_RELEASE_KEY_PASSWORD=yourreleasekeypassword \
      --set ANDROID_RELEASE_KEY_ALIAS=yourreleasekeyalias \
      --set ANDROID_ENABLE_RELEASE_MODE=true

Then, place your keystore file in ``$(tutor config printroot)/env/plugins/android/build/app/config/app.keystore``. Finally, rebuild the image by starting the "android-app" container::

    tutor local start -d android-app

Customising the Android app
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Customising the application, such as the logo or the background image, is currently not supported. If you are interested by this feature, please tell us about it in the Tutor `discussion forums <https://discuss.overhang.io>`_.

Troubleshooting
---------------

This Tutor plugin is maintained by Muhammad Ali from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.

License
-------

This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-android/blob/release/LICENSE.txt>`_.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/overhangio/tutor-android",
    "name": "tutor-android",
    "maintainer": "Edly",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "muhammad.ali@arbisoft.com",
    "keywords": null,
    "author": "Edly",
    "author_email": "hello@edly.io",
    "download_url": "https://files.pythonhosted.org/packages/4c/8f/7ba89d624672d4e49b82fa44afcf6fc93b9d26d59ba39f3edba068f7a093/tutor_android-19.0.0.tar.gz",
    "platform": null,
    "description": "Android application plugin for `Tutor <https://docs.tutor.edly.io>`__\n=========================================================================\n\nThis is a plugin to easily build an Android mobile application for your `Open edX <https://open.edx.org>`__ instance.\n\nInstallation\n------------\n\n::\n\n    tutor plugins install android\n\nUsage\n-----\n\nEnable the plugin and start the platform::\n\n    tutor plugins enable android\n    tutor local launch\n\nThe ``.apk`` file will then be available for download at http(s)://mobile.LMS_HOST/app.apk. When running locally, this will be: http://mobile.local.openedx.io/app.apk. You can forward this address to your students for download.\n\nBuilding a custom Android app\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe Android app is built from the `official openedx-app-android repository <https://github.com/openedx/openedx-app-android/>`__. To change this repository or the app version, you can simply build a different docker image with::\n\n    tutor images build \\\n        --build-arg ANDROID_APP_REPOSITORY=https://github.com/mycustomfork/openedx-app-android \\\n        --build-arg ANDROID_APP_VERSION=master \\\n        android\n\nAlternatively, you can build an image from a local checked-out fork of openedx-app-android::\n\n    tutor mounts add /path/to/openedx-app-android\n    tutor local launch\n\nMaking courses visible in app\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nBy default, courses are not visible in the mobile app. To make them available, go to Studio \u2192 YOUR COURSE \u2192 Settings \u2192 Advanced Settings and set ``Mobile Course Available`` to true.\n\n\nReleasing an Android app\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Note**: this is an untested feature.\n\nReleasing an Android app on the Play Store requires to build the app in release mode. To do so, modify the following Tutor settings::\n\n    tutor config save \\\n      --set ANDROID_RELEASE_STORE_PASSWORD=yourstorepassword \\\n      --set ANDROID_RELEASE_KEY_PASSWORD=yourreleasekeypassword \\\n      --set ANDROID_RELEASE_KEY_ALIAS=yourreleasekeyalias \\\n      --set ANDROID_ENABLE_RELEASE_MODE=true\n\nThen, place your keystore file in ``$(tutor config printroot)/env/plugins/android/build/app/config/app.keystore``. Finally, rebuild the image by starting the \"android-app\" container::\n\n    tutor local start -d android-app\n\nCustomising the Android app\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCustomising the application, such as the logo or the background image, is currently not supported. If you are interested by this feature, please tell us about it in the Tutor `discussion forums <https://discuss.overhang.io>`_.\n\nTroubleshooting\n---------------\n\nThis Tutor plugin is maintained by Muhammad Ali from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.\n\nLicense\n-------\n\nThis work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-android/blob/release/LICENSE.txt>`_.\n",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "Android mobile app plugin for Tutor",
    "version": "19.0.0",
    "project_urls": {
        "Code": "https://github.com/overhangio/tutor-android",
        "Community": "https://discuss.openedx.org",
        "Homepage": "https://github.com/overhangio/tutor-android",
        "Issue tracker": "https://github.com/overhangio/tutor-android/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4c8f7ba89d624672d4e49b82fa44afcf6fc93b9d26d59ba39f3edba068f7a093",
                "md5": "4682d1e9ece068253ca2085bf946d587",
                "sha256": "42313de5cee5125b30fb5a3e1ca04d12f1308afda837b2e3b5701353c37eff94"
            },
            "downloads": -1,
            "filename": "tutor_android-19.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4682d1e9ece068253ca2085bf946d587",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 20680,
            "upload_time": "2024-12-16T19:40:07",
            "upload_time_iso_8601": "2024-12-16T19:40:07.989763Z",
            "url": "https://files.pythonhosted.org/packages/4c/8f/7ba89d624672d4e49b82fa44afcf6fc93b9d26d59ba39f3edba068f7a093/tutor_android-19.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-16 19:40:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "overhangio",
    "github_project": "tutor-android",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tutor-android"
}
        
Elapsed time: 0.35945s