jupyterlab-bxplorer 0.1.19

This is a JupyterLab extension that allows users to explore and interact with cloud storage services.

A JupyterLab extension that provides a UI to operate objects in a cloud storage service.

Contents

• Why?
• Installation
• Usage
• Current Status
• Want to contribute?
• Found an issue? Have suggestions?
• Licensing
• Notes

Why?

We decided to work on BXplorer after reviewing other JupyterLab extensions to operate objects in cloud storage services (Google, Azure, AWS). The extensions we have reviewed work really well. After making an inventory of the changes we might need to do to some of them we realized that we would basically need to modify them so much that we might end up with an entirely new extension and/or modifying JupyterLab's FileBrowser component and end up with a customized version so we decided to start from scratch and offer this new extension to the community hoping it is useful.

We wanted to use a different approach handling AWS credentials. We also wanted to show more information such as object size, modification date, cross account buckets (AWS), etc.

Installation

We are working on having a package in PyPi available. At the moment you can do the following:

git clone https://github.com/Navteca/jupyterlab-bxplorer.git
cd jupyterlab-bxplorer/
npm install
python -m build
pip install jupyterlab_bxplorer-<version>-py3-none-any.whl

if the installation process runs successfully, check if the extension has been activated:

jupyter labextension list
jupyter serverextension list

If not, you might need to run:

jupyter labextension enable --py jupyterlab_bxplorer
jupyter serverextension enable --py jupyterlab_bxplorer

Usage

Once the extension is installed, you will notice a new small telescope icon on the left panel. Clicking on it will expand the panel and you will notice 3 tabs: Private, Public and Favorites.

• Private: will list all the buckets your AWS Credentials, Role/Service Account give you access to.
• Public: shows also a dropdown menu with a few options (AWS, Google, Microsoft) when selecting any of those options you will notice the list of storage objects shown changes. The extension pulls the information from those public repositories.
• Favorites: is used to keep those cloud storage objects you want to have access to quickly. Additionally you can add external objects.

The extension will take the AWS credentials as described here. In one of our instances we use an AWS Role with a Service Account which makes it easier to manage permissions and so on.

There are a few ways to configure the AWS Credentials in a GNU/Linux or GNU/Linux-like environments:

• Environment Variables
• CLI Credentials file and Configurations file
• If you are launching your JupyterLab instance as a pod in K8S you can also use an AWS Role connected to a Service Account as an environment variable, the extension will also use it.

In the Favorites tab there is a button Add bucket that allows you to add a cross-account bucket. These are buckets that per default will not appear in the Private tab because they belong to another account.

Current Status

We are in a very early stage in terms of all the features we want to add to the extension to be even with other extensions. Currently you can do the following:

• List private storage objects
  • AWS
  • Google
  • Azure
• List public storage objects
  • AWS
  • Google
  • Azure
• Add external/cross-account storage objects to Favorites list
  • AWS
  • Google
  • Azure
• Removing storage objects from Favorites list
• Downloading storage objects
  • AWS
  • Google
  • Azure
• Show cross-account storage objects
  • AWS
  • Google
  • Azure
• Show storage object's information (metadata)
  • AWS
  • Google
  • Azure
• Show downloads panel
• Automatic update of downloads panel
• Responsiveness improvements of both Browser and Downloads panel
• Copy storage object path
  • AWS
  • Google
  • Azure
• Upload object to a storage object
  • AWS
  • Google
  • Azure
• Tests
• Documentation

Want to contribute?

First of all, thank you for taking the time to contribute!

Do you find this extension useful, with potential to be great and you like writing code? Please, don't hesitate to contribute. There is so much to do from improving an already existing feature, implement a new one to fixing bugs, etc.

There are a couple ways you can contribute to the extension:

• Opening issues: you can open an issue either to report a bug, request an enhancement, ask a question, suggest a new feature, etc.
• Pull Requests: This would be awesome. We suggest you to open an issue or comment an issue before creating the Pull Request.

The extension uses a modified version of the Chonky File Browser as its main component. You can find the modified version here.

We are working on a contributor document and guidelines with additional information you might to work on the extension.

Found an issue? Have suggestions?

Please open an issue, we would like yo hear from you.

Licensing

BSD 3-Clause License

Notes for your consideration

• This project is in early stage. We are continuously working on it to make it better.
• Chonky is the main component of the extension and we are going to continue modifying it to get it to fit better in this project.
• This is the first extension we put out there. We are aware we have so much to learn from the FLOSS communities and that is one of the reasons we why decided to publish it.