mirror of
https://github.com/kennethreitz/neon-api-python.git
synced 2026-06-05 22:50:18 +00:00
Refactor imports and remove unused code
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# neon_client: an api wrapper for neon.tech v2 api
|
||||
|
||||
|
||||
|
||||
## Future Installation
|
||||
|
||||
```bash
|
||||
$ pip install neon-client
|
||||
```
|
||||
|
||||
**Please Note**: this repository is a work in progress. The package is not yet available on PyPi. The above command will not work.
|
||||
|
||||
## Usage
|
||||
|
||||
```pycon
|
||||
>>> from neon_client import NeonClient
|
||||
|
||||
>>> neon = NeonClient(api_key='your_api_key')
|
||||
|
||||
>>> # Get all the projects
|
||||
>>> projects = neon.projects()
|
||||
|
||||
|
||||
>>> # Get a specific project
|
||||
>>> project = neon.project(project_id='your_project_id')
|
||||
|
||||
>>> # Get all the databases
|
||||
>>> databases = neon.databases()
|
||||
|
||||
>>> # Get a specific database
|
||||
>>> database = neon.database(database_id='your_database_id')
|
||||
|
||||
>>> # Get all the branches for a given database.
|
||||
>>> branches = neon.branches(database_id='your_database_id')
|
||||
|
||||
>>> # Get a specific branch
|
||||
>>> branch = neon.branch(database_id='your_database_id', branch_id='your_branch_id')
|
||||
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user