https://github.com/kennethreitz/neon-api-python

a Python client for the Neon API
https://github.com/kennethreitz/neon-api-python

api client http neon pg postgres python rest

Last synced: 1 day ago
JSON representation

a Python client for the Neon API

• Host: GitHub
• URL: https://github.com/kennethreitz/neon-api-python
• Owner: neondatabase
• License: apache-2.0
• Created: 2024-01-18T17:52:35.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-10T00:32:17.000Z (3 months ago)
• Last Synced: 2024-11-06T09:12:21.412Z (9 days ago)
• Topics: api, client, http, neon, pg, postgres, python, rest
• Language: Python
• Homepage: https://neon-api-python.readthedocs.io/
• Size: 388 KB
• Stars: 13
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# `neon_api`: Python API wrapper for the [Neon API](https://api-docs.neon.tech/reference/getting-started-with-neon-api).

`neon_api` is a Python wrapper designed to simplify interactions with the [Neon API](https://api-docs.neon.tech/reference/getting-started-with-neon-api). It provides a convenient way for developers to integrate their Python applications with the Neon platform, offering methods to manage API keys, projects, branches, databases, endpoints, roles, and operations programmatically.

With `neon_api`, you can automate tasks, streamline workflows, and build powerful integrations with ease.

## Installation

Installation of `neon_api` is easy, with pip:

```bash

$ pip install neon-api

```

## Usage

```python

from neon_api import NeonAPI

# Initialize the client.

neon = NeonAPI(api_key='your_api_key')

```

**[Documentation is available on ReadTheDocs](https://neon-api-python.readthedocs.io/)**.

Remember that you should never expose your api_key and handle it carefully since it gives access to sensitive data. It's better to set it as an environment variable (e.g. `NEON_API_KEY` + accompanying `neon_api.from_environ()`).

-------

### Methods of the `NeonAPI` class:

- `me()`: Returns the current user.

**Manage API keys**:

- `api_keys()`: Returns a list of API keys.

- `api_key_create(**json)`: Creates an API key.

- `api_key_delete(key_id)`: Deletes a given API key.

**Manage projects**:

- `projects()`: Returns a list of projects.

- `project(project_id)`: Returns a specific project.

- `project_create(project_id, **json)`: Creates a new project. 

- `project_update(project_id, **json)`: Updates a given project.

- `project_delete(project_id)`: Deletes a given project.

- `project_permissions(project_id)`: Returns a list of permissions for a given project.

- `project_permissions_grant(project_id, **json)`: Grant permissions to a given project.

- `project_permissions_revoke(project_id, **json)`: Revoke permissions from a given project.

**Manage branches**:

- `branches(project_id)`: Returns a list of branches for a given project.

- `branch(project_id, branch_id)`: Returns a specific branch.

- `branch_create(project_id, **json)`: Creates a new branch.

- `branch_update(project_id, branch_id, **json)`: Updates a given branch.

- `branch_delete(project_id, branch_id)`: Deletes a given branch.

- `branch_set_as_primary(project_id, branch_id)`: Sets a given branch as primary.

**Manage databases**:

- `databases(project_id, branch_id)`: Returns a list of databases for a given project and branch.

- `database(project_id, branch_id, database_id)`: Returns a specific database.

- `database_create(project_id, branch_id, **json)`: Creates a new database.

- `database_update(project_id, branch_id, **json)`: Updates a given database.

- `database_delete(project_id, branch_id, database_id)`: Deletes a given database.

**Manage endpoints**:

- `endpoints(project_id, branch_id)`: Returns a list of endpoints for a given project and branch.

- `endpoint_create(project_id, branch_id, **json)`: Creates a new endpoint.

- `endpoint_update(project_id, branch_id, endpoint_id, **json)`: Updates a given endpoint.

- `endpoint_delete(project_id, branch_id, endpoint_id)`: Deletes a given endpoint.

- `endpoint_start(project_id, branch_id, endpoint_id)`: Starts a given endpoint.

- `endpoint_suspend(project_id, branch_id, endpoint_id)`: Suspends a given endpoint.

**Manage roles**:

- `roles(project_id, branch_id)`: Returns a list of roles for a given project and branch.

- `role(project_id, branch_id, role_name)`: Returns a specific role.

- `role_create(project_id, branch_id, role_name)`: Creates a new role.

- `role_delete(project_id, branch_id, role_name)`: Deletes a given role.

- `role_password_reveal(project_id, branch_id, role_name)`: Reveals the password for a given role.

- `role_password_reset(project_id, branch_id, role_name)`: Resets the password for a given role.

**Manage operations**:

- `operations(project_id)`: Returns a list of operations for a given project.

- `operation(project_id, operation_id)`: Returns a specific operation.

**Experimental**:

- `consumption()`: Returns a list of project consumption metrics.

View the [Neon API documentation](https://api-docs.neon.tech/reference/getting-started-with-neon-api) for more information on the available endpoints and their parameters.

## Development

First, create a virtual environment, then install the dependencies of the library with `pip`:

```bash

$ pip install -r requirements.txt

```

This will install all the necessary dependencies for development.

To run the tests, use the following command:

```bash

$ make test

```

The tests don't require an internet connection, as they are mocked using the `pytest-vcr` library. To record new cassettes, use the following command:

```bash

$ make record

```

This will record new cassettes for the tests. Make sure to commit these cassettes along with your changes.

## License & Copyright

[Apache 2.0 Licensed](./LICENSE).