carpo-teacher


Namecarpo-teacher JSON
Version 0.2.2 PyPI version JSON
download
home_pagehttps://github.com/github_username/carpo-teacher
SummaryJupyterLab extension with backend and frontend part for carpo teacher.
upload_time2025-08-31 02:57:44
maintainerNone
docs_urlNone
authortest
requires_python>=3.7
licenseBSD 3-Clause License Copyright (c) 2022, All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords jupyter jupyterlab jupyterlab4
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## 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": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "Jupyter, JupyterLab, JupyterLab4",
    "author": "test",
    "author_email": "test@test.com",
    "download_url": "https://files.pythonhosted.org/packages/68/26/507dd453bec1e87b7a73e0dd5f62cf57c219ede3dc12c7c31c49b642bdb9/carpo_teacher-0.2.2.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 License\n        \n        Copyright (c) 2022, \n        All rights reserved.\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        1. Redistributions of source code must retain the above copyright notice, this\n           list of conditions and the following disclaimer.\n        \n        2. Redistributions in binary form must reproduce the above copyright notice,\n           this list of conditions and the following disclaimer in the documentation\n           and/or other materials provided with the distribution.\n        \n        3. Neither the name of the copyright holder nor the names of its\n           contributors may be used to endorse or promote products derived from\n           this software without specific prior written permission.\n        \n        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n        ",
    "summary": "JupyterLab extension with backend and frontend part for carpo teacher.",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/github_username/carpo-teacher"
    },
    "split_keywords": [
        "jupyter",
        " jupyterlab",
        " jupyterlab4"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7578ece24daf7980512c189ff1b156c7e7c40fcf67acd4b0e6ab41d194fe34b2",
                "md5": "b77bda4721dd74970ce57b4e0aed5a9e",
                "sha256": "405ac8804a6d1f72f0948917e9176211cefa83a76c9cd15939a203e4b77c27cf"
            },
            "downloads": -1,
            "filename": "carpo_teacher-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b77bda4721dd74970ce57b4e0aed5a9e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 338089,
            "upload_time": "2025-08-31T02:57:42",
            "upload_time_iso_8601": "2025-08-31T02:57:42.694831Z",
            "url": "https://files.pythonhosted.org/packages/75/78/ece24daf7980512c189ff1b156c7e7c40fcf67acd4b0e6ab41d194fe34b2/carpo_teacher-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6826507dd453bec1e87b7a73e0dd5f62cf57c219ede3dc12c7c31c49b642bdb9",
                "md5": "be78ab6e6ac23bcc987f06cfede0417d",
                "sha256": "751f004b06d713efe901dd6ea8afeb615e2d3f504fb26f989826de26cf038204"
            },
            "downloads": -1,
            "filename": "carpo_teacher-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "be78ab6e6ac23bcc987f06cfede0417d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 131057,
            "upload_time": "2025-08-31T02:57:44",
            "upload_time_iso_8601": "2025-08-31T02:57:44.077986Z",
            "url": "https://files.pythonhosted.org/packages/68/26/507dd453bec1e87b7a73e0dd5f62cf57c219ede3dc12c7c31c49b642bdb9/carpo_teacher-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-31 02:57:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "github_username",
    "github_project": "carpo-teacher",
    "github_not_found": true,
    "lcname": "carpo-teacher"
}
        
Elapsed time: 0.82349s