Update README.md

This commit is contained in:
2024-01-30 11:57:57 -05:00
committed by GitHub
parent 09a1f6d7e3
commit e883cf9e25
-32
View File
@@ -83,38 +83,6 @@ $ 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
```python
>>> from neon_client import NeonAPI
>>> neon = NeonAPI(api_key='your_api_key')
# List all the API keys.
>>> api_keys = neon.api_keys()
# Get a specific API key.
>>> api_key = neon.api_key(api_key_id='your_api_key_id')
# 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')
```
## Development
Installation is simple with `pipenv`. Just run the following command in the root directory of the repository: