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.2.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.2-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_server_favicon-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 acfa69ea4e7b5ad494306a312f45bf4bc73c053be3285270a6e149ab618c8c26
MD5 b7e17aaa00b834918e81969a5f7aada2
BLAKE2b-256 4ef9ba71b5ce993603f948fb2bda084cae273995afa736b6a28ca1f2626bf7de

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_server_favicon-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e9e5e135a0b8ab55865354cb738853eb77f00be33538ae180c1161e7d61a65db
MD5 ba03b6a7cc0c8d80ec34ef52bc944dbe
BLAKE2b-256 24ad513b0174e31f764805eefa013b7a2679b1d739f52cd788e03b6cbe868bda

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