Skip to main content

Notes widget for the dinky dashboard

Project description

dinky-notes

Notes widget for the dinky dashboard generator

Installation

Install this plugin using pip:

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:

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:

dm.draw_dashboard()

Development

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

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

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

python -m pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dinky-notes-0.2.tar.gz (95.5 kB view hashes)

Uploaded Source

Built Distribution

dinky_notes-0.2-py3-none-any.whl (94.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page