# Salt Extension for Consul
Salt Extension for interacting with Consul
## Security
If you think you've found a security vulnerability, see
[Salt's security guide][security].
## User Documentation
This README is for people aiming to contribute to the project.
If you just want to get started with the extension, check out the
module docstrings (for now, documentation is coming!).
## Contributing
The saltext-consul project team welcomes contributions from the community.
The [Salt Contributing guide][salt-contributing] has a lot of relevant
information, but if you'd like to jump right in here's how to get started:
```bash
# Clone the repo
git clone --origin salt git@github.com:salt-extensions/saltext-consul.git
# Change to the repo dir
cd saltext-consul
# Create a new venv
python3 -m venv env --prompt saltext-consul
source env/bin/activate
# On mac, you may need to upgrade pip
python -m pip install --upgrade pip
# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant
# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e '.[tests,dev,docs]'
# Run tests!
python -m nox -e tests-3
# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1
# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)
```
Writing code isn't the only way to contribute! We value contributions in any of
these areas:
* Documentation - especially examples of how to use this module to solve
specific problems.
* Triaging [issues][issues] and participating in [discussions][discussions]
* Reviewing [Pull Requests][PRs] (we really like
[Conventional Comments][comments]!)
You could also contribute in other ways:
* Writing blog posts
* Posting on social media about how you used Salt+Consul to solve your
problems, including videos
* Giving talks at conferences
* Publishing videos
* Asking/answering questions in IRC, Slack, or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
For more information, build the docs and head over to http://localhost:8000/ —
that's where you'll find the rest of the documentation.
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html
[issues]: https://github.com/salt-extensions/saltext-consul/issues
[PRs]: https://github.com/salt-extensions/saltext-consul/pulls
[discussions]: https://github.com/salt-extensions/saltext-consul/discussions
[comments]: https://conventionalcomments.org/
Raw data
{
"_id": null,
"home_page": "",
"name": "saltext.consul",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "salt-extension",
"author": "",
"author_email": "\"EITR Technologies, LLC\" <eitr@devops.tech>",
"download_url": "https://files.pythonhosted.org/packages/b4/06/732721eb484e26475d2c34a18933e07274786c80230ba46e46031df3da9c/saltext.consul-1.1.0.tar.gz",
"platform": "any",
"description": "# Salt Extension for Consul\n\nSalt Extension for interacting with Consul\n\n## Security\n\nIf you think you've found a security vulnerability, see\n[Salt's security guide][security].\n\n## User Documentation\n\nThis README is for people aiming to contribute to the project.\nIf you just want to get started with the extension, check out the\nmodule docstrings (for now, documentation is coming!).\n\n## Contributing\n\nThe saltext-consul project team welcomes contributions from the community.\n\nThe [Salt Contributing guide][salt-contributing] has a lot of relevant\ninformation, but if you'd like to jump right in here's how to get started:\n\n\n```bash\n# Clone the repo\ngit clone --origin salt git@github.com:salt-extensions/saltext-consul.git\n\n# Change to the repo dir\ncd saltext-consul\n\n# Create a new venv\npython3 -m venv env --prompt saltext-consul\nsource env/bin/activate\n\n# On mac, you may need to upgrade pip\npython -m pip install --upgrade pip\n\n# On WSL or some flavors of linux you may need to install the `enchant`\n# library in order to build the docs\nsudo apt-get install -y enchant\n\n# Install extension + test/dev/doc dependencies into your environment\npython -m pip install -e '.[tests,dev,docs]'\n\n# Run tests!\npython -m nox -e tests-3\n\n# skip requirements install for next time\nexport SKIP_REQUIREMENTS_INSTALL=1\n\n# Build the docs, serve, and view in your web browser:\npython -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)\n```\n\nWriting code isn't the only way to contribute! We value contributions in any of\nthese areas:\n\n* Documentation - especially examples of how to use this module to solve\n specific problems.\n* Triaging [issues][issues] and participating in [discussions][discussions]\n* Reviewing [Pull Requests][PRs] (we really like\n [Conventional Comments][comments]!)\n\nYou could also contribute in other ways:\n\n* Writing blog posts\n* Posting on social media about how you used Salt+Consul to solve your\n problems, including videos\n* Giving talks at conferences\n* Publishing videos\n* Asking/answering questions in IRC, Slack, or email groups\n\nAny of these things are super valuable to our community, and we sincerely\nappreciate every contribution!\n\n\nFor more information, build the docs and head over to http://localhost:8000/ \u2014\nthat's where you'll find the rest of the documentation.\n\n\n[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md\n[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html\n[issues]: https://github.com/salt-extensions/saltext-consul/issues\n[PRs]: https://github.com/salt-extensions/saltext-consul/pulls\n[discussions]: https://github.com/salt-extensions/saltext-consul/discussions\n[comments]: https://conventionalcomments.org/\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Extension for interacting with Consul",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/salt-extensions/saltext-consul",
"Source": "https://github.com/salt-extensions/saltext-consul",
"Tracker": "https://github.com/salt-extensions/saltext-consul/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b409318bc09510b53c24ba52be443279d1bbeee2807f0900f9d2fa6f8eddc38",
"md5": "cd3303c4b9e4963892b8a60e9437095f",
"sha256": "815e7787261bf2b01dc775350d1ef622c5d32e5cdfc74b775bdf678bec22e58e"
},
"downloads": -1,
"filename": "saltext.consul-1.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd3303c4b9e4963892b8a60e9437095f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 27628,
"upload_time": "2024-02-15T23:05:31",
"upload_time_iso_8601": "2024-02-15T23:05:31.657409Z",
"url": "https://files.pythonhosted.org/packages/8b/40/9318bc09510b53c24ba52be443279d1bbeee2807f0900f9d2fa6f8eddc38/saltext.consul-1.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b406732721eb484e26475d2c34a18933e07274786c80230ba46e46031df3da9c",
"md5": "384c665395b341556c365bedcf453770",
"sha256": "7a32a66b948cf96e1c93ab0937d6b63ab800c8b942bb39a55e1aececf4e7f49c"
},
"downloads": -1,
"filename": "saltext.consul-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "384c665395b341556c365bedcf453770",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 64248,
"upload_time": "2024-02-15T23:05:32",
"upload_time_iso_8601": "2024-02-15T23:05:32.940606Z",
"url": "https://files.pythonhosted.org/packages/b4/06/732721eb484e26475d2c34a18933e07274786c80230ba46e46031df3da9c/saltext.consul-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 23:05:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "salt-extensions",
"github_project": "saltext-consul",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "saltext.consul"
}
JSON
