Metadata-Version: 2.1
Name: sqlLinter
Version: 0.0.22
Summary: Python util function for plsql
Home-page: https://github.com/walshdanny700/sqlLinter
Author: Danny Walsh
Author-email: walshdanny700@gmail.com
License: UNKNOWN
Description: sqlLinter
        =========================
        |build-status| |coverage| |docs| |pypi| |version|
        
        A Linter tool for SQL
        
        Getting Started
        ================
        These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
        
        Prerequisites
        ================
        Requires Python 3.6 or higher
        
        Installing
        ================
        .. code:: python
        
            pip install sqlLinter
        
        Usage
        ================
        
        walk_pkg_gen
        -------------------
        
        The function walk_pkg_gen is a generator that yields pathobject of any file
        that has the extensions pkb(package body) or pks(package specification).
        The following example is how to use walk_pkg_gen
        
        .. code:: python
        
            from sqlLinter.plsql_util import walk_pkg_gen
            import pathlib
        
            directory = pathlib.Path.cwd()
            for pathObject in walk_pkg_gen(directory)
                # use pathObject
        
        
        missing_slash_in_pkg
        ----------------------------
        
        The function missing_slash_in_pkg is a generator that yields a pathobject of package files
        that are missing the slash '/' as last character in either package spec or package body.
        
        .. code:: python
        
            from sqlLinter.plsql_util import missing_slash_in_pkg
            import pathlib
        
            directory = pathlib.Path.cwd()
            for pathObject in missing_slash_in_pkg(directory)
                # use pathObject
        
        
        commits_in_package
        ----------------------------
        
        The function commits_in_package is a generator that yields a path object of package body files
        that contain a commit in their code.
        
        .. code:: python
        
            from sqlLinter.plsql_util import commits_in_package
            import pathlib
        
            directory = pathlib.Path.cwd()
            for pathObject in commits_in_package(directory)
                # use pathObject
        
        
        License
        ================
        This project is licensed under the MIT License
        
        .. |build-status| image:: https://travis-ci.com/walshdanny700/python_util_for_plsql.svg?branch=master
            :alt: build status
            :scale: 100%
            :target: https://travis-ci.com/walshdanny700/python_util_for_plsql
        
        .. |coverage| image:: https://coveralls.io/repos/github/walshdanny700/python_util_for_plsql/badge.svg?branch=master
            :alt: Documentation Status
            :scale: 100%
            :target: https://coveralls.io/github/walshdanny700/python_util_for_plsql?branch=master
        
        .. |docs| image:: https://readthedocs.org/projects/pip/badge/?version=latest
            :alt: Documentation Status
            :scale: 100%
            :target: https://readthedocs.org/projects/pip/badge/
        
        .. |pypi| image:: https://badge.fury.io/py/plsqlutil.svg
            :alt: Documentation Status
            :scale: 100%
            :target: https://badge.fury.io/py/plsqlutil
        
        .. |version| image:: https://img.shields.io/pypi/pyversions/plsqlutil.svg
            :alt: Documentation Status
            :scale: 100%
            :target: https://pypi.python.org/pypi/plsqlutil
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/x-rst
