Metadata-Version: 2.4
Name: nb-ui
Version: 1.0.0
Summary: Beautiful web-style components for Jupyter notebooks
Author-email: jeremy vendarwan <noreply@github.com>
License: MIT
Project-URL: Homepage, https://github.com/jvendarwan/nb-ui
Project-URL: Documentation, https://github.com/jvendarwan/nb-ui#readme
Project-URL: Repository, https://github.com/jvendarwan/nb-ui.git
Project-URL: Bug Tracker, https://github.com/jvendarwan/nb-ui/issues
Keywords: jupyter,notebook,ui,components
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ipython>=7.0.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# nb-ui: Beautiful Components for Jupyter Notebooks

Modern UI components for Jupyter notebooks with auto-rendering support. No HTML/CSS required.

## 🚀 Quick Start

```python
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`

```python
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

```bash
# 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

```bash
# Install in development mode
pip install -e .

# Run example notebook
jupyter notebook demo_usage.ipynb
```

## 📄 License

MIT License
