Metadata-Version: 2.4
Name: tgzr.nice
Version: 0.1.6
Summary: Components and tools for TGZR nice apps
Project-URL: Documentation, https://github.com/open-tgzr/tgzr.nice#readme
Project-URL: Issues, https://github.com/open-tgzr/tgzr.nice/issues
Project-URL: Source, https://github.com/open-tgzr/tgzr.nice
Author-email: Dee <dee.sometech@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: nicegui>=2.24.2
Requires-Dist: pydantic-settings>=2.8.1
Description-Content-Type: text/markdown

# tgzr.nice
Components and tools for TGZR Nice apps

# Usage

## Static Files

### Register the assets and medias folders

```python
import tgzr.nice.static_files

tgzr.nice.static_files.register()

```
then, use like this:
```
# TODO: write this
```

Note: if you're using a tgzr.nice component which rely on static files to be
registered, it will have call `register()` and you won't need to do it. 

### Get a static file

```python
import tgzr.nice.static_files

tgz_thumbnail_path = tgzr.nice.static_files.get_asset_path(group='tgzr', name='tgzr_thumbnail.png')
tgzr_logo_svg_content = tgzr.nice.static_files.get_asset_content(group='tgzr', name='tgzr_logo_bgblack.svg')

some_video = tgzr.nice.static_files.get_media_path(group='group-name', name='video-name.mp4')

```
