{"id":13642679,"url":"https://github.com/kotlaluk/spl-parser","last_synced_at":"2025-04-20T20:32:24.780Z","repository":{"id":55801518,"uuid":"225947951","full_name":"kotlaluk/spl-parser","owner":"kotlaluk","description":"Parser for Splunk's Search Processing Language (SPL) syntax highlighting","archived":false,"fork":false,"pushed_at":"2020-01-31T22:10:29.000Z","size":414,"stargazers_count":17,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-09T14:38:08.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kotlaluk.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-04T20:07:40.000Z","updated_at":"2024-10-16T19:34:20.000Z","dependencies_parsed_at":"2022-08-15T07:10:32.711Z","dependency_job_id":null,"html_url":"https://github.com/kotlaluk/spl-parser","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kotlaluk%2Fspl-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kotlaluk%2Fspl-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kotlaluk%2Fspl-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kotlaluk%2Fspl-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kotlaluk","download_url":"https://codeload.github.com/kotlaluk/spl-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249958852,"owners_count":21351726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T01:01:34.837Z","updated_at":"2025-04-20T20:32:24.286Z","avatar_url":"https://github.com/kotlaluk.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"SPL Parser\n==========\n\nSPL Parser is a command-line application for parsing of Splunk’s Search\nProcessing Language (SPL). The main feature of SPL Parser is the ability to\ngenerate a tmLanguage grammar for SPL, which can be used in various text editors\nfor syntax highlighting of SPL. SPL Parser is also able to interactively view\ndetails about any SPL command.\n\nFeatures\n--------\n\n- Generate tmLanguage grammar for SPL that can be used for syntax highlighting\n- View details about any SPL command\n- Use a remote Splunk server or local files\n\nInstallation\n------------\n\nThe project can be installed using pip from TestPyPI::\n\n    pip install --extra-index-url https://test.pypi.org/pypi spl_parser\n\nOr by cloning GitHub repository::\n\n    git clone https://github.com/kotlaluk/spl-parser\n\nand running::\n\n    python setup.py install\n\nUsage\n-----\n\nThe SPL Parser CLI application can be invoked by running ``spl_parser``.\nTo view help run::\n\n    spl_parser --help\n\nSPL Parser can work either with a **remote** Splunk server or a **local**\nsearchbnf file. The remote server is specified by URL, the local file by its\nname and path. Note that the local searchbnf file must be in ``.conf`` or\n``.json`` format.\n\nIf case of a **remote** Splunk server, the user will be prompted for providing\ncredentials for authentication. Alternatively, these credentials can be provided\nby setting ``SPLUNK_USERNAME`` and ``SPLUNK_PASSWORD`` environment variables.\n\nIn both cases, the application allows to **view** details about a particlular\nSPL command or **generate** a tmLanguage grammar file.\n\nIf using **view** command, the command name is expected as argument. The command\ndetails are then retrieved and displayed in the console.\n\nExample of **view** invocation in **remote** mode::\n\n    spl_parser remote https://localhost:8089 view transaction\n\nIf using **generate** command, a tmLanguage grammar will be generated and saved\nin the file ``spl.tmLanguage.json``. Alternatively, a file name can be specified\nby using ``--outfile`` option. The generated grammar file can then be used\nwith a text editor for syntax highlighting of SPL.\n\nExample **generate** invocation in **local** mode::\n\n    spl_parser local examples/searchbnf.conf generate\n\nSyntax highlighting\n-------------------\n\nThis repository contains a prepared extension for VSCode text editor. All you\nneed is to copy the generated grammar file ``spl.tmLanguage.json`` into the\nfolder of the extension ``spl-highlighter/syntaxes``, and copy the extension\nfolder into your installation of VSCode (typically ``~/.vscode/extensions``).\n\nNew files with ``.spl`` file extension will automatically provide syntax\nhighlighting for Splunk queries. The extension allows also to set \"SPL Theme\"\nwith colors similar to those in Splunk Web interface.\n\nTesting\n-------\n\nThe project contains a bundle of tests.\n\nThese can be invoked by running::\n\n    python setup.py test\n\nDocumentation\n-------------\n\nDocumentation of the project is available at\n`Read the Docs \u003chttps://spl_parser.readthedocs.io\u003e`_.\n\nTo build the documentation manually::\n\n   cd docs\n   make html\n\nand open the file ``docs/_build/html/index.html`` in a web browser.\n\nAuthor\n------\n\nLukáš Kotlaba (lukas.kotlaba@gmail.com)\n\nLicense\n-------\n\nThe project is licensed under GNU General Public License v3.0.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkotlaluk%2Fspl-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkotlaluk%2Fspl-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkotlaluk%2Fspl-parser/lists"}