https://github.com/fossunited/coursectl
CLI tool to manage courses on Community LMS
https://github.com/fossunited/coursectl
Last synced: about 2 months ago
JSON representation
CLI tool to manage courses on Community LMS
- Host: GitHub
- URL: https://github.com/fossunited/coursectl
- Owner: fossunited
- License: mit
- Created: 2021-09-16T09:43:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-08T08:14:39.000Z (over 3 years ago)
- Last Synced: 2025-02-08T09:47:35.430Z (4 months ago)
- Language: Python
- Homepage: https://fossunited.github.io/coursectl
- Size: 475 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coursectl
The `coursectl` is a tool to author courses on web apps built using the [Community LMS][1].
[1]: https://github.com/fossunited/community
## How to install
The `coursectl` depends on [frappe-client][]. It is not availble on pypi, so you need install it manually.
```
$ pip install https://github.com/frappe/frappe/client/zipball/master/
```
Once that is done, install using `coursectl` using pip:
```
$ pip install https://github.com/fossunited/coursectl/zipball/master/"
```
[frappe-client]: https://github.com/frappe/frappe-client
### How to use
The Community LMS is built using the frappe framework and the `coursectl` command requires the api-key and api-secret to communite with the server. Please refer to [Frappe Documentation][2] to learn how to create them.
[2]: https://frappeframework.com/docs/user/en/guides/integration/how_to_set_up_token_based_auth
### Configure
The first step is to provide the credentials to the tool.
```
$ coursectl configure
FRAPPE_API_KEY: XXXXX
FRAPPE_API_SECRET: YYYY
FRAPPE_SITE_URL: https://mon.school/
Updated configuration for profile default in /home/anand/.config/frappe/config.
```
This command saves the credentials in `~/.config/frappe/config` file.
It is possible to have multiple profiles and specify the profile when running a command. These are typically used to push the course to a dev server while developing the course and push to production after it is ready. The name of the default profile is `default`.
To configure a new profile, just pass `--profile` argument to configure.
```
$ coursectl configure --profile dev
...
```
### Pulling an existing course from a server
TODO: add documentation for every command
## License
This repository has been released under the [MIT License](https://github.com/fossunited/coursectl/blob/main/LICENSE).