# Scylla-Go-Round
Welcome to Scylla-Go-Round! Spin up your ScyllaDB schemas into Go types with ease and style. This CLI tool is your handy companion in bridging the gap between schema design and Go implementation, ensuring your applications are running smoothly with the latest data structures.
## Features
- **Generate Go types** directly from your ScyllaDB or Cassandra schema.
- **Automatic connection** to your ScyllaDB instance.
- **Environment and CLI flexibility** for easy configuration.
## Getting Started
### Prerequisites
- Python 3.6+
- ScyllaDB or Cassandra setup
### Installation
Install `scylla-go-round` using pip:
```bash
pip install scylla-go-round
```
### Usage
Generate Go types by running:
```bash
scyllago --keyspace your_keyspace_name --host your_scylladb_host
```
### Configuration
You can configure `scylla-go-round` via environment variables or command line arguments:
- `SCYLLADB_DEV_HOST`: The host for your ScyllaDB instance.
- `SCYLLADB_DEV_ROLE`: Your ScyllaDB username.
- `SCYLLADB_DEV_PWD`: Your ScyllaDB password.
There is an example of what your `.env` file can look like in this current directory. You should rename that to be the `.env` file if you want it to be loaded in from this tool.
### Contributing
We love contributions! If you'd like to help improve Scylla-Go-Round, please follow these steps:
- Fork the repo on GitHub.
- Clone your fork locally.
- Create a new feature branch (git checkout -b my-new-feature).
- Make your changes.
- Push the branch to GitHub (git push origin my-new-feature).
- Submit a pull request.
### License
Scylla-Go-Round is released under the MIT License. See the LICENSE file for more details.
Happy Coding!
Thank you for using or contributing to Scylla-Go-Round. Have fun spinning your schemas into efficient Go types!
Raw data
{
"_id": null,
"home_page": "https://github.com/johnlarkin1/scylla-go-round",
"name": "scylla-go-round",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "scylla, cassandra, go, cli, schema",
"author": "John Larkin",
"author_email": "john@johnjlarkin.com",
"download_url": "https://files.pythonhosted.org/packages/a1/30/a53349e5c28d294a44718f9351c3c066fae8cc54f7e244c807a31969b8fd/scylla_go_round-0.2.0.tar.gz",
"platform": null,
"description": "# Scylla-Go-Round\n\nWelcome to Scylla-Go-Round! Spin up your ScyllaDB schemas into Go types with ease and style. This CLI tool is your handy companion in bridging the gap between schema design and Go implementation, ensuring your applications are running smoothly with the latest data structures.\n\n## Features\n\n- **Generate Go types** directly from your ScyllaDB or Cassandra schema.\n- **Automatic connection** to your ScyllaDB instance.\n- **Environment and CLI flexibility** for easy configuration.\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.6+\n- ScyllaDB or Cassandra setup\n\n### Installation\n\nInstall `scylla-go-round` using pip:\n\n```bash\npip install scylla-go-round\n```\n\n### Usage\n\nGenerate Go types by running:\n\n```bash\nscyllago --keyspace your_keyspace_name --host your_scylladb_host\n```\n\n### Configuration\n\nYou can configure `scylla-go-round` via environment variables or command line arguments:\n\n- `SCYLLADB_DEV_HOST`: The host for your ScyllaDB instance.\n- `SCYLLADB_DEV_ROLE`: Your ScyllaDB username.\n- `SCYLLADB_DEV_PWD`: Your ScyllaDB password.\n\nThere is an example of what your `.env` file can look like in this current directory. You should rename that to be the `.env` file if you want it to be loaded in from this tool.\n\n### Contributing\n\nWe love contributions! If you'd like to help improve Scylla-Go-Round, please follow these steps:\n\n- Fork the repo on GitHub.\n- Clone your fork locally.\n- Create a new feature branch (git checkout -b my-new-feature).\n- Make your changes.\n- Push the branch to GitHub (git push origin my-new-feature).\n- Submit a pull request.\n\n### License\n\nScylla-Go-Round is released under the MIT License. See the LICENSE file for more details.\n\nHappy Coding!\nThank you for using or contributing to Scylla-Go-Round. Have fun spinning your schemas into efficient Go types!\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool to generate Go types from ScyllaDB or Cassandra schemas",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/johnlarkin1/scylla-go-round"
},
"split_keywords": [
"scylla",
" cassandra",
" go",
" cli",
" schema"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3e1876c072f2a5203414c8335f552a1aa74a4a2a47d01c0a6dc153c58f80ea0",
"md5": "a6e7aba4e14f1bc8af1ed779163c1fb1",
"sha256": "32f42a93655b8001f01ed3e357c0e7abd1944f2ab9a81e8d6f0115b0768f9cee"
},
"downloads": -1,
"filename": "scylla_go_round-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6e7aba4e14f1bc8af1ed779163c1fb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7204,
"upload_time": "2024-09-01T16:47:14",
"upload_time_iso_8601": "2024-09-01T16:47:14.731695Z",
"url": "https://files.pythonhosted.org/packages/e3/e1/876c072f2a5203414c8335f552a1aa74a4a2a47d01c0a6dc153c58f80ea0/scylla_go_round-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a130a53349e5c28d294a44718f9351c3c066fae8cc54f7e244c807a31969b8fd",
"md5": "47e30a6f732e92b81092c6f748c195f4",
"sha256": "2c6dbdc35de031cc6a131ddc0e2f4a740ae03202e58dc7de5831cea99dd8e4b6"
},
"downloads": -1,
"filename": "scylla_go_round-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "47e30a6f732e92b81092c6f748c195f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 5650,
"upload_time": "2024-09-01T16:47:16",
"upload_time_iso_8601": "2024-09-01T16:47:16.730502Z",
"url": "https://files.pythonhosted.org/packages/a1/30/a53349e5c28d294a44718f9351c3c066fae8cc54f7e244c807a31969b8fd/scylla_go_round-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 16:47:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "johnlarkin1",
"github_project": "scylla-go-round",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scylla-go-round"
}
JSON
