Metadata-Version: 2.1
Name: Enphase-API
Version: 0.0.1
Summary: An unofficial Enphase® API that predominantly focuses on the local API.
Author: Matthew1471! (https://Matthew1471.co.uk/Contact.php)
Maintainer: Matthew1471! (https://Matthew1471.co.uk/Contact.php)
License: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Project-URL: Homepage, https://github.com/Matthew1471/Enphase-API/
Project-URL: Bug Reports, https://github.com/Matthew1471/Enphase-API/issues
Project-URL: Documentation, https://github.com/Matthew1471/Enphase-API/tree/master/Documentation
Project-URL: Say Thanks!, https://Matthew1471.co.uk/Contact.php
Project-URL: Source, https://github.com/Matthew1471/Enphase-API/
Keywords: Enphase,Envoy,Gateway,Solar,Microinverters,Production,Generation,Sun
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: System :: Power (UPS)
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev

# Enphase-API - The unofficial Enphase® SDK for Python

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

This project is focusing primarily on the Enphase® "IQ Gateway" (formerly "IQ Envoy") system, the gateway for Enphase®'s IQ7 and IQ8 Microinverters used on solar panels to convert Direct Current (DC) to Alternating Current (AC) to be directly consumed by the home.

WARNING: This project currently predominantly consumes the same local API that the local Gateway web administration portal consumes and Enphase® may choose to change it in subsequent updates without warning.

## Installing Enphase-API

Enphase-API is available on PyPI:

```console
$ python -m pip install Enphase_API
```

## Documentation

The documentation for the wrapper and the API itself is at [Enphase-API Documentation GitHub](https://github.com/Matthew1471/Enphase-API/tree/master/Documentation/README.adoc)

## Copyright and License

### Code

Copyright (C) 2023  Matthew1471

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

### Documentation

Copyright (c)  2023  Matthew1471.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the file [Enphase-API Documentation License](https://github.com/Matthew1471/Enphase-API/tree/master/Documentation/LICENSE.md).

## Authors

*Enphase-API* is led by [Matthew1471](https://github.com/Matthew1471) and may have received contributions from [other individuals](https://github.com/Matthew1471/Enphase-API/graphs/contributors) in GitHub's awesome community.
The project was initiated in 2022 by [Matthew1471](https://github.com/Matthew1471) after having his own solar installation and wanting to know when is the cheapest time to put on the dishwasher.

## Trademarks

Enphase®, Envoy® are trademarks of Enphase Energy®.

All trademarks are the property of their respective owners.

Any trademarks used in this project are used in a purely descriptive manner and to state compatability.
