jupyterlab-v3-codio-ext 0.1.32__tar.gz

jupyterlab_v3_codio_ext-0.1.32/.gitignore

@@ -0,0 +1,121 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyterlab_v3_codio_ext/labextension
+# Version file is handled by hatchling
+jupyterlab_v3_codio_ext/_version.py
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/

jupyterlab_v3_codio_ext-0.1.32/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyterlab_v3_codio_ext-0.1.32/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, codio
+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.

jupyterlab_v3_codio_ext-0.1.32/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.5
+Name: jupyterlab_v3_codio_ext
+Version: 0.1.32
+Dynamic: Keywords
+Summary: A JupyterLab v3 extension to interact with codio.
+Project-URL: Homepage, https://github.com/codio/jupyterlab3-codio-ext
+Project-URL: Bug Tracker, https://github.com/codio/jupyterlab3-codio-ext/issues
+Project-URL: Repository, https://github.com/codio/jupyterlab3-codio-ext.git
+Author-email: codio <support@codio.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, codio
+        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.
+License-File: LICENSE
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 3
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+
+# jupyterlab_v3_codio_ext
+
+[![Github Actions Status](https://github.com/codio/jupyterlab3-codio-ext/workflows/Build/badge.svg)](https://github.com/codio/jupyterlab3-codio-ext/actions/workflows/build.yml)
+A JupyterLab extension to interact with codio.
+
+## Requirements
+
+- JupyterLab >= 3.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyterlab-v3-codio-ext
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyterlab-v3-codio-ext
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyterlab_v3_codio_ext directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab_v3_codio_ext
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyterlab3-codio-ext` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)
+
+### Development
+
+https://jupyterlab.readthedocs.io/en/3.6.x/extension/extension_tutorial.html
+
+```
+pip install -ve .
+```
+
+in codio to install labextension mount folder.
+then in folder `~/.pyenv/versions/3.11.2/share/jupyter/labextensions`
+```
+sudo ln -s /usr/share/codio-tools/jupyterlab-v3-codio-ext/jupyterlab_v3_codio_ext/labextension/ jupyterlab-v3-codio-ext
+```
+
+
+### Build
+
+```
+python -m build
+```
+
+### Upload
+
+```
+twine upload dist/* --verbose
+```
+
+or
+```
+twine upload --repository testpypi dist/* --verbose
+```
+
+### Update config
+
+```
+jupyterlab-v3-codio-ext-cli --env "https://codio.com"
+```

jupyterlab_v3_codio_ext-0.1.32/README.md

@@ -0,0 +1,114 @@
+# jupyterlab_v3_codio_ext
+
+[![Github Actions Status](https://github.com/codio/jupyterlab3-codio-ext/workflows/Build/badge.svg)](https://github.com/codio/jupyterlab3-codio-ext/actions/workflows/build.yml)
+A JupyterLab extension to interact with codio.
+
+## Requirements
+
+- JupyterLab >= 3.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyterlab-v3-codio-ext
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyterlab-v3-codio-ext
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyterlab_v3_codio_ext directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab_v3_codio_ext
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyterlab3-codio-ext` within that folder.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)
+
+### Development
+
+https://jupyterlab.readthedocs.io/en/3.6.x/extension/extension_tutorial.html
+
+```
+pip install -ve .
+```
+
+in codio to install labextension mount folder.
+then in folder `~/.pyenv/versions/3.11.2/share/jupyter/labextensions`
+```
+sudo ln -s /usr/share/codio-tools/jupyterlab-v3-codio-ext/jupyterlab_v3_codio_ext/labextension/ jupyterlab-v3-codio-ext
+```
+
+
+### Build
+
+```
+python -m build
+```
+
+### Upload
+
+```
+twine upload dist/* --verbose
+```
+
+or
+```
+twine upload --repository testpypi dist/* --verbose
+```
+
+### Update config
+
+```
+jupyterlab-v3-codio-ext-cli --env "https://codio.com"
+```

jupyterlab_v3_codio_ext-0.1.32/RELEASE.md

@@ -0,0 +1,80 @@
+# Making a new release of jupyterlab_v3_codio_ext
+
+The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Manual release
+
+### Python package
+
+This extension can be distributed as Python
+packages. All of the Python
+packaging instructions in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, we first need to install `build`.
+
+```bash
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
+```
+
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
+
+```bash
+python -m build
+```
+
+> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
+
+Then to upload the package to PyPI, do:
+
+```bash
+twine upload dist/*
+```
+
+### NPM package
+
+To publish the frontend part of the extension as a NPM package, do:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser.
+
+Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
+
+Here is a summary of the steps to cut a new release:
+
+- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
+- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
+- Go to the Actions panel
+- Run the "Draft Changelog" workflow
+- Merge the Changelog PR
+- Run the "Draft Release" workflow
+- Run the "Publish Release" workflow
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

jupyterlab_v3_codio_ext-0.1.32/install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "jupyterlab_v3_codio_ext",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab_v3_codio_ext"
+}

jupyterlab_v3_codio_ext-0.1.32/jupyterlab_v3_codio_ext/__init__.py

@@ -0,0 +1,4 @@
+from ._version import __version__  # noqa
+
+def _jupyter_labextension_paths():
+    return [{"src": "labextension", "dest": "jupyterlab-v3-codio-ext"}]

jupyterlab_v3_codio_ext-0.1.32/jupyterlab_v3_codio_ext/_version.py

@@ -0,0 +1,4 @@
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '0.1.32'

jupyterlab_v3_codio_ext-0.1.32/jupyterlab_v3_codio_ext/cli.py

@@ -0,0 +1,125 @@
+import argparse
+import json
+import os
+import subprocess
+import sys
+
+
+extension_name = __package__.replace("_", "-")
+user_settings_dir = "lab/user-settings"
+
+DEFAULT_ENV = os.getenv("CODIO_ENV", "https://codio.com")
+CODIO_CLIENT_PATH = "/ext/iframe/base/static/codio-client.js"
+DEFAULT_CODIO_CLIENT_URL = DEFAULT_ENV + CODIO_CLIENT_PATH
+
+DEFAULT_JUPYTER_CONFIG_PATH = os.path.join(os.path.expanduser("~"), ".jupyter")
+
+
+def get_jupyter_lab_version(version_output):
+	for line in version_output.splitlines():
+		if line.startswith("jupyterlab"):
+			return line.split(":")[1].strip()
+	return None
+
+def get_user_settings_dir(config_dir, version):
+	settings_dir = None
+	major_version = int(version.split(".")[0]) if version else 0
+	if major_version >= 4:
+		settings_dir = os.environ.get("JUPYTERLAB_SETTINGS_DIR")
+	if not settings_dir:
+		settings_dir = os.path.join(config_dir, user_settings_dir)
+	return os.path.abspath(settings_dir)
+
+def get_config_dir_from_json(json_data):
+	config = json_data.get("config", [])
+	for path in config:
+		ext_schemas_dir = os.path.join(path, "lab")
+		if os.path.exists(ext_schemas_dir):
+			return path
+	return DEFAULT_JUPYTER_CONFIG_PATH
+
+
+def copy_config_value(client_url, dst_dir):
+	config = {"codioClientUrl": client_url}
+
+	plugin_settings_file = os.path.join(dst_dir, "plugin.jupyterlab-settings")
+	try:
+		os.makedirs(dst_dir, exist_ok=True)
+		with open(plugin_settings_file, "w") as dst:
+			dst.write(json.dumps(config))
+		print(f"Copy config \nto {plugin_settings_file}")
+		return 0
+	except Exception as error:
+		print(f"Error copying config: {error}")
+		return 1
+
+
+def main():
+	parser = argparse.ArgumentParser(description="Configure my JupyterLab extension")
+
+	subparsers = parser.add_subparsers(
+		dest="command",
+		help="Command to execute"
+	)
+	env_parser = subparsers.add_parser(
+		"env",
+		help="Set the CODIO environment URL \"https://codio.com\""
+	)
+	env_parser.add_argument(
+		"env",
+		nargs="?",
+		help="Environment URL default is \"https://codio.com\"",
+		default=DEFAULT_ENV,
+    )
+
+	args = parser.parse_args()
+
+	if args.command != "env":
+		parser.print_help()
+		return 1
+
+	if args.command == "env":
+		if not args.env:
+			print("Usage: test.py env <env>")
+			print("default <env> if '{}'".format(DEFAULT_ENV))
+			env = DEFAULT_ENV
+		else:
+			print(f"Using CODIO environment: {args.env}")
+			print(f"Using CODIO client URL: {args.env}{CODIO_CLIENT_PATH}")
+			env = args.env
+
+	client_url = f"{args.env}{CODIO_CLIENT_PATH}" if args.env else DEFAULT_CODIO_CLIENT_URL
+
+	try:
+		result = subprocess.run(["jupyter", "--version"], check=True, stdout=subprocess.PIPE)
+		version_output = result.stdout.decode("utf-8").strip()
+	except subprocess.CalledProcessError:
+		print("Jupyter is not installed")
+		return 1
+
+	result = subprocess.run(["jupyter", "--json", "--paths"], stdout=subprocess.PIPE)
+	decoded = result.stdout.decode("utf-8")
+	try:
+		paths = json.loads(decoded)
+	except json.JSONDecodeError as error:
+		print(f"Error decoding Jupyter paths: {error}")
+		return 1
+
+	config_dir = get_config_dir_from_json(paths)
+	if config_dir:
+		print(f"Found config directory: {config_dir}")
+		version = get_jupyter_lab_version(version_output)
+		if not version:
+			print("Jupyter Lab is not installed")
+			return 1
+		user_settings_dir = get_user_settings_dir(config_dir, version)
+		dst_dir = os.path.join(user_settings_dir, extension_name)
+		print(f"Destination directory: {dst_dir}")
+		return copy_config_value(client_url, dst_dir)
+	else:
+		print("No config directory found")
+		return 1
+
+
+if __name__ == "__main__":
+	raise sys.exit(main())