Metadata-Version: 2.4
Name: jupyterhub-fancy-profiles
Version: 0.7.0
Summary: Fancy Profile UI for jupyterhub-kubespawner
Author-email: Yuvi <yuvipanda@gmail.com>
Keywords: jupyterhub
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# `jupyterhub-fancy-profiles`

A react based, fancy implementation of user selectable profiles
for use with [jupyterhub-kubespawner](https://github.com/jupyterhub/kubespawner).

![Screenshot showing an image selector](docs/images/ui.png)

## Documentation

📖 **[Read the full documentation](https://2i2c.org/jupyterhub-fancy-profiles/)**

Here are some quick links:

- **[Installation Guide](./docs/install.md)** - Get started with z2jh or KubeSpawner
- **[User Guide](./docs/guide.md)** - Configure profiles and features
- **[Developer Guide](./docs/contribute/develop.md)** - Architecture and contributing

## Features

1. **Enhanced Profile Selection** - Better looking UI for KubeSpawner's `profileList` with rich descriptions
2. **Dynamic Image Building** - Optional integration with BinderHub to build images on-demand
3. **Permalinks and Auto-Start** - Automatically start pre-defined environments via permalinks.

See the [User Guide](./docs/guide.md) for more details.

## Contributing

We welcome contributions! See the [Developer Guide](./docs/contribute/develop.md) for architecture details and contributing guidelines.

## Funding

Funded in part by [GESIS](http://notebooks.gesis.org) in cooperation with
NFDI4DS [460234259](https://gepris.dfg.de/gepris/projekt/460234259?context=projekt&task=showDetail&id=460234259&)
and [CESSDA](https://www.cessda.eu).
