Skip to main content

A Jupyter Server extension that adds a favicon to your Jupyter Server instance, making it easier to identify in browser tabs

Project description

Jupyter Server Favicon Extension

PyPI version Python Versions License Code style: black

Sponsored by Enverge.ai - Simpler, greener, cheaper AI training platform. Enverge harnesses excess green energy for powerful, cost-effective computing on GPUs, enabling environmentally friendly AI model development, training, and fine-tuning. Currently in private alpha with limited spots available.

A Jupyter Server extension that adds favicon support to your Jupyter Server instance, making it easier to identify your Jupyter tabs in the browser.

demo

Features

  • Automatically serves a favicon for your Jupyter Server instance
  • Easy to install and configure
  • Compatible with all modern browsers
  • No additional configuration required

Installation

You can install the extension using pip:

pip install jupyter-server-favicon

Or if you want to install from source:

# Clone the repository
git clone https://github.com/Enverge-Labs/jupyter-server-favicon.git
cd jupyter-server-favicon

# Create a conda environment (optional but recommended)
conda create -y -n jupyter-server-favicon python=3.9
conda activate jupyter-server-favicon

# Install in development mode
pip install -e .

Usage

The extension is automatically enabled after installation. Simply start Jupyter Server:

jupyter server

The favicon will be automatically served at /static/jupyter_server_favicon/favicon.ico.

Development

To set up the development environment:

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black .
isort .

# Type checking
mypy .

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please file an issue on the GitHub repository.

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

jupyter_server_favicon-0.0.1.tar.gz (61.5 kB view details)

Uploaded Source

Built Distribution

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

jupyter_server_favicon-0.0.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_server_favicon-0.0.1.tar.gz.

File metadata

  • Download URL: jupyter_server_favicon-0.0.1.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.13

File hashes

Hashes for jupyter_server_favicon-0.0.1.tar.gz
Algorithm Hash digest
SHA256 80a99300feefebd7524bcf9522513f0bffa017af35071da67e7eb5b4c75f4434
MD5 653b1dea534a8c696df4ff7f1c530309
BLAKE2b-256 50ed9888bf087415a6e4ecc89a9ac1c8483b022d780100f60d9b5bf0364e8289

See more details on using hashes here.

File details

Details for the file jupyter_server_favicon-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_server_favicon-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3137faccd29f3ae7eea4314b9de2bff01ac7f8fcc81dd8214e3aa1d55ca1fb10
MD5 bd75785712c5eb457d72189ca417daed
BLAKE2b-256 9f94bc4c3ea05399e5d593a1d54f0ffde618a0398aba2eddfa76c2c578bc04d3

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