# libcapella 1.0.20
## Installing
```
$ pip install libcapella
```
Create Capella database:
```
database_name = "test-cluster"
project_name = "test-project"
email = 'john.doe@example.com'
config = CapellaConfig(profile="default")
org = CapellaOrganization(config)
project = CapellaProject(org, project_name, email)
database = CapellaDatabase(project, database_name)
builder = CapellaDatabaseBuilder("aws")
builder = builder.name(database_name)
builder = builder.description("Test cluster")
builder = builder.region("us-east-1")
builder = builder.service_group("4x16", 3, 256)
config = builder.build()
database.create(config)
```
## Credentials Directory
Automation for Capella leverages the v4 public API. To integrate the v4 API with `libcapella`, create an API key in the Capella UI and save it to a file named ```default-api-key-token.txt``` in a directory named ```.capella``` in your home directory. Add the email associated with your Capella account to the `credentials` file in the `default` section.
```
.capella
├── credentials
├── default-api-key-token.txt
├── project-api-key-token.txt
└── test-api-key-token.txt
```
Credentials file format:
```
[default]
api_host = cloudapi.cloud.couchbase.com
token_file = default-api-key-token.txt
account_email = john.doe@example.com
[project]
token_file = project-api-key-token.txt
```
Raw data
{
"_id": null,
"home_page": null,
"name": "libcapella",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "couchbase, capella, api",
"author": "Michael Minichino",
"author_email": "info@unix.us.com",
"download_url": "https://files.pythonhosted.org/packages/bc/a0/71bc0eba2f1e26b5b75c969b3afae40f112fd777330f960304737c9a430f/libcapella-1.0.20.tar.gz",
"platform": null,
"description": "# libcapella 1.0.20\n\n## Installing\n```\n$ pip install libcapella\n```\n\nCreate Capella database:\n```\ndatabase_name = \"test-cluster\"\nproject_name = \"test-project\"\nemail = 'john.doe@example.com'\nconfig = CapellaConfig(profile=\"default\")\norg = CapellaOrganization(config)\nproject = CapellaProject(org, project_name, email)\ndatabase = CapellaDatabase(project, database_name)\nbuilder = CapellaDatabaseBuilder(\"aws\")\nbuilder = builder.name(database_name)\nbuilder = builder.description(\"Test cluster\")\nbuilder = builder.region(\"us-east-1\")\nbuilder = builder.service_group(\"4x16\", 3, 256)\nconfig = builder.build()\ndatabase.create(config)\n```\n\n## Credentials Directory\nAutomation for Capella leverages the v4 public API. To integrate the v4 API with `libcapella`, create an API key in the Capella UI and save it to a file named ```default-api-key-token.txt``` in a directory named ```.capella``` in your home directory. Add the email associated with your Capella account to the `credentials` file in the `default` section.\n```\n.capella\n\u251c\u2500\u2500 credentials\n\u251c\u2500\u2500 default-api-key-token.txt\n\u251c\u2500\u2500 project-api-key-token.txt\n\u2514\u2500\u2500 test-api-key-token.txt\n```\nCredentials file format:\n```\n[default]\napi_host = cloudapi.cloud.couchbase.com\ntoken_file = default-api-key-token.txt\naccount_email = john.doe@example.com\n\n[project]\ntoken_file = project-api-key-token.txt\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Couchbase Capella Python API",
"version": "1.0.20",
"project_urls": {
"Homepage": "https://github.com/mminichino/capella-api"
},
"split_keywords": [
"couchbase",
" capella",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "705623ac5f7f03cdb9a128c29357e9bcc49af9bae88ae6efaef0b79ec999fd30",
"md5": "ce624e3f77cd05c5d9751f6390bb544e",
"sha256": "17bd6f28ecf4adaf7ee1fe7c88e87919e2768f74cd03f068c73824846ae637c8"
},
"downloads": -1,
"filename": "libcapella-1.0.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce624e3f77cd05c5d9751f6390bb544e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 29165,
"upload_time": "2024-11-27T16:28:38",
"upload_time_iso_8601": "2024-11-27T16:28:38.184105Z",
"url": "https://files.pythonhosted.org/packages/70/56/23ac5f7f03cdb9a128c29357e9bcc49af9bae88ae6efaef0b79ec999fd30/libcapella-1.0.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bca071bc0eba2f1e26b5b75c969b3afae40f112fd777330f960304737c9a430f",
"md5": "1d527958155d3238ee3796651723aee1",
"sha256": "1c3c61db4327c38623e8a1de3d1cd7a6607467a70f18c94e3803c376bf9f3257"
},
"downloads": -1,
"filename": "libcapella-1.0.20.tar.gz",
"has_sig": false,
"md5_digest": "1d527958155d3238ee3796651723aee1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 16943,
"upload_time": "2024-11-27T16:28:40",
"upload_time_iso_8601": "2024-11-27T16:28:40.749308Z",
"url": "https://files.pythonhosted.org/packages/bc/a0/71bc0eba2f1e26b5b75c969b3afae40f112fd777330f960304737c9a430f/libcapella-1.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 16:28:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mminichino",
"github_project": "capella-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "libcapella"
}
JSON
