Update documentation and add note about Python version requirement

This commit is contained in:
2024-02-07 09:33:22 -05:00
parent 676ba82624
commit c9901f7f5b
+4 -9
View File
@@ -19,9 +19,7 @@ With ``neon_client``, developers can:
- Enhance application security by managing API keys and permissions through code. - Enhance application security by managing API keys and permissions through code.
- Leverage the power of Neon's cloud database without the need for manual intervention or the Neon console. - Leverage the power of Neon's cloud database without the need for manual intervention or the Neon console.
.. note::
This documentation is a work in progress. It is not yet complete.
This project simplifies the complexity of interacting with the Neon API, making it more accessible for developers to This project simplifies the complexity of interacting with the Neon API, making it more accessible for developers to
build scalable, data-driven applications with ease. Pydantic dataclasses are used to represent the data structures returned build scalable, data-driven applications with ease. Pydantic dataclasses are used to represent the data structures returned
@@ -36,6 +34,10 @@ To install the package, run the following command:
$ pip install neon-client $ pip install neon-client
.. note::
The package requires Python 3.10 or later.
Usage Usage
----- -----
@@ -113,13 +115,6 @@ Classes
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
--------------------
.. automodule:: neon_client.schema
:members:
:undoc-members:
:show-inheritance:
Indices and tables Indices and tables
================== ==================