COS Contents Manage for storing Jupyterlab Notebooks in IBM Cloud Object Storage
Project description
IBM Cloud Object Storage Jupyter Contents
This package contains a juypterlab contents contents manager to allow storing jupyter notebooks on IBM Cloud Object Storage. It also supports local filesystem access so you can store notebooks locally.
Currently only python 3.7 is supported.
Usage
To use the content manager, first you must install it:
pip install .
Prefer installation via pip. The old way
python setup.up install
fetches dev versions of packages and may break the build. Pip always fetches stable versions.
Next adjust your jupyter config usually /etc/jupyter/jupyter_notebook_config.py
or you can create a
jupyter_notebook_config.py
file in your current working directory.
Add the following line:
c.ServerApp.contents_manager_class = "coscontents.COSContentsManager"
Local testing
The easiest way to test this locally is to work in a virtual environment. You can use your preferred virtual environment management tool (e.g. Conda), or to set up a fresh venv, run:
$ cd path/to/COSContents
$ python3 -m venv venv
$ . ./venv/bin/activate
Install all the dependencies, and set yourself up for development:
$ pip install --editable .
[...]
$ pip install jupyterlab
[...]
Jupyter itself is not included in the install_requires
because while it is
useful for development and testing, this code does not actually depend upon it.
Now you have all the prerequisites installed, and the coscontents
package
points to the files in your working directory.
If you have not already an IBM Cloud Account and a COS bucket you will need it
>>> # This is a dummy value; replace it with your own token or user/pass.
The only remaining step is to launch Jupyter and configure it to use the
COSContentsManager
class:
$ jupyter lab --ServerApp.contents_manager_class=coscontents.COSContentsManager
This will run a local test Jupyter lab server without changing your default Jupyter configuration. You can make this your default by following the instructions in "Usage" above.
Now the server is running, and you just need to follow Jupyter's directions to connect! Certain actions (like file navigation) may take longer than you would expect, because it has to communicate with the remote IBM Cloud server.
How it Works
TODO explain
Listing
The listings show up under the "COS" folder of the notebook file browser.
Acknowledgements
This code is based on:
- [https://github.com/danielfrg/s3contents]
- [https://github.com/TileDB-Inc/TileDB-Cloud-Jupyter-Contents]
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for coscontents-2023.1001-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc475ca779ae2abd24d6bb6a58e90d2d94ad86d399214850c76bd45f8c8963e4 |
|
MD5 | 5e5dc5645a629467658102e65839c3cd |
|
BLAKE2b-256 | f70c83b064619a6d68e94fb67af8e548b414ffc10ac3f016cbe43ff70cbf786c |