# AxoSyslog CFG Helper
This tool makes configuring [AxoSyslog](https://github.com/axoflow/axosyslog) a bit easier by listing the options of each available driver.
The options are generated from [AxoSyslog v4.9.0](https://github.com/axoflow/axosyslog/releases/tag/axosyslog-4.9.0).
## Quickstart
### Install with pipx
```
pipx install axosyslog-cfg-helper
```
### Or pull the container image
```
docker pull ghcr.io/alltilla/axosyslog-cfg-helper
```
### List the contexts
```
axosyslog-cfg-helper
```
### List the drivers in a context
```
axosyslog-cfg-helper --context parser
```
### List the options of a driver
```
axosyslog-cfg-helper --context parser --driver csv-parser
```
### Example
[](https://raw.githubusercontent.com/alltilla/axosyslog-cfg-helper/assets/example.gif)
## Development
The tool is still in development, but most of the drivers are supported.
Missing features are:
* Proper `rewrite` support.
* Proper `filter` support.
* Drivers defined in `SCL`s.
* Drivers defined with confgen.
Any contribution is welcome :)
### Local setup
The project uses [poetry](https://python-poetry.org/) as a dependency management system.
Building of the option database needs the [neologism](https://github.com/alltilla/neologism) pip package, which gets installed by poetry, however it has another dependency, which is [bison](https://www.gnu.org/software/bison/). Make sure to install bison (at least 3.7.6) on you system if you wan't to develop locally. `make bison` can help with that.
The [Makefile](https://github.com/alltilla/axosyslog-cfg-helper/blob/master/Makefile) consists of some useful commands:
* `make venv` prepares the venv.
* `make bison` downloads bison 3.7.6, builds it and installs it under `/usr/local`.
* You can change the install path with `make bison BISON_INSTALL_PATH=...`
* `make check` runs the unit tests, style-checkers and linters.
* `make format` formats the code.
* `make db` downloads the axosyslog release tarball and generates the option database.
* `make db AXOSYSLOG_SOURCE_DIR=/path/to/axosyslog` creates a tarball from the state of the axosyslog source dir and generates the option database.
* `make package` creates the pip package.
## Community
You can reach out to the AxoSyslog community on Discord:
[](https://discord.gg/E65kP9aZGm)
Raw data
{
"_id": null,
"home_page": "https://github.com/alltilla/axosyslog-cfg-helper",
"name": "axosyslog-cfg-helper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "axosyslog, configuration, cfg",
"author": "Attila Szakacs",
"author_email": "szakacs.attila96@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/f0/8ac687f12332acea2aec4629f7e1bf3e4eeb2165925a7e315d6ef222e8bf/axosyslog_cfg_helper-1.11.2.tar.gz",
"platform": null,
"description": "# AxoSyslog CFG Helper\n\nThis tool makes configuring [AxoSyslog](https://github.com/axoflow/axosyslog) a bit easier by listing the options of each available driver.\n\nThe options are generated from [AxoSyslog v4.9.0](https://github.com/axoflow/axosyslog/releases/tag/axosyslog-4.9.0).\n\n## Quickstart\n\n### Install with pipx\n```\npipx install axosyslog-cfg-helper\n```\n\n### Or pull the container image\n```\ndocker pull ghcr.io/alltilla/axosyslog-cfg-helper\n```\n\n### List the contexts\n```\naxosyslog-cfg-helper\n```\n\n### List the drivers in a context\n```\naxosyslog-cfg-helper --context parser\n```\n\n### List the options of a driver\n```\naxosyslog-cfg-helper --context parser --driver csv-parser\n```\n\n### Example\n[](https://raw.githubusercontent.com/alltilla/axosyslog-cfg-helper/assets/example.gif)\n\n## Development\nThe tool is still in development, but most of the drivers are supported.\n\nMissing features are:\n * Proper `rewrite` support.\n * Proper `filter` support.\n * Drivers defined in `SCL`s.\n * Drivers defined with confgen.\n\nAny contribution is welcome :)\n\n### Local setup\nThe project uses [poetry](https://python-poetry.org/) as a dependency management system.\n\nBuilding of the option database needs the [neologism](https://github.com/alltilla/neologism) pip package, which gets installed by poetry, however it has another dependency, which is [bison](https://www.gnu.org/software/bison/). Make sure to install bison (at least 3.7.6) on you system if you wan't to develop locally. `make bison` can help with that.\n\nThe [Makefile](https://github.com/alltilla/axosyslog-cfg-helper/blob/master/Makefile) consists of some useful commands:\n * `make venv` prepares the venv.\n * `make bison` downloads bison 3.7.6, builds it and installs it under `/usr/local`.\n * You can change the install path with `make bison BISON_INSTALL_PATH=...`\n * `make check` runs the unit tests, style-checkers and linters.\n * `make format` formats the code.\n * `make db` downloads the axosyslog release tarball and generates the option database.\n * `make db AXOSYSLOG_SOURCE_DIR=/path/to/axosyslog` creates a tarball from the state of the axosyslog source dir and generates the option database.\n * `make package` creates the pip package.\n\n## Community\nYou can reach out to the AxoSyslog community on Discord:\n\n[](https://discord.gg/E65kP9aZGm)\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Configuration helper for axosyslog.",
"version": "1.11.2",
"project_urls": {
"Homepage": "https://github.com/alltilla/axosyslog-cfg-helper",
"Repository": "https://github.com/alltilla/axosyslog-cfg-helper"
},
"split_keywords": [
"axosyslog",
" configuration",
" cfg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5532d74270b9b4192b546153055c80f05fadde86868eff726d92c015870d4ec6",
"md5": "74fc5e0204c9ff5ea45a74fe96ad9266",
"sha256": "8d5d81890239859ec7f839ac020816e3bab56de215662f12c93c9fd0a6469e95"
},
"downloads": -1,
"filename": "axosyslog_cfg_helper-1.11.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74fc5e0204c9ff5ea45a74fe96ad9266",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 57463,
"upload_time": "2024-11-11T14:44:57",
"upload_time_iso_8601": "2024-11-11T14:44:57.014517Z",
"url": "https://files.pythonhosted.org/packages/55/32/d74270b9b4192b546153055c80f05fadde86868eff726d92c015870d4ec6/axosyslog_cfg_helper-1.11.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "baf08ac687f12332acea2aec4629f7e1bf3e4eeb2165925a7e315d6ef222e8bf",
"md5": "eb4000b83e5d39832eb6fd9a1c34b6e7",
"sha256": "7247bd23a5be27abf1583782e4f546ef1023f8d4650c1960844339ecc2c6be6b"
},
"downloads": -1,
"filename": "axosyslog_cfg_helper-1.11.2.tar.gz",
"has_sig": false,
"md5_digest": "eb4000b83e5d39832eb6fd9a1c34b6e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 41227,
"upload_time": "2024-11-11T14:44:58",
"upload_time_iso_8601": "2024-11-11T14:44:58.133705Z",
"url": "https://files.pythonhosted.org/packages/ba/f0/8ac687f12332acea2aec4629f7e1bf3e4eeb2165925a7e315d6ef222e8bf/axosyslog_cfg_helper-1.11.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 14:44:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alltilla",
"github_project": "axosyslog-cfg-helper",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "axosyslog-cfg-helper"
}
JSON
