Metadata-Version: 2.1
Name: textual-snowfall
Version: 0.0.3.post2
Project-URL: Documentation, https://github.com/lllama/textual-snowfall#readme
Project-URL: Issues, https://github.com/lllama/textual-snowfall/issues
Project-URL: Source, https://github.com/lllama/textual-snowfall
Author-email: Felix Ingram <f.ingram@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
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.7
Requires-Dist: textual
Description-Content-Type: text/markdown

# textual-snowfall

[![PyPI - Version](https://img.shields.io/pypi/v/textual-snowfall.svg)](https://pypi.org/project/textual-snowfall)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/textual-snowfall.svg)](https://pypi.org/project/textual-snowfall)

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install textual-snowfall
```

## License

`textual-snowfall` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Usage

Textual-snowfall is a [Textual](https://textual.textualize.io) container widget that'll add snow to your app. Use it as you would use a normal container, or use it as a mixin with other container classes.

For example:

```py
from textual.app import App
from textual.containers import ScrollableContainer

from textual_snowfall.widgets import Snowfall

class SnowScroll(ScrollableContainer, Snowfall):
    pass

class MyApp(App):
    def compose(self):
        yield SnowScroll()
```
