| Name | sqlfluff-py JSON |
| Version |
1.0.0a0
JSON |
| download |
| home_page | None |
| Summary | SQLFluff for python script |
| upload_time | 2025-08-17 08:13:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License
Copyright (c) 2025 Katsuya Horiuchi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
sqlfluff
sql
linter
formatter
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sqlfluff_py
SQLFluff for python script
> [!WARNING]
> This project is in alpha stage.
> Using the tool may cause unreversable changes in python code.
## Installation
```python
$ pip install sqlfluff_py
```
## Usage
You can use CLI tool from terminal.
When using the tool, you must specify the following:
* `-i` for input file
* `-d` for dialect (See sqlfluff's documentation for available dialects)
* `-p` for regex pattern to identify variables for query
```bash
$ sqlfluff_py -i your_script.py -d ansi -p query
```
Optionally you can specify `-o` for output file, in case you would like to
keep the original file.
By default the input file will be overwritten.
```bash
$ sqlfluff_py -i your_script.py -d ansi -p query -o fixed_script.py
```
## TODO
* Handle tokens' position properly
* Read configuration from `pyproject.toml`
* Make yaml for pre-commit
Raw data
{
"_id": null,
"home_page": null,
"name": "sqlfluff-py",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sqlfluff, sql, linter, formatter",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3c/2c/19e2fe6099d7938ed0a0ef5def6ec5da9b3f30374c6f91f76211f6565790/sqlfluff_py-1.0.0a0.tar.gz",
"platform": null,
"description": "# sqlfluff_py\n\nSQLFluff for python script\n\n\n> [!WARNING]\n> This project is in alpha stage.\n> Using the tool may cause unreversable changes in python code.\n\n\n## Installation\n\n```python\n$ pip install sqlfluff_py\n```\n\n## Usage\n\nYou can use CLI tool from terminal.\n\nWhen using the tool, you must specify the following:\n* `-i` for input file\n* `-d` for dialect (See sqlfluff's documentation for available dialects)\n* `-p` for regex pattern to identify variables for query\n\n\n```bash\n$ sqlfluff_py -i your_script.py -d ansi -p query\n```\n\nOptionally you can specify `-o` for output file, in case you would like to\nkeep the original file.\nBy default the input file will be overwritten.\n\n```bash\n$ sqlfluff_py -i your_script.py -d ansi -p query -o fixed_script.py\n```\n\n\n## TODO\n\n* Handle tokens' position properly\n* Read configuration from `pyproject.toml`\n* Make yaml for pre-commit\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Katsuya Horiuchi\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "SQLFluff for python script",
"version": "1.0.0a0",
"project_urls": null,
"split_keywords": [
"sqlfluff",
" sql",
" linter",
" formatter"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4e4c24b4266ea25c279903c483c8eb8ef8726e9fde3eb93199a195eed0749f03",
"md5": "b36423714fcc89e9202d3a7a33dd38c1",
"sha256": "1a04e151128c94eb0d8c2ef0ee0122d4b0f4e31bbf4a0a6ee6de9ed6b6e9fa62"
},
"downloads": -1,
"filename": "sqlfluff_py-1.0.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b36423714fcc89e9202d3a7a33dd38c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8897,
"upload_time": "2025-08-17T08:13:31",
"upload_time_iso_8601": "2025-08-17T08:13:31.522753Z",
"url": "https://files.pythonhosted.org/packages/4e/4c/24b4266ea25c279903c483c8eb8ef8726e9fde3eb93199a195eed0749f03/sqlfluff_py-1.0.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3c2c19e2fe6099d7938ed0a0ef5def6ec5da9b3f30374c6f91f76211f6565790",
"md5": "eefab592cc77b230ffd49d7547d04bd7",
"sha256": "ed14a61e602e926eab3b7abc966d08af53d3a7748f5c9dcbdb061275c919f1d5"
},
"downloads": -1,
"filename": "sqlfluff_py-1.0.0a0.tar.gz",
"has_sig": false,
"md5_digest": "eefab592cc77b230ffd49d7547d04bd7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8325,
"upload_time": "2025-08-17T08:13:32",
"upload_time_iso_8601": "2025-08-17T08:13:32.935336Z",
"url": "https://files.pythonhosted.org/packages/3c/2c/19e2fe6099d7938ed0a0ef5def6ec5da9b3f30374c6f91f76211f6565790/sqlfluff_py-1.0.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-17 08:13:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sqlfluff-py"
}
