# Ksconf Splunk CONFiguration tool
This utility handles common Splunk app maintenance tasks in an installable python package.
Specifically, this tool deals with many of the nuances of storing Splunk apps in a
version control system like git and pointing live Splunk apps to a working tree. Merging changes
from the live system's (local) folder to the version controlled (default) folder and dealing with
more than one layer of "default" are all supported tasks which are not native to Splunk.
Tasks like creating new Splunk apps from your local system while merging the 'local' folder into
'default' is also supported.
## Package rename
This package has been renamed [ksconf](https://pypi.org/project/ksconf/) starting with v0.10.
Please switch to this new package using the upgrade steps listed below.
## Suggested upgrade steps:
```sh
pip uninstall kintyre-splunk-conf
pip install ksconf
```
## Who should keep using kintyre-splunk-conf?
For the time being, you can still install and upgrade the latest release of
ksconf using the `kintyre-splunk-conf` package.
Note that as of the v0.10 release, only Python 3.7 and higher are supported.
If you need a version of ksconf that works with Python 2.7 & Python 3.6,
then you should use kintyre-splunk-conf prior to v0.10. We suggest that everyone
else should upgrade to the latest `ksconf` package.
Side note: Attempts to make kintyre-splunk-conf simply install the new ksconf
package under the covers resulted in an unusable deployment. So for now
we are building two identical packages under different names. In the next
minor release you can expect additional onscreen warnings about the package
rename at every invocation.
## Moving on ...
Install with
pip install kintyre-splunk-conf
Confirm installation with the following command:
ksconf --version
To get an overview of all the CLI commands, run:
ksconf --help
Help on specific command, such as 'unarchive', run:
ksconf unarchive --help
Please see the [Official docs](https://ksconf.readthedocs.io/en/latest/) for more info.
Raw data
{
"_id": null,
"home_page": "https://github.com/Kintyre/ksconf",
"name": "kintyre-splunk-conf",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "ksconf splunk kinytre conf tool",
"author": "Lowell Alleman",
"author_email": "lowell@kintyre.co",
"download_url": "",
"platform": null,
"description": "# Ksconf Splunk CONFiguration tool\n\nThis utility handles common Splunk app maintenance tasks in an installable python package.\nSpecifically, this tool deals with many of the nuances of storing Splunk apps in a\nversion control system like git and pointing live Splunk apps to a working tree. Merging changes\nfrom the live system's (local) folder to the version controlled (default) folder and dealing with\nmore than one layer of \"default\" are all supported tasks which are not native to Splunk.\nTasks like creating new Splunk apps from your local system while merging the 'local' folder into\n'default' is also supported.\n\n\n## Package rename\nThis package has been renamed [ksconf](https://pypi.org/project/ksconf/) starting with v0.10.\nPlease switch to this new package using the upgrade steps listed below.\n\n## Suggested upgrade steps:\n```sh\npip uninstall kintyre-splunk-conf\npip install ksconf\n```\n\n## Who should keep using kintyre-splunk-conf?\nFor the time being, you can still install and upgrade the latest release of\nksconf using the `kintyre-splunk-conf` package.\n\nNote that as of the v0.10 release, only Python 3.7 and higher are supported.\nIf you need a version of ksconf that works with Python 2.7 & Python 3.6,\nthen you should use kintyre-splunk-conf prior to v0.10. We suggest that everyone\nelse should upgrade to the latest `ksconf` package.\n\nSide note: Attempts to make kintyre-splunk-conf simply install the new ksconf\npackage under the covers resulted in an unusable deployment. So for now\nwe are building two identical packages under different names. In the next\nminor release you can expect additional onscreen warnings about the package\nrename at every invocation.\n\n## Moving on ...\n\n\nInstall with\n\n pip install kintyre-splunk-conf\n\nConfirm installation with the following command:\n\n ksconf --version\n\nTo get an overview of all the CLI commands, run:\n\n ksconf --help\n\nHelp on specific command, such as 'unarchive', run:\n\n ksconf unarchive --help\n\n\nPlease see the [Official docs](https://ksconf.readthedocs.io/en/latest/) for more info.\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "KSCONF: Ksconf Splunk Configuration Tool",
"version": "0.13.9",
"project_urls": {
"Documentation": "https://ksconf.readthedocs.io/",
"Homepage": "https://github.com/Kintyre/ksconf",
"Splunk app": "https://splunkbase.splunk.com/app/4383/"
},
"split_keywords": [
"ksconf",
"splunk",
"kinytre",
"conf",
"tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc45bd9180c503487234a88e4f659a1669469d6a1e7b2d35810e445670ec8c1e",
"md5": "58d8d4645193f73e041a575915dd133c",
"sha256": "da577aafd9abcbceb2496a13599f21070bdee1a7443cfcba494cebae705ff718"
},
"downloads": -1,
"filename": "kintyre_splunk_conf-0.13.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "58d8d4645193f73e041a575915dd133c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 158295,
"upload_time": "2024-01-04T22:37:28",
"upload_time_iso_8601": "2024-01-04T22:37:28.632683Z",
"url": "https://files.pythonhosted.org/packages/bc/45/bd9180c503487234a88e4f659a1669469d6a1e7b2d35810e445670ec8c1e/kintyre_splunk_conf-0.13.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-04 22:37:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Kintyre",
"github_project": "ksconf",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"appveyor": true,
"requirements": [],
"tox": true,
"lcname": "kintyre-splunk-conf"
}
JSON
