# Python SDK for Pulumi Neon Provider
-----
<div align="center">
⭐ The project needs your support! Please leave a star and become a GitHub sponsor! ⭐
</div>
-----
The SDK to provision [Neon](https://neon.tech/) Postgres projects using the [Pulumi Neon provider](https://github.com/kislerdm/pulumi-neon).
## How to use
### Prerequisites
- Pulumi v3.134.1+
- Python 3.9+
- [Neon API key](https://api-docs.neon.tech/reference/authentication#neon-api-keys) exported as env variable `NEON_API_KEY`
### Steps
1. Create a Pulumi project by running `pulumi new python`
2. Configure the Pulumi secret by running `pulumi config set --secret neon:api_key ${NEON_API_KEY}`.
3. Active venv:
```shell
source venv/bin/activate
```
4. Add the SDK as dependency:
```shell
pip install pulumi_neon
```
5. Edit the file `__main__.py`:
```python
from pulumi_neon.resource.project import Project, ProjectArgs
Project("myproject", ProjectArgs(name="myProjectProvisionedWithPulumiPythonSDK"))
```
6. Run `pulumi up -f`
7. Examine the Neon console: it's expected to see a new project called "myProjectProvisionedWithPulumiPythonSDK".
## How to contribute
Please raise [GitHub issue](https://github.com/kislerdm/pulumi-neon/issues/new) in case of proposals, or found bugs.
Raw data
{
"_id": null,
"home_page": "https://github.com/kislerdm/pulumi-neon",
"name": "pulumi-neon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "pulumi neon category/database",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/52/9b/173449dc59a1a86f45ceaa2a24dfc0d333112a161903765b004632efbac3/pulumi_neon-0.0.1b1.tar.gz",
"platform": null,
"description": "# Python SDK for Pulumi Neon Provider\n\n-----\n\n<div align=\"center\">\n \u2b50 The project needs your support! Please leave a star and become a GitHub sponsor! \u2b50\n</div>\n\n-----\n\nThe SDK to provision [Neon](https://neon.tech/) Postgres projects using the [Pulumi Neon provider](https://github.com/kislerdm/pulumi-neon).\n\n## How to use\n\n### Prerequisites\n\n- Pulumi v3.134.1+\n- Python 3.9+\n- [Neon API key](https://api-docs.neon.tech/reference/authentication#neon-api-keys) exported as env variable `NEON_API_KEY`\n\n### Steps\n\n1. Create a Pulumi project by running `pulumi new python`\n2. Configure the Pulumi secret by running `pulumi config set --secret neon:api_key ${NEON_API_KEY}`.\n3. Active venv:\n\n```shell\nsource venv/bin/activate\n```\n\n4. Add the SDK as dependency:\n\n```shell\npip install pulumi_neon\n```\n\n5. Edit the file `__main__.py`:\n\n```python\nfrom pulumi_neon.resource.project import Project, ProjectArgs\n\nProject(\"myproject\", ProjectArgs(name=\"myProjectProvisionedWithPulumiPythonSDK\"))\n```\n\n6. Run `pulumi up -f`\n7. Examine the Neon console: it's expected to see a new project called \"myProjectProvisionedWithPulumiPythonSDK\".\n\n## How to contribute\n\nPlease raise [GitHub issue](https://github.com/kislerdm/pulumi-neon/issues/new) in case of proposals, or found bugs.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Pulumi Neon Provider",
"version": "0.0.1b1",
"project_urls": {
"Homepage": "https://github.com/kislerdm/pulumi-neon",
"Repository": "https://github.com/kislerdm/pulumi-neon"
},
"split_keywords": [
"pulumi",
"neon",
"category/database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "529b173449dc59a1a86f45ceaa2a24dfc0d333112a161903765b004632efbac3",
"md5": "876176569bf8cf1bf950f3b5c4bd5a12",
"sha256": "d07c122ceca8b13a9b88838a449d96086c4c28108cf1f5b9db37a8a87dd17578"
},
"downloads": -1,
"filename": "pulumi_neon-0.0.1b1.tar.gz",
"has_sig": false,
"md5_digest": "876176569bf8cf1bf950f3b5c4bd5a12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8924,
"upload_time": "2024-12-27T15:05:43",
"upload_time_iso_8601": "2024-12-27T15:05:43.596701Z",
"url": "https://files.pythonhosted.org/packages/52/9b/173449dc59a1a86f45ceaa2a24dfc0d333112a161903765b004632efbac3/pulumi_neon-0.0.1b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-27 15:05:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kislerdm",
"github_project": "pulumi-neon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulumi-neon"
}
JSON
