Metadata-Version: 2.1
Name: sqlfluff
Version: 0.2.0
Summary: Modular SQL Linting for Humans
Home-page: https://github.com/alanmcruickshank/sqlfluff
Author: Alan Cruickshank
Author-email: alan@designingoverload.com
License: MIT License
Description: # SqlFluff :scroll: :black_nib: :sparkles:
        ## The SQL Linter for humans
        
        [![PyPi Version](https://img.shields.io/pypi/v/sqlfluff.svg?style=flat-square&logo=PyPi)](https://pypi.org/project/sqlfluff/)
        [![PyPi License](https://img.shields.io/pypi/l/sqlfluff.svg?style=flat-square)](https://pypi.org/project/sqlfluff/)
        [![PyPi Python Verions](https://img.shields.io/pypi/pyversions/sqlfluff.svg?style=flat-square)](https://pypi.org/project/sqlfluff/)
        [![PyPi Status](https://img.shields.io/pypi/status/sqlfluff.svg?style=flat-square)](https://pypi.org/project/sqlfluff/)
        
        [![codecov](https://img.shields.io/codecov/c/gh/alanmcruickshank/sqlfluff.svg?style=flat-square&logo=Codecov)](https://codecov.io/gh/alanmcruickshank/sqlfluff)
        [![Requirements Status](https://img.shields.io/requires/github/alanmcruickshank/sqlfluff.svg?style=flat-square)](https://requires.io/github/alanmcruickshank/sqlfluff/requirements/?branch=master)
        [![CircleCI](https://img.shields.io/circleci/build/gh/alanmcruickshank/sqlfluff/master?style=flat-square&logo=CircleCI)](https://circleci.com/gh/alanmcruickshank/sqlfluff/tree/master)
        [![ReadTheDocs](https://img.shields.io/readthedocs/sqlfluff?style=flat-square&logo=Read%20the%20Docs)](https://sqlfluff.readthedocs.io)
        
        Bored of not having a good SQL linter that works with whichever dialiect you're
        working with? Fluff is an extensible and modular linter designed to help you write
        good SQL and catch errors and bad SQL before it hits your database.
        
        > **Sqlfluff** is still in an open alpha phase - expect the tool to change significantly
        > over the coming months, and expect potentially non-backward compatable api changes
        > to happen at any point. In particular moving from 0.0.x to 0.1.x introduced some
        > non backward compatible changes and potential loss in functionality. If you'd like to
        > help please consider [contributing](CONTRIBUTING.md).
        
        # Getting Started
        
        To get started just install the package, make a sql file and then run sqlfluff and point it at the file.
        
        ```shell
        $ pip install sqlfluff
        $ echo "  SELECT a  +  b FROM tbl;  " > test.sql
        $ sqlfluff lint test.sql
        == [test.sql] FAIL
        L:   1 | P:   1 | L003 | Single indentation uses a number of spaces not a multiple of 4
        L:   1 | P:  14 | L006 | Operators should be surrounded by a single space unless at the start/end of a line
        L:   1 | P:  27 | L001 | Unnecessary trailing whitespace
        ```
        
        # Usage
        
        For more details on usage see the docs on readthedocs [here](http://sqlfluff.readthedocs.io).
        
        # Progress
        
        There's lots to do in this project, and we're just getting started. If you want to understand more
        about the architecture of sqlfluff, you can find [more here](https://sqlfluff.readthedocs.io/en/latest/architecture.html).
        
        - [x] Command line interface
          - [x] Basic linting, both of paths and files
          - [x] Version information
          - [x] Nicely formatted readout of linting success or fail
          - [x] Exit codes which reflect linting success or fail
          - [x] Filtering to particular codes in the linting step
          - [x] Allow basic correction of some linting codes
        - [x] Basic ANSI linting
          - [x] Simple whitespace testing
          - [x] Whitespace around operators
          - [x] Indentation (size and mix of tabs and spaces)
          - [ ] Indentation between lines and when to indent
          - [ ] Number of blank lines
          - [ ] Indentation of comments
          - [x] Inconsistent capitalisation of keywords
          - [ ] Inconsistent capitalisation of unquoted identifiers
          - [x] Implement a context manager in the parse and match
                functions to avoid passing around so many variables.
          - [x] Reenable disabled linter tests
        - [x] Configurable linting
          - [x] Command line options for config
            - [x] Rough parity between command line and file based config
          - [x] Ability to read from config files
            - [x] Documentation of the config loading system
          - [ ] Ability to read config from block comment
                sections in `.sql` files.
          - [x] Ignore particular rules (blacklisting)
          - [x] Specifying particlar dialects to use
          - [x] Specifying particlar templaters to use
          - [x] Preconfiguring verbosity
          - [ ] Delta-configs for individual files printed before each above some
                level of verbosity.
          - [x] Work out a solution to templating *macros*.
          - [x] Allow configuration for *rules*, e.g. indentation multiplier for
                L003 or the capitalisation for the keyword rule.
        - [x] Dialects
          - [ ] ANSI
            - [ ] Implement singleton matching for `::`, `:` and `||`.
            - [ ] Bring in a much wider selection of test queries to identify
                  next gaps.
            - [x] Flesh out function coverage.
          - [ ] MySQL 
          - [ ] Redshift
          - [ ] Snowflake
          - [x] Detecting dialect from a config file of some kind
          - [x] jinja2 compatible linting (for dbt)
            - [x] a preconfigured default set of templating macros for dbt use which can be loaded
                  as config.
          - [ ] Move the configuration of the *lexer* into the dialect.
        - [ ] Documentation
          - [x] Basic architectural principles
          - [ ] Update CLI docs to match current state
          - [x] Auto-document Rules
          - [ ] Auto-document Grammars
          - [ ] Auto-document Templaters
          - [ ] Auto-docuemnt Dialects
        
        
        ---
        
        # Changelog
        
        All notable changes to this project will be documented in this file.
        
        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
        
        ## [0.2.0] - 2019-12-01
        
        ### Added
        
        - Templating support (jinja2, python or raw).
          - Variables + Macros.
          - The `fix` command is also sensitive to fixing over templates
            and will skip certain fixes if it feels that it's conflicted.
        - Config file support, including specifying context for the templater.
        - Documentation via Sphinx and readthedocs.
          - Including a guide on the role of SQL in the real world.
            Assisted by [@barrywhart](https://github.com/barrywhart).
        - Documentation LINTING (given we're a linting project) introduced in CI.
        - Reimplemented L006 & L007 which lint whitespace around operators.
        - Ability to configure rule behaviour direclty from the config file.
        - Implemented L010 to lint capitalisation of keywords.
        - Allow casting in the parser using the `::` operator.
        - Implemented `GROUP BY`and `LIMIT`.
        - Added `ORDER BY` using indexes and expressions.
        - Added parsing of `CASE` statements.
        - Support for window/aggregate functions.
        - Added linting and parsing of alias expressions.
        
        ### Changed
        
        - Fixed a bug which could cause potential infinite recursion in configuration
        - Changed how negative literals are handled, so that they're now a compound segment
          rather than being identified at the lexing stage. This is to allow the parser
          to resolve the potential ambiguity.
        - Restructure of rule definitions to be more streamlined and also enable
          autodocumentation. This includes a more complete `RuleSet` class which now
          holds the filtering code.
        - Corrected logging in fix mode not to duplicate the reporting of errors.
        - Now allows insert statements with a nested `with` clause.
        - Fixed verbose logging during parsing.
        - Allow the `Bracketed` grammar to optionally match empty brackets using
          the optional keyword.
        
        ## [0.1.5] - 2019-11-11
        
        ### Added
        
        - Python 3.8 Support!
        
        ### Changed
        
        - Moved some of the responsibility for formatted logging into the linter to mean that we can
          log progressively in large directories.
        - Fixed a bug in the grammar where one of the return values was messed up.
        
        ## [0.1.4] - 2019-11-10
        
        ### Added
        
        - Added a `--exclude-rules` argument to most of the commands to allow rule users
          to exclude specific subset of rules, by [@sumitkumar1209](https://github.com/sumitkumar1209)
        - Added lexing for `!=`, `~` and `::`.
        - Added a new common segment: `LambdaSegment` which allows matching based on arbitrary
          functions which can be applied to segments.
        - Recursive Expressions for both arithmetic and functions, based heavily off the grammar
          provided by the guys at [CockroachDB](https://www.cockroachlabs.com/docs/stable/sql-grammar.html#select_stmt).
        - An `Anything` grammar, useful in matching rather than in parsing to match anything.
        
        ### Changed
        
        - Complete rewrite of the bracket counting functions, using some centralised class methods
          on the `BaseGrammar` class to support common matching features across multiple grammars.
          In particular this affects the `Delimited` grammar which is now *much simpler* but does
          also require *slightly* more liberal use of terminators to match effectively.
        - Rather than passing around multiple variables during parsing and matching, there is now
          a `ParseContext` object which contains things like the dialect and various depths. This
          simplifies the parsing and matching code significantly.
        - Bracket referencing is now done from the dialect directly, rather than in individual
          Grammars (except the `Bracketed` grammar, which still implements it directly). This
          takes out some originally duplicated code.
        - Corrected the parsing of ordering keywords in and `ORDER BY` clause.
        
        ### Removed
        
        - Removed the `bracket_sensitive_forward_match` method from the `BaseGrammar`. It was ugly
          and not flexible enough. It's been replaced by a suite of methods as described above.
        
        ## [0.1.3] - 2019-10-30
        
        ### Changed
        
        - Tweak to the L001 rule so that it doesn't crash the whole thing.
        
        ## [0.1.2] - 2019-10-30
        
        ### Changed
        
        - Fixed the errors raised by the lexer.
        
        ## [0.1.1] - 2019-10-30
        
        ### Changed
        
        - Fixed which modules from sqlfluff are installed in the setup.py. This affects
          the `version` command.
        
        ## [0.1.0] - 2019-10-29
        
        ### Changed
        
        - *Big Rewrite - some loss in functionality might be apparent compared
          to pre-0.1.0. Please submit any major problems as issues on github*
        - Changed unicode handling for better escape codes in python 2.
          Thanks [@mrshu](https://github.com/mrshu)
        - BIG rewrite of the parser, completely new architecture. This introduces
          breaking changes and some loss of functionality while we catch up.
          - In particular, matches now return partial matches to speed up parsing.
          - The `Delimited` matcher has had a significant re-write with a major
            speedup and broken the dependency on `Sequence`.
          - Rewrite of `StartsWith` and `Sequence` to use partial matches properly.
          - Different treatment of numeric literals.
          - Both `Bracketed` and `Delimited` respect bracket counting.
          - MASSIVE rewrite of `Bracketed`.
        - Grammars now have timers.
        - Joins properly parsing,
        - Rewrite of logging to selectively output commands at different levels
          of verbosity. This uses the `verbosity_logger` method.
        - Added a command line `sqlfluff parse` option which runs just the parsing step
          of the process to better understand how a file is being parsed. This also
          has options to configure how deep we recurse.
        - Complete Re-write of the rules section, implementing new `crawlers` which
          implement the linting rules. Now with inbuilt fixers in them.
        - Old rules removed and re implemented so we now have parity with the old rule sets.
        - Moved to using Ref mostly within the core grammar so that we can have recursion.
        - Used recursion to do a first implementation of arithmetic parsing. Including a test for it.
        - Moved the main grammar into a seperate dialect and renamed source and test files accordingly.
        - Moved to file-based tests for the ansi dialect to make it easier to test using the tool directly.
        - As part of file tests - expected outcomes are now encoded in yaml to make it easier to write new tests.
        - Vastly improved readability and debugging potential of the _match logging.
        - Added support for windows line endings in the lexer.
        
        ## [0.0.7] - 2018-11-19
        
        ### Added
        
        - Added a `sqlfluff fix` as a command to implement auto-fixing of linting
          errors. For now only `L001` is implemented as a rule that can fix things.
        - Added a `rules` command to introspect the available rules.
        - Updated the cli table function to use the `testwrap` library and also
          deal a lot better with longer values.
        - Added a `--rules` argument to most of the commands to allow rule users
          to focus their search on a specific subset of rules.
        
        ### Changed
        
        - Refactor the cli tests to use the click CliRunner. Much faster
        
        ## [0.0.6] - 2018-11-15
        
        ### Added
        
        - Number matching
        
        ### Changed
        
        - Fixed operator parsing and linting (including allowing the exception of `(*)`)
        
        ## [0.0.5] - 2018-11-15
        
        ### Added
        
        - Much better documentation including the DOCS.md
        
        ### Changed
        
        - Fixed comma parsing and linting
        
        ## [0.0.4] - 2018-11-14
        
        ### Added
        
        - Added operator regexes
        - Added a priority for matchers to resolve some ambiguity
        - Added tests for operator regexes
        - Added ability to initialise the memory in rules
        
        ## [0.0.3] - 2018-11-14
        
        ### Added
        
        - Refactor of rules to allow rules with memory
        - Adding comma linting rules (correcting the single character matchers)
        - Adding mixed indentation linting rules
        - Integration with CircleCI, CodeCov and lots of badges
        
        ### Changed
        
        - Changed import of version information to fix bug with importing config.ini
        - Added basic violations/file reporting for some verbosities
        - Refactor of rules to simplify definition
        - Refactor of color cli output to make it more reusable
        
        ## [0.0.2] - 2018-11-09
        
        ### Added
        
        - Longer project description
        - Proper exit codes
        - colorama for colored output
        
        ### Changed
        
        - Significant CLI changes
        - Much improved output from CLI
        
        ## [0.0.1] - 2018-11-07
        
        ### Added
        
        - Initial Commit! - VERY ALPHA
        - Restructure into [package layout](https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure)
        - Adding Tox and Pytest so that they work
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
