Metadata-Version: 2.5
Name: mirrordash
Version: 0.6.2rc1
Summary: Core application for MirrorDash
Project-URL: Homepage, https://github.com/Menturan/MirrorDash
Project-URL: Repository, https://github.com/Menturan/MirrorDash
Project-URL: Bug Tracker, https://github.com/Menturan/MirrorDash/issues
Author: Jonas Öhlander
License: # MirrorDash License
        
        Required Notice: Copyright (C) 2026 Jonas Öhlander (https://github.com/Menturan/MirrorDash)
        
        ---
        
        # PolyForm Noncommercial License 1.0.0
        
        <https://polyformproject.org/licenses/noncommercial/1.0.0>
        
        ## Acceptance
        
        In order to get any license under these terms, you must agree
        to them as both strict obligations and conditions to all
        your licenses.
        
        ## Copyright License
        
        The licensor grants you a copyright license for the
        software to do everything you might do with the software
        that would otherwise infringe the licensor's copyright
        in it for any permitted purpose.  However, you may
        only distribute the software according to [Distribution
        License](#distribution-license) and make changes or new works
        based on the software according to [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Distribution License
        
        The licensor grants you an additional copyright license
        to distribute copies of the software.  Your license
        to distribute covers distributing the software with
        changes and new works permitted by [Changes and New Works
        License](#changes-and-new-works-license).
        
        ## Notices
        
        You must ensure that anyone who gets a copy of any part of
        the software from you also gets a copy of these terms or the
        URL for them above, as well as copies of any plain-text lines
        beginning with `Required Notice:` that the licensor provided
        with the software.  For example:
        
        > Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
        
        ## Changes and New Works License
        
        The licensor grants you an additional copyright license to
        make changes and new works based on the software for any
        permitted purpose.
        
        ## Patent License
        
        The licensor grants you a patent license for the software that
        covers patent claims the licensor can license, or becomes able
        to license, that you would infringe by using the software.
        
        ## Noncommercial Purposes
        
        Any noncommercial purpose is a permitted purpose.
        
        ## Personal Uses
        
        Personal use for research, experiment, and testing for
        the benefit of public knowledge, personal study, private
        entertainment, hobby projects, amateur pursuits, or religious
        observance, without any anticipated commercial application,
        is use for a permitted purpose.
        
        ## Noncommercial Organizations
        
        Use by any charitable organization, educational institution,
        public research organization, public safety or health
        organization, environmental protection organization,
        or government institution is use for a permitted purpose
        regardless of the source of funding or obligations resulting
        from the funding.
        
        ## Fair Use
        
        You may have "fair use" rights for the software under the
        law. These terms do not limit them.
        
        ## No Other Rights
        
        These terms do not allow you to sublicense or transfer any of
        your licenses to anyone else, or prevent the licensor from
        granting licenses to anyone else.  These terms do not imply
        any other licenses.
        
        ## Patent Defense
        
        If you make any written claim that the software infringes or
        contributes to infringement of any patent, your patent license
        for the software granted under these terms ends immediately. If
        your company makes such a claim, your patent license ends
        immediately for work on behalf of your company.
        
        ## Violations
        
        The first time you are notified in writing that you have
        violated any of these terms, or done anything with the software
        not covered by your licenses, your licenses can nonetheless
        continue if you come into full compliance with these terms,
        and take practical steps to correct past violations, within
        32 days of receiving notice.  Otherwise, all your licenses
        end immediately.
        
        ## No Liability
        
        ***As far as the law allows, the software comes as is, without
        any warranty or condition, and the licensor will not be liable
        to you for any damages arising out of these terms or the use
        or nature of the software, under any kind of legal claim.***
        
        ## Definitions
        
        The **licensor** is the individual or entity offering these
        terms, and the **software** is the software the licensor makes
        available under these terms.
        
        **You** refers to the individual or entity agreeing to these
        terms.
        
        **Your company** is any legal entity, sole proprietorship,
        or other kind of organization that you work for, plus all
        organizations that have control over, are under the control of,
        or are under common control with that organization.  **Control**
        means ownership of substantially all the assets of an entity,
        or the power to direct its management and policies by vote,
        contract, or otherwise.  Control can be direct or indirect.
        
        **Your licenses** are all the licenses granted to you for the
        software under these terms.
        
        **Use** means anything you do with the software requiring one
        of your licenses.
License-File: LICENSE.md
Keywords: dashboard,fastapi,kiosk,magicmirror,raspberrypi
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Requires-Python: >=3.14
Requires-Dist: fastapi==0.136.3
Requires-Dist: jinja2==3.1.6
Requires-Dist: python-multipart>=0.0.19
Requires-Dist: uvicorn[standard]==0.49.0
Provides-Extra: dev
Requires-Dist: httpx>=0.27.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-mock>=3.12.0; extra == 'dev'
Requires-Dist: pytest-playwright>=0.5.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# 🪞 MirrorDash

[![Python Version](https://img.shields.io/badge/python-3.14%2B-blue.svg)](pyproject.toml)
[![License: PolyForm_NC_1.0.0](https://img.shields.io/badge/license-PolyForm_NC_1.0.0-525252)](LICENSE.md)
[![Platform](https://img.shields.io/badge/platform-Raspberry%20Pi-orange.svg)](#get-started)
[![PyPI version](https://img.shields.io/pypi/v/mirrordash.svg)](https://pypi.org/project/mirrordash/)
[![Downloads](https://pepy.tech/badge/mirrordash)](https://pepy.tech/project/mirrordash)

**A calm display for your hallway mirror: the time, the weather and your day, glowing through the glass. No touchscreen, no voice assistant, no notifications.**

![MirrorDash on a mirror](https://raw.githubusercontent.com/Menturan/MirrorDash/master/mirrordash_concept.png)

### From SD card to mirror in three steps

1. **Flash** the MirrorDash image onto an SD card and put it in the Pi.
2. **Join** the mirror's own Wi-Fi with your phone (scan the QR code on the screen) and pick your home network.
3. **Done.** Open `mirrordash.local` on your phone to choose what the mirror shows.

No keyboard, no terminal, no config files, now or later.

## Why it's different from the smart mirror you built last time

| | A typical DIY smart mirror | MirrorDash |
|---|---|---|
| Setting it up | Keyboard, terminal, config files | Join its Wi-Fi from your phone, pick your network |
| Changing things | Edit a file over SSH | Your phone, in the admin page |
| An update goes wrong | A black screen, and an evening of debugging | It goes back to the last version by itself |
| The SD card | Wears out from constant writing | The system part is read-only |
| The screen | On all night | On when someone's there, on a schedule, or from Home Assistant |
| New widgets | Copy code into the project | Tap *Install* in the admin page |

![The mirror's screen](https://raw.githubusercontent.com/Menturan/MirrorDash/master/screenshot.png)

## Get started

**You need**

* A Raspberry Pi 3 or newer (MirrorDash is developed and tested on a Pi 3 B).
* An SD card of at least 8 GB.
* The official power supply (5.1 V, 2.5 A for a Pi 3). A weaker one makes the mirror slow, and it warns you.
* A screen behind a two-way mirror.

**Then**

1. Download the latest image (`mirrordash-os-….img.xz`) from [Releases](https://github.com/Menturan/MirrorDash/releases): the newest release whose name ends in `-os1`, `-os2`, ….
2. Flash it with [Raspberry Pi Imager](https://www.raspberrypi.com/software/) (*Choose OS* → *Use custom*).
3. Start the mirror. On its first start it restarts once by itself, then shows the Wi-Fi setup. The [user guide](USER_GUIDE.md#2-first-start-wi-fi-setup) takes it from there.

## Modules

The clock comes with the mirror. Install the others in the admin page under **Modules → Discover New Modules**.

| Module | Shows |
|---|---|
| [Clock](https://github.com/Menturan/mirrordash-clock) | The time and date |
| [Weather](https://github.com/Menturan/mirrordash-weather) | The weather now and the forecast |
| [Calendar](https://github.com/Menturan/mirrordash-calendar) | Your upcoming events |
| [News](https://github.com/Menturan/mirrordash-news) | The latest headlines from built-in or your own sources |
| [Home Assistant](https://github.com/Menturan/mirrordash-homeassistant) | Sensors from Home Assistant |
| [Krisinformation](https://github.com/Menturan/mirrordash-krisinformation) | Swedish crisis information from Krisinformation.se |
| [Namnsdag](https://github.com/Menturan/mirrordash-namnsdag) | The Swedish name day |

### Make your own

```bash
uvx mirrordash-sdk quickstart mirrordash-my-widget
```

This creates a module with example data and starts a mirror on your computer that shows every change as you save. Put the module on GitHub as `mirrordash-<something>` and publish a GitHub Release: it then shows up in every mirror's Discover list. The [SDK](https://github.com/Menturan/mirrordash-sdk) and its [module guide](https://github.com/Menturan/mirrordash-sdk/blob/master/MODULE_GUIDE.md) have the details.

## Under the hood

* **Server:** FastAPI (Python 3.14). Modules push their content to the screen over a WebSocket, and a page that reconnects gets everything again right away.
* **Screen:** plain HTML, CSS and JavaScript without a build step, shown full screen by Cog (WPE WebKit) on labwc. Every mirror has its component library at `/design`.
* **Modules:** each is its own Python package, found through entry points. A module that crashes is restarted on its own.
* **System:** Raspberry Pi OS (Debian 13) with a read-only root (overlayroot). Settings, modules and Wi-Fi live on a separate partition. Updates go into a second environment, and the mirror switches back if the new one doesn't start.

## Documentation

* [User guide](USER_GUIDE.md): setting up, wiring, the screen's rules, recovery, Home Assistant.
* [Changelog](CHANGELOG.md): what's new in each release.
* [Architecture](ARCHITECTURE.md) and [Design system](DESIGN.md): for contributors.
* [Golden image](GOLDEN_IMAGE.md) and [Releasing](RELEASING.md): how the OS image is built and released.

## License

[PolyForm Noncommercial 1.0.0](LICENSE.md): free to use and change for personal, non-commercial use.
