## Requirements
* JupyterLab >= 3.0
## Installation
1. Open Jupyter Lab
2. Open Terminal
3. Execute this command
```bash
pip install --upgrade carpo_teacher
```
4. Close and restart Jupyter Lab
## Configure to use with carpo server
Teachers/TAs need to edit the **config.json** file in the **Exercises** folder and update the following information:
* Student name
* IP address of the server. The instructor should provide this information.
## Additional installation information
To install specific version (e.g. 0.0.8), execute this command in Jupyter Lab's terminal:
```bash
pip install carpo_teacher==0.0.8
```
To uninstall the exension, execute this command in Jupyter Lab's terminal:
```bash
pip uninstall carpo_teacher
```
## Install the extension with Virtual environment [Optional]
It is recommended that you install the carpo-teacher extension in a separate python virtual environment. This way, you can isolate the carpo modules from your global jupyterlab server.
1. Install python virtual environment
```bash
pip install virtualenv
```
2. Create directory to store your virtual environments for projects
```bash
mkdir ~/my-venvs
cd ~/my-venvs
```
3. Create virtual environment for teacher extension
```bash
virtualenv carpo-teacher-mode
```
This will create new python virtual environment named `carpo-teacher-mode`
4. Activate the above created virtual environment
```bash
source carpo-teacher-mode/bin/activate
```
5. Install jupyterlab and carpo extension in your environment
```bash
pip install --upgrade carpo-teacher
```
6. Now launch jupterlab
```bash
jupyter lab
```
You will now see all the carpo functionalities when you open Notebook in your jupyter lab server in the browser.
Raw data
{
"_id": null,
"home_page": "https://github.com/github_username/carpo-teacher",
"name": "carpo-teacher",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/fb/24/3d493c16a7c586c35acdd55e7d2bff41d5e7f07bc8ce2687ed5d686515dc/carpo_teacher-0.0.10.tar.gz",
"platform": "Linux",
"description": "## Requirements\n\n* JupyterLab >= 3.0\n\n## Installation\n\n1. Open Jupyter Lab\n2. Open Terminal\n3. Execute this command\n```bash\npip install --upgrade carpo_teacher\n```\n4. Close and restart Jupyter Lab\n\n\n## Configure to use with carpo server\n\nTeachers/TAs need to edit the **config.json** file in the **Exercises** folder and update the following information:\n\n* Student name\n* IP address of the server. The instructor should provide this information.\n\n\n\n## Additional installation information\n\nTo install specific version (e.g. 0.0.8), execute this command in Jupyter Lab's terminal:\n\n```bash\npip install carpo_teacher==0.0.8\n```\n\nTo uninstall the exension, execute this command in Jupyter Lab's terminal:\n\n```bash\npip uninstall carpo_teacher\n```\n\n\n## Install the extension with Virtual environment [Optional]\nIt is recommended that you install the carpo-teacher extension in a separate python virtual environment. This way, you can isolate the carpo modules from your global jupyterlab server.\n\n1. Install python virtual environment\n```bash\npip install virtualenv\n```\n2. Create directory to store your virtual environments for projects\n```bash\nmkdir ~/my-venvs\ncd ~/my-venvs\n```\n3. Create virtual environment for teacher extension\n```bash\nvirtualenv carpo-teacher-mode\n```\nThis will create new python virtual environment named `carpo-teacher-mode`\n\n4. Activate the above created virtual environment\n```bash\nsource carpo-teacher-mode/bin/activate\n```\n\n5. Install jupyterlab and carpo extension in your environment\n```bash\npip install --upgrade carpo-teacher\n```\n\n6. Now launch jupterlab\n```bash\njupyter lab\n```\nYou will now see all the carpo functionalities when you open Notebook in your jupyter lab server in the browser.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "JupyterLab extension with backend and frontend part for carpo teacher.",
"version": "0.0.10",
"project_urls": {
"Homepage": "https://github.com/github_username/carpo-teacher"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a5e55b0edc6ebe9ff60e2da03de06ee4c1aeac368e519e2d0940d51563334a5",
"md5": "c073cb2ec482fe06364f9ed0403347e4",
"sha256": "824d93973064c74874dcea50e689c3670752238213cc373a08df614341377464"
},
"downloads": -1,
"filename": "carpo_teacher-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c073cb2ec482fe06364f9ed0403347e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 269377,
"upload_time": "2024-01-10T21:10:46",
"upload_time_iso_8601": "2024-01-10T21:10:46.490532Z",
"url": "https://files.pythonhosted.org/packages/7a/5e/55b0edc6ebe9ff60e2da03de06ee4c1aeac368e519e2d0940d51563334a5/carpo_teacher-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb243d493c16a7c586c35acdd55e7d2bff41d5e7f07bc8ce2687ed5d686515dc",
"md5": "48a7466c8ec480c3460ab719896e4300",
"sha256": "6790ab82cc24ca0afe8e272c4866270a348cd7ba7890097e2158834a2bf40c6a"
},
"downloads": -1,
"filename": "carpo_teacher-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "48a7466c8ec480c3460ab719896e4300",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 49984,
"upload_time": "2024-01-10T21:10:48",
"upload_time_iso_8601": "2024-01-10T21:10:48.216678Z",
"url": "https://files.pythonhosted.org/packages/fb/24/3d493c16a7c586c35acdd55e7d2bff41d5e7f07bc8ce2687ed5d686515dc/carpo_teacher-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 21:10:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "github_username",
"github_project": "carpo-teacher",
"github_not_found": true,
"lcname": "carpo-teacher"
}
JSON
