# Salt Extension for Cassandra
Salt Extension for interacting with Cassandra
## Security
If you discover a security vulnerability, please refer
to [Salt's security guide][security].
## User Documentation
For setup and usage instructions, please refer to the
module docstrings (for now, documentation is coming!).
## Contributing
The saltext-cassandra project welcomes contributions from anyone!
The [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects
of Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],
[writing documentation][writing-docs] and [rendering the docs][rendering-docs].
### Quickstart
To get started contributing, first clone this repository (or your fork):
```bash
# Clone the repo
git clone --origin upstream git@github.com:salt-extensions/saltext-cassandra.git
# Change to the repo dir
cd saltext-cassandra
```
#### Automatic
If you have installed [direnv][direnv], allowing the project's `.envrc` ensures
a proper development environment is present and the virtual environment is active.
Without `direnv`, you can still run the automation explicitly:
```bash
python3 tools/initialize.py
source .venv/bin/activate
```
#### Manual
Please follow the [first steps][first-steps], skipping the repository initialization and first commit.
### Pull request
Always make changes in a feature branch:
```bash
git switch -c my-feature-branch
```
To [submit a Pull Request][submitting-pr], you'll need a fork of this repository in
your own GitHub account. If you followed the instructions above,
set your fork as the `origin` remote now:
```bash
git remote add origin git@github.com:<your_fork>.git
```
Ensure you followed the [first steps][first-steps] and commit your changes, fixing any
failing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.
### Ways to contribute
Contributions come in many forms, and they’re all valuable! Here are some ways you can help
without writing code:
* **Documentation**: Especially examples showing how to use this project
to solve specific problems.
* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].
* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].
You can also contribute by:
* Writing blog posts
* Sharing your experiences using Salt + Cassandra
on social media
* Giving talks at conferences
* Publishing videos
* Engaging in IRC, Discord or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/
[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html
[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html
[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html
[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html
[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment
[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[direnv]: https://direnv.net
[issues]: https://github.com/salt-extensions/saltext-cassandra/issues
[PRs]: https://github.com/salt-extensions/saltext-cassandra/pulls
[discussions]: https://github.com/salt-extensions/saltext-cassandra/discussions
[comments]: https://conventionalcomments.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "saltext.cassandra",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11,>=3.10",
"maintainer_email": null,
"keywords": "salt-extension",
"author": null,
"author_email": "David Murphy <david-dm.murphy@broadcom.com>",
"download_url": "https://files.pythonhosted.org/packages/79/9f/e3add1b247bf193afaa89e05ceb84b440dc14d9b020ce25ca740a5d53db1/saltext_cassandra-0.0.1.tar.gz",
"platform": "any",
"description": "# Salt Extension for Cassandra\n\nSalt Extension for interacting with Cassandra\n\n## Security\n\nIf you discover a security vulnerability, please refer\nto [Salt's security guide][security].\n\n## User Documentation\n\nFor setup and usage instructions, please refer to the\nmodule docstrings (for now, documentation is coming!).\n\n## Contributing\n\nThe saltext-cassandra project welcomes contributions from anyone!\n\nThe [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects\nof Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],\n[writing documentation][writing-docs] and [rendering the docs][rendering-docs].\n\n### Quickstart\n\nTo get started contributing, first clone this repository (or your fork):\n\n```bash\n# Clone the repo\ngit clone --origin upstream git@github.com:salt-extensions/saltext-cassandra.git\n\n# Change to the repo dir\ncd saltext-cassandra\n```\n\n#### Automatic\nIf you have installed [direnv][direnv], allowing the project's `.envrc` ensures\na proper development environment is present and the virtual environment is active.\n\nWithout `direnv`, you can still run the automation explicitly:\n\n```bash\npython3 tools/initialize.py\nsource .venv/bin/activate\n```\n\n#### Manual\nPlease follow the [first steps][first-steps], skipping the repository initialization and first commit.\n\n### Pull request\n\nAlways make changes in a feature branch:\n\n```bash\ngit switch -c my-feature-branch\n```\n\nTo [submit a Pull Request][submitting-pr], you'll need a fork of this repository in\nyour own GitHub account. If you followed the instructions above,\nset your fork as the `origin` remote now:\n\n```bash\ngit remote add origin git@github.com:<your_fork>.git\n```\n\nEnsure you followed the [first steps][first-steps] and commit your changes, fixing any\nfailing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.\n\n### Ways to contribute\n\nContributions come in many forms, and they\u2019re all valuable! Here are some ways you can help\nwithout writing code:\n\n* **Documentation**: Especially examples showing how to use this project\n to solve specific problems.\n* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].\n* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].\n\nYou can also contribute by:\n\n* Writing blog posts\n* Sharing your experiences using Salt + Cassandra\n on social media\n* Giving talks at conferences\n* Publishing videos\n* Engaging in IRC, Discord or email groups\n\nAny of these things are super valuable to our community, and we sincerely\nappreciate every contribution!\n\n[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md\n[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/\n[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html\n[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html\n[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html\n[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html\n[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment\n[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork\n[direnv]: https://direnv.net\n[issues]: https://github.com/salt-extensions/saltext-cassandra/issues\n[PRs]: https://github.com/salt-extensions/saltext-cassandra/pulls\n[discussions]: https://github.com/salt-extensions/saltext-cassandra/discussions\n[comments]: https://conventionalcomments.org/\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Extension for interacting with Cassandra",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/salt-extensions/saltext-cassandra",
"Source": "https://github.com/salt-extensions/saltext-cassandra",
"Tracker": "https://github.com/salt-extensions/saltext-cassandra/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41380e99da427720fa384e1deb0e15f736a824ded721519e284717bf9bef8816",
"md5": "fefa89ca6ad77961a450a3b68cbfaef2",
"sha256": "d087f17a1547adae64100b0bf5f1b8afbbdc9241be64a8906414b337f8fff4f2"
},
"downloads": -1,
"filename": "saltext.cassandra-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "fefa89ca6ad77961a450a3b68cbfaef2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<3.11,>=3.10",
"size": 22450,
"upload_time": "2024-12-13T23:32:35",
"upload_time_iso_8601": "2024-12-13T23:32:35.554535Z",
"url": "https://files.pythonhosted.org/packages/41/38/0e99da427720fa384e1deb0e15f736a824ded721519e284717bf9bef8816/saltext.cassandra-0.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "799fe3add1b247bf193afaa89e05ceb84b440dc14d9b020ce25ca740a5d53db1",
"md5": "ba50e999dbb96e4fe32bf6467a7b5f48",
"sha256": "6b87ce664401c9d34e781b0cfa53bb3720c4973590a5899d977f4033c880c14d"
},
"downloads": -1,
"filename": "saltext_cassandra-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ba50e999dbb96e4fe32bf6467a7b5f48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.10",
"size": 70999,
"upload_time": "2024-12-13T23:32:38",
"upload_time_iso_8601": "2024-12-13T23:32:38.360394Z",
"url": "https://files.pythonhosted.org/packages/79/9f/e3add1b247bf193afaa89e05ceb84b440dc14d9b020ce25ca740a5d53db1/saltext_cassandra-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 23:32:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "salt-extensions",
"github_project": "saltext-cassandra",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "saltext.cassandra"
}
JSON
