Metadata-Version: 2.1
Name: dinky-notes
Version: 0.1.1
Summary: Notes widget for the dinky dashboard
Author: Julian Prester
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dinky
Requires-Dist: pluggy
Requires-Dist: Pillow
Requires-Dist: requests
Requires-Dist: setuptools
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# dinky-notes

Notes widget for the [dinky](https://github.com/get-dinky/dinky) dashboard generator

## Installation

Install this plugin using `pip`:

```bash
pip install dinky-notes
```

## Usage

`dinky-notes` is a plugin for the `dinky` dashboard generator. You can simply register the notes widget with your DashboardManager:

```python
from dinky_notes import DinkyNotesPlugin

dm.register(DinkyNotesPlugin(url="URL to the notes file (e.g., a shared cloud link)"), zone="A")
```

Then draw your dashboard as usual:

```python
dm.draw_dashboard()
```

## Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

```bash
cd dinky-notes
python -m venv .venv
source .venv/bin/activate
```

Now install the dependencies and test dependencies:

```bash
pip install -e '.[test]'
```

To run the tests:

```bash
python -m pytest
```
