Skip to main content

Peer-to-peer file sharing for JupyterLab - create named shares (drops) or requests (inboxes), get a link, share it. Files served directly from your server; recipients can use a JupyterLab panel or a plain browser.

Project description

jupyterlab_share_files_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

If you live in JupyterLab and have ever had to "just send over that dataset" or "could you please upload your CSV somewhere I can grab it" - you know the routine. Email it (too big). Drop it in OneDrive (sync it first, share it, accept the corporate Terms of the Universe). Spin up an S3 bucket (and a meeting). By the time anyone has the file, you've forgotten what you needed it for.

This extension does not try to replace any of that. OneDrive, Dropbox, S3, that one Slack channel called #files-final-FINAL - they remain undefeated for serious file logistics. This is the small, embarrassingly specific tool for the other 90% of the time, when two people on JupyterLab just need to pass a folder back and forth and would prefer not to involve an enterprise.

Create a share (file drop) or request (inbox) from a side panel, copy the link, paste it in chat. Recipients open it in their JupyterLab panel or any plain browser. That is the whole pitch.

Features

  • Shares - read-only drops of files and folders; recipients download
  • Requests - inboxes; recipients upload, organised per uploader
  • Connections - paste someone's link to subscribe to their share or upload to their request
  • Drag-and-drop from the file browser - drop zone (new share), share row (add files), request row (upload)
  • Browse inside a share - double-click a folder to drill in; the .. row takes you back up
  • Open files directly - double-click a file in the panel and JupyterLab opens it with the right viewer
  • Right-click context menu - in the file browser ("Share Files..."), and on panel rows ("Copy to Current Folder", "Show in File Browser")
  • Hidden files visible by default - dotfiles like .env, .gitignore, .ssh/config are easy to share; toggle in Settings if you want them hidden
  • Standalone HTML page - link works in any browser, no JupyterLab needed
  • Live upload notifications when someone uploads to your request
  • Self-connect guard - pasting your own link shows a clear "you already own this" dialog instead of a silent toast
  • Symlink-friendly - sharing @shared/... and similar works
  • Delete to trash - panel deletes move files to the OS trash by default (toggle with c.ShareFilesConfig.use_trash)
  • HTTPS-aware links - share URLs follow the scheme the browser is on (HTTPS behind a proxy, HTTP for direct peer-to-peer)
  • Settings toggles - turn shares, requests, or hidden-file visibility on/off independently

Requirements

  • JupyterLab >= 4.0.0
  • Python >= 3.9

Install

Developers install via the project Makefile:

make install

End-users install the published package from PyPI:

pip install jupyterlab_share_files_extension

Configuration

Optional, set in jupyter_server_config.py:

c.ShareFilesConfig.shares_dir = "/path/to/storage"  # default: ./uploads
c.ShareFilesConfig.use_trash = True                 # default: True

Security

The link is the credential (40 bits of entropy). HTTPS is inherited from your JupyterHub/Jupyter proxy. Suitable for trusted-channel sharing (Slack, email). No expiry, no PIN.

Uninstall

pip uninstall jupyterlab_share_files_extension

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

jupyterlab_share_files_extension-1.0.22.tar.gz (244.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlab_share_files_extension-1.0.22.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_share_files_extension-1.0.22.tar.gz
Algorithm Hash digest
SHA256 e0e291acabd5939615a6f946ae9251e677c11c422a9b98cdf18baba4fe3ca7c3
MD5 cb2c8097d74029377664f3a0eab6f59a
BLAKE2b-256 19cf23e778c98b12ee72854decf19902f5523712e124a5bac2756c676e7504c1

See more details on using hashes here.

File details

Details for the file jupyterlab_share_files_extension-1.0.22-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_share_files_extension-1.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 d0727d004470d9fe50923213a50737743e2b606379acfd9400fefef68ac08cfc
MD5 18f839fab26106310c43075a20a7ce46
BLAKE2b-256 b20b03507d1d882cb8b7fb32ea0646addaeac2322e6f1ff14846424cb4bbf47c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page