Beautiful web-style components for Jupyter notebooks
Project description
nb-ui: Beautiful Components for Jupyter Notebooks
Modern UI components for Jupyter notebooks with auto-rendering support. No HTML/CSS required.
🚀 Quick Start
from nb_ui import Header, Card, CodeBlock, Typography, Container
from nb_ui import success, warning, error, info, set_theme
# Set theme and create components
set_theme("material")
Header("My Analysis", subtitle="Data Science Report")
Card("Key findings here", title="Results")
success("Model training completed!")
📦 Components
- Header - Section titles and subtitles
- Card - Content containers with titles
- Alert/success/warning/error/info - Status messages
- CodeBlock - Syntax-highlighted code
- Typography - Professional text styling
- Container - Centered layout wrapper
🎨 Themes
Available themes: material, antd, dark
set_theme("material") # or "antd", "dark"
Note: Themes are inspired by Material Design and Ant Design principles and are subject to change in future versions.
🧪 Running Tests
# Install development dependencies
pip install -r requirements-dev.txt
# Run all tests
python -m pytest tests/ -v
# Run specific test file
python -m pytest tests/test_cards.py -v
# Run tests with coverage
python -m pytest tests/ --cov=src --cov-report=term-missing
📝 Development
# Install in development mode
pip install -e .
# Run example notebook
jupyter notebook demo_usage.ipynb
📄 License
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nb_ui-1.0.0.tar.gz
(22.9 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
nb_ui-1.0.0-py3-none-any.whl
(18.7 kB
view details)
File details
Details for the file nb_ui-1.0.0.tar.gz.
File metadata
- Download URL: nb_ui-1.0.0.tar.gz
- Upload date:
- Size: 22.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b9724c2204b24aeee46fbc93002efee9acbacb32a076ee01acf0537f5a1b6789
|
|
| MD5 |
dbc16e9daf9cb32e4c45fd8291df0854
|
|
| BLAKE2b-256 |
ef02c28da19563148d4f2743728011a3628e5d2118cffa2fe7d5317353544fbf
|
File details
Details for the file nb_ui-1.0.0-py3-none-any.whl.
File metadata
- Download URL: nb_ui-1.0.0-py3-none-any.whl
- Upload date:
- Size: 18.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f99c96d6af84013109c03e4645aed4c9143a90357301d752432ed6c34bab525
|
|
| MD5 |
629284010ae6af0be04d5675c094d57b
|
|
| BLAKE2b-256 |
c307e1037917ad12f5fae7cae424d216f458f17fcd72cbe648138502c19b8138
|