Package: jupyterlab-bxplorer
A JupyterLab extension that provides a UI to operate objects in a cloud storage service.ContentsWhy?InstallationUsageCurrent StatusWant to contribute?Found an issue? Have suggestions?LicensingNotesWhy?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.InstallationYou cna usepipto install this extension:pipinstalljupyterlab-bxplorerorgitclonehttps://github.com/Navteca/jupyterlab-bxplorer.gitcdjupyterlab-bxplorer/
npminstall
python-mbuild
pipinstalljupyterlab_bxplorer-<version>-py3-none-any.whlif the installation process runs successfully, check if the extension has been activated:jupyter labextension list
jupyter serverextension listIf not, you might need to run:jupyter labextension enable --py jupyterlab_bxplorer
jupyter serverextension enable --py jupyterlab_bxplorerUsageOnce 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 describedhere. 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 VariablesCLI Credentials fileandConfigurations fileIf 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 theFavoritestab there is a buttonAdd bucketthat allows you to add a cross-account bucket. These are buckets that per default will not appear in thePrivatetab because they belong to another account.Current StatusWe 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 objectsAWSGoogleAzureList public storage objectsAWSGoogleAzureAdd external/cross-account storage objects to Favorites listAWSGoogleAzureAdd folders-like objects inside storage objects to the Favorites listRemove storage objects from Favorites listDownload storage objectsAWSGoogleAzureShow cross-account storage objectsAWSGoogleAzureShow storage object's information (metadata)AWSGoogleAzureShow downloads panelAutomatic update of downloads panelResponsiveness improvements of both Browser and Downloads panelCopy storage object pathAWSGoogleAzureUpload object to a storage objectAWSGoogleAzureTestsDocumentationWant 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 theChonky File Browseras its main component. You can find the modified versionhere.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 anissue, we would like to hear from you.LicensingBSD 3-Clause LicenseNotes for your considerationThis 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.