Metadata-Version: 2.4
Name: sfrbox-api
Version: 0.1.1
Summary: SFR Box API
License: MIT
License-File: LICENSE
Keywords: sfrbox,router
Author: epenet
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Provides-Extra: cli
Requires-Dist: aiohttp (>=3.9.5)
Requires-Dist: click (>=8.0.1) ; extra == "cli"
Requires-Dist: defusedxml (>=0.7.1)
Requires-Dist: mashumaro (>=3.13.1)
Project-URL: Changelog, https://github.com/hacf-fr/sfrbox-api/releases
Project-URL: Documentation, https://sfrbox-api.readthedocs.io
Project-URL: Homepage, https://github.com/hacf-fr/sfrbox-api
Project-URL: Repository, https://github.com/hacf-fr/sfrbox-api
Description-Content-Type: text/markdown

# SFR Box API

[![PyPI](https://img.shields.io/pypi/v/sfrbox-api.svg)][pypi_]
[![Python Version](https://img.shields.io/pypi/pyversions/sfrbox-api)][python version]
[![License](https://img.shields.io/pypi/l/sfrbox-api)][license]

[![Read the documentation at https://sfrbox-api.readthedocs.io/](https://img.shields.io/readthedocs/sfrbox-api/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/hacf-fr/sfrbox-api/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/hacf-fr/sfrbox-api/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)][ruff]

[pypi_]: https://pypi.org/project/sfrbox-api/
[python version]: https://pypi.org/project/sfrbox-api
[read the docs]: https://sfrbox-api.readthedocs.io/
[tests]: https://github.com/hacf-fr/sfrbox-api/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/hacf-fr/sfrbox-api
[pre-commit]: https://github.com/pre-commit/pre-commit
[ruff]: https://github.com/astral-sh/ruff

## Features

- TODO

## Requirements

- TODO

## Installation

You can install _SFR Box API_ via [pip] from [PyPI]:

```console
$ pip install sfrbox-api
```

## Usage

Please see the [Command-line Reference] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_SFR Box API_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/hacf-fr/sfrbox-api/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/hacf-fr/sfrbox-api/blob/main/LICENSE
[contributor guide]: https://github.com/hacf-fr/sfrbox-api/blob/main/CONTRIBUTING.md
[command-line reference]: https://sfrbox-api.readthedocs.io/en/latest/usage.html