feat: add docs for readme

hudsonbrendon · Jan 31, 2025 · 69ef8e1 · 69ef8e1
1 parent 671494f
commit 69ef8e1
Show file tree

Hide file tree

Showing 5 changed files with 167 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,83 @@
 # Python Solar Plus Intelbras
 
+[![Python package](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/pythonpackage.yml/badge.svg?branch=main)](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/pythonpackage.yml)
+[![Upload Python Package](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/python-publish.yml/badge.svg)](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/python-publish.yml)
+[![Dependabot Updates](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/dependabot/dependabot-updates/badge.svg?branch=main)](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/dependabot/dependabot-updates)
+[![pages-build-deployment](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/hudsonbrendon/python-solar-plus-intelbras/actions/workflows/pages/pages-build-deployment)
+
 A wrapper for api solar plus intelbras
+
+
+[![Solar Plus Intelbras](https://solarplus.intelbras.com.br/assets/Intelbras_solar_branco.c8061084.png)](https://hudsonbrendon.github.io/python-solar-plus-intelbras/)
+
+
+Install using pip:
+
+
+```shell
+pip install solar_plus_intelbras
+```
+
+Now, let's get started:
+
+
+```pycon
+>>> from solar_plus_intelbras import SolarPlusIntelbras
+>>> solar_plus_intelbras = SolarPlusIntelbras(email="[email protected]", plus="i2gH3zuE68ClMDop50h8OxKlOYjvWd0vCDACBtN9sEo")
+>>> solar_plus_intelbras.records(plant_id=12345, period="day", key="energy_today", start_date="2025-01-01", end_date="2025-01-01")
+```
+
+## Features
+
+Python Solar Plus Intelbras supports the main endpoints of the Intelbras API:
+
+- Plants: return the list of plants of account;
+- Records: return the records of especific range;
+- Inverters: return the inverters of account;
+- Alerts: return the alerts of account;
+- Notifications: return the notifications of account.
+
+## Documentation
+
+Project documentation is available at [https://hudsonbrendon.github.io/python-solar-plus-intelbras//](https://hudsonbrendon.github.io/python-solar-plus-intelbras/).
+
+## Contribute
+
+If you want to contribute with Python Solar Plus Intelbras check out the Contributing Guide to learn how to start.
+
+```shell
+$ git clone [email protected]:hudsonbrendon/python-solar-plus-intelbras.git
+```
+
+```shell
+$ cd python-solar-plus-intelbras
+```
+
+```shell
+$ poetry install
+```
+
+### Run tests
+
+```shell
+$ pytest
+```
+Or running via vscode interface.
+
+## Dependencies
+
+The Python Solar Plus project relies on these excellent libraries:
+
+- poetry - A manager for virtualenvs and dependencies;
+- requests - A client for http requests;
+- pytest - The best lib python for tests;
+- python 3 - support for python >= 3.8.
+
+<div align="center">
+
+`python solar plus intelbras` is made with 💙 by the [@hudsonbrendon](https://github.com/hudsonbrendon) and distributed under [MIT License](LICENSE.md).
+
+
+
+
+</div>
diff --git a/docs/index.md b/docs/index.md
@@ -1,17 +1,3 @@
-# Welcome to MkDocs
+# Documentation
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+::: solar_plus_intelbras.solar_plus_intelbras
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -23,6 +23,10 @@ markdown_extensions:
   - pymdownx.tabbed
   - pymdownx.snippets
 
-
 plugins:
-- search
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: true  # Para ocultar os links do código-fonte
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,6 +24,8 @@ pytest-freezegun = "^0.4.2"
 mkdocs = "^1.6.1"
 mkdocs-material = "^9.6.1"
 pymdown-extensions = "^10.14.2"
+mkdocstrings = "^0.27.0"
+mkdocstrings-python = "^1.13.0"
 
 [build-system]
 requires = ["poetry-core"]