Metadata-Version: 2.1
Name: smartdoor
Version: 2.0.0.dev0
Summary: Smartdoor system including NFC card detecting, key locking/unlocking, turning LED on/off, etc.
Author-email: Koyo Munechika <munechika.koyo@torus.nr.titech.ac.jp>
Maintainer-email: Koyo Munechika <munechika.koyo@torus.nr.titech.ac.jp>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Home Automation
Classifier: Topic :: Security
Requires-Dist: rich-click
Requires-Dist: requests
Requires-Dist: nfcpy
Requires-Dist: gpiozero
Requires-Dist: tomli; python_version < "3.11"
Requires-Dist: flit ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: black ; extra == "dev"
Requires-Dist: ruff ; extra == "dev"
Requires-Dist: mypy ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Project-URL: Home, https://github.com/munechika-koyo/smartdoor
Provides-Extra: dev

# Smartdoor client system

[![GitHub](https://img.shields.io/github/license/munechika-koyo/cherab_phix)](https://opensource.org/licenses/BSD-3-Clause)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)

Smartdoor system including NFC card detecting, key locking/unlocking, turning LED on/off, etc. with Raspberry Pi.

## Quick Installation
```bash
$ python -m pip install smartdoor
```

## Before getting started
Smartdoor Host system which serves the web application for NFC key management must be run. Please
install and deploy it in adavnce. ([see here](https://github.com/munechika-koyo/smartdoor_host)).

