Skip to main content

tvb-ext-bucket

Github Actions Status Extension for collabs bucket interaction

This extension is composed of a Python package named tvb_ext_bucket for the server extension and a NPM package named tvb-ext-bucket for the frontend extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install tvb-ext-bucket

Uninstall

To remove the extension, execute:

pip uninstall tvb-ext-bucket

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the tvb-ext-bucket directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable tvbextbucket
# 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.

# 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:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable tvb_ext_bucket
pip uninstall tvb-ext-bucket

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 tvb-ext-bucket within that folder.

Testing the extension

Server tests

This extension is using Pytest for Python code testing.

Install test dependencies (needed only once):

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

To execute them, run:

pytest -vv -r ap --cov tvb_ext_bucket

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

Acknowledgments

This project has received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

This project has received funding from the European Union’s Horizon Europe Programme under the Specific Grant Agreement No. 101147319 (EBRAINS 2.0 Project).

This project has received funding from the European Union’s Research and Innovation Program Horizon Europe under Grant Agreement No. 101137289 (Virtual Brain Twin Project).

Metadata

Release files for tvb-ext-bucket 2.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tvb-ext-bucket 2.0.2
File Size Uploaded Provenance Actions
tvb_ext_bucket-2.0.2.tar.gz 314.2 kB Without provenance Details for tvb_ext_bucket-2.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tvb-ext-bucket 2.0.2
File Interpreter ABI Platform Actions
tvb_ext_bucket-2.0.2-py3-none-any.whl Python 3 none any Details for tvb_ext_bucket-2.0.2-py3-none-any.whl

Total release size: 420.2 kB

Release files / tvb_ext_bucket-2.0.2.tar.gz

Download URL tvb_ext_bucket-2.0.2.tar.gz
Size 314.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ebeba4bc8aac31919f3bf109c3c268361f0c62fb34ce5d45b6a3b8d6be563f3b
BLAKE2b-256 checksum
How to use checksums
a2538fa56346105c2a6d677a6954a14c7257c4b3323c900564a4d854e0f827b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / tvb_ext_bucket-2.0.2-py3-none-any.whl

Download URL tvb_ext_bucket-2.0.2-py3-none-any.whl
Size 106.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e3a989ba38fab18847095bb257c8111253164c13e8b6d988f2317db9a9a8314d
BLAKE2b-256 checksum
How to use checksums
50419f8a431e24a4b6554a0698be31ec9f98949fe9dd0b9754fc269e4179f9b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Security for tvb-ext-bucket 2.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page