# Richie Open edX Synchronization application
## Overview
The aim of this Django application is to synchronize the Open edX courses to the Richie marketing site.
Whenever a course schedule or details are updated on Studio a hook is run that sends the updated information to Richie.
There is also a Django command that permit to synchronize all existing courses.
## Installation
1. [Instructions](docs/installation_devstack.md) to install on a running Open edX [devstack](https://github.com/edx/devstack)
2. [Instructions](docs/installation_production.md) to install on a production grade Open edX using ansible - [configuration](https://github.com/edx/configuration)
## Open edX compatibility
This app has been tested with Open edX Juniper, but it should run on newer versions.
## Making a release
Making a release is automated. The choice between a minor or a revision type of release is
determined by the presence of an addition, a change or a removal. A revision release is made
if only fixes are present in the changelog, otherwise a minor release is made.
For example, to release and commit all changes:
```
bin/release --commit
```
If you consider that the changelog contains breaking changes, you can force a major release
by passing the parameter `--major`.
To release but without committing the changes:
```
bin/release --major
```
To release and committing the changes:
```
bin/release --commit
```
After merging release commits to the master branch, you can tag them automatically by running:
```
bin/tag -c
```
## Contributions / Acknowledgments
- FUN-MOOC [fun-apps courses](https://github.com/openfun/fun-apps)
- [Richie](https://richie.education/) and on [Github](https://github.com/openfun/richie)
## License
This work is released under the AGPL-3.0 License (see [LICENSE](./LICENSE)).
Raw data
{
"_id": null,
"home_page": "https://github.com/fccn/richie-openedx-sync",
"name": "richie-openedx-sync",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "Django, Open edX, MOOC, Richie",
"author": "FCT|FCCN NAU",
"author_email": "info@nau.edu.pt",
"download_url": "https://files.pythonhosted.org/packages/6a/de/aee82dbdd75491487961a4005b36b30e81c65c98380348b8273b0e3af538/richie_openedx_sync-1.4.0.tar.gz",
"platform": "any",
"description": "# Richie Open edX Synchronization application\n\n## Overview\n\nThe aim of this Django application is to synchronize the Open edX courses to the Richie marketing site.\nWhenever a course schedule or details are updated on Studio a hook is run that sends the updated information to Richie.\nThere is also a Django command that permit to synchronize all existing courses.\n\n## Installation\n\n1. [Instructions](docs/installation_devstack.md) to install on a running Open edX [devstack](https://github.com/edx/devstack)\n2. [Instructions](docs/installation_production.md) to install on a production grade Open edX using ansible - [configuration](https://github.com/edx/configuration)\n\n## Open edX compatibility\n\nThis app has been tested with Open edX Juniper, but it should run on newer versions.\n\n## Making a release\n\nMaking a release is automated. The choice between a minor or a revision type of release is\ndetermined by the presence of an addition, a change or a removal. A revision release is made\nif only fixes are present in the changelog, otherwise a minor release is made.\n\nFor example, to release and commit all changes:\n\n```\nbin/release --commit\n```\n\nIf you consider that the changelog contains breaking changes, you can force a major release\nby passing the parameter `--major`.\n\n\nTo release but without committing the changes:\n\n```\nbin/release --major\n```\n\nTo release and committing the changes:\n\n```\nbin/release --commit\n```\n\nAfter merging release commits to the master branch, you can tag them automatically by running:\n\n```\nbin/tag -c\n```\n\n## Contributions / Acknowledgments\n\n- FUN-MOOC [fun-apps courses](https://github.com/openfun/fun-apps)\n- [Richie](https://richie.education/) and on [Github](https://github.com/openfun/richie)\n\n## License\n\nThis work is released under the AGPL-3.0 License (see [LICENSE](./LICENSE)).\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Richie Open edX Synchronization application",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/fccn/richie-openedx-sync"
},
"split_keywords": [
"django",
" open edx",
" mooc",
" richie"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "490bba76fe46105928fa5fd66f2c2781876ef9fa6b7f966030ea18658b115ef6",
"md5": "d1c1f2a05126c1f35ddb52890d47442e",
"sha256": "9d5bc54f434de1f7dcd86317028dfbd0212207c99c5d724aa0c71aadd72ffdc7"
},
"downloads": -1,
"filename": "richie_openedx_sync-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1c1f2a05126c1f35ddb52890d47442e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 19974,
"upload_time": "2024-05-29T10:47:42",
"upload_time_iso_8601": "2024-05-29T10:47:42.905945Z",
"url": "https://files.pythonhosted.org/packages/49/0b/ba76fe46105928fa5fd66f2c2781876ef9fa6b7f966030ea18658b115ef6/richie_openedx_sync-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6adeaee82dbdd75491487961a4005b36b30e81c65c98380348b8273b0e3af538",
"md5": "d3ff0e203fd2e05f40c27e81f6b079df",
"sha256": "dae2e01fcb4b7cdcd504656907dc39090341e1f0e455f330367c0176cbebf225"
},
"downloads": -1,
"filename": "richie_openedx_sync-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "d3ff0e203fd2e05f40c27e81f6b079df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 19671,
"upload_time": "2024-05-29T10:47:44",
"upload_time_iso_8601": "2024-05-29T10:47:44.449586Z",
"url": "https://files.pythonhosted.org/packages/6a/de/aee82dbdd75491487961a4005b36b30e81c65c98380348b8273b0e3af538/richie_openedx_sync-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-29 10:47:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fccn",
"github_project": "richie-openedx-sync",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "richie-openedx-sync"
}
JSON
