{"id":22558190,"url":"https://github.com/couchbase-starter-kit/couchbase-flask-starter","last_synced_at":"2026-02-24T06:17:49.677Z","repository":{"id":256162534,"uuid":"854482391","full_name":"couchbase-starter-kit/couchbase-flask-starter","owner":"couchbase-starter-kit","description":"A starter kit for building Flask applications with Couchbase integration. Includes sample configurations, environment setup, Pytest test","archived":false,"fork":false,"pushed_at":"2024-09-13T08:13:51.000Z","size":29,"stargazers_count":0,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-06T16:49:35.226Z","etag":null,"topics":["codespace","couchbase","devcontainer","flask","gitpod","python","starter","starter-kit"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/couchbase-starter-kit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-09T08:52:52.000Z","updated_at":"2024-10-03T10:08:44.000Z","dependencies_parsed_at":"2024-09-12T19:06:41.682Z","dependency_job_id":null,"html_url":"https://github.com/couchbase-starter-kit/couchbase-flask-starter","commit_stats":null,"previous_names":["couchbase-starter-kit/couchbase-flask-starter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase-starter-kit%2Fcouchbase-flask-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase-starter-kit%2Fcouchbase-flask-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase-starter-kit%2Fcouchbase-flask-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase-starter-kit%2Fcouchbase-flask-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/couchbase-starter-kit","download_url":"https://codeload.github.com/couchbase-starter-kit/couchbase-flask-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228651859,"owners_count":17951896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codespace","couchbase","devcontainer","flask","gitpod","python","starter","starter-kit"],"created_at":"2024-12-07T20:12:34.457Z","updated_at":"2025-10-24T23:07:43.977Z","avatar_url":"https://github.com/couchbase-starter-kit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Couchbase Flask Starter Kit\n[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/couchbase-starter-kit/couchbase-flask-starter)\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/couchbase-starter-kit/couchbase-flask-starter)\n![Test Suite](https://github.com/couchbase-starter-kit/couchbase-flask-starter/actions/workflows/run-tests.yml/badge.svg)\n![Couchbase Capella](https://img.shields.io/badge/Couchbase_Capella-Enabled-red)\n[![License: MIT](https://cdn.prod.website-files.com/5e0f1144930a8bc8aace526c/65dd9eb5aaca434fac4f1c34_License-MIT-blue.svg)](/LICENSE)\n![Static Badge](https://img.shields.io/badge/Code_of_Conduct-Contributor_Covenant-violet.svg)\n\n## Configuration\n\n| Variable Name                      | Description                                                 |      Default value       |\n|:-----------------------------------|:------------------------------------------------------------|:------------------------:|\n| FLASK_APP                          | The name of your application                                | couchbase-flask-starter  |\n| COUCHBASE_CONNECTION_STRING        | A couchbase connection string                               |            -             |\n| COUCHBASE_USERNAME                 | Username for authentication with Couchbase                  |            -             |\n| COUCHBASE_PASSWORD                 | Password for authentication with Couchbase                  |            -             |\n| COUCHBASE_USE_CAPELLA              | Use to change the connection profile                        |          false           |\n| COUCHBASE_DEFAULT_BUCKET           | The name of the Couchbase Bucket, parent of the scope       |         default          |\n| COUCHBASE_DEFAULT_SCOPE            | The name of the Couchbase scope, parent of the collection   |         _default         |\n| COUCHBASE_DEFAULT_COLLECTION       | The name of the Couchbase collection to store the Documents |         _default         |\n\n## Getting Started\n\nFollow these steps to get the starter kit up and running on yoru local machine. \n\n### Prerequisites\n\nMake sure you have the following installed:\n\n- Python 3.x\n- Git \n\n### Clone the repository\n\n```\ngit clone https://github.com/couchbase-starter-kit/couchbase-flask-starter.git\ncd couchbase-flask-starter\n```\n\n### Install Dependencies\n\n```\npip3 install -r \"requirements.txt\"\n```\n\n### Configure Couchbase Credentials \n\nCopy the `.env.sample` file in the root directory of the project and rename it to `.env`. Update the `.env` file with your Couchbase credentials as follows:\n\n```\nFLASK_APP=couchbase-flask-starter\nCOUCHBASE_CONNECTION_STRING=\"couchbase://localhost\"\nCOUCHBASE_USERNAME=\"Administrator\"\nCOUCHBASE_PASSWORD=\"password\"\nCOUCHBASE_USE_CAPELLA=false\nCOUCHBASE_DEFAULT_BUCKET=\"default\"\nCOUCHBASE_DEFAULT_SCOPE=\"_default\"\nCOUCHBASE_DEFAULT_COLLECTION=\"_default\"\n```\n\nYou can obtain those credentials by first creating an account on Couchbase Capella at [https://cloud.couchbase.com/](https://cloud.couchbase.com/) and then creating a database. Inside the database, create a bucket. The name of the bucket is what you should use for the `COUCHBASE_DEFAULT_BUCKET` environment variable.\n\nOnce you have done so, you can navigate to the `Connect` tab in the database and copy the connection string URL. This is what you should use for the `COUCHBASE_CONNECTION_STRING` environment variable. You will also need to create a user with the appropriate permissions and use the username and password for the `COUCHBASE_USERNAME` and `COUCHBASE_PASSWORD` environment variables.\n\n## Unit Tests\n\nUnit tests are run using pytest.\n\n## Running the test suite\n\nTo run the test suite, use the following command: \n\n```\npytest \n```\n\n## Running the Application\n\nTo run the application, use the following command:\n\n```\npython run.py\n```\n\n## Development with Gitpod\n\nThis project is configured to work with Gitpod. Click the \"Open in Gitpod\" button above to start a new workspace.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase-starter-kit%2Fcouchbase-flask-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcouchbase-starter-kit%2Fcouchbase-flask-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase-starter-kit%2Fcouchbase-flask-starter/lists"}