Metadata-Version: 1.2
Name: flake8-illegal-import
Version: 0.1.0
Summary: illegal import detector, plugin for flake8
Home-page: https://github.com/bagerard/flake8-illegal-import
Maintainer: Bastien Gérard
Maintainer-email: bastien.gerard@gmail.com
License: MIT License
Description: Illegal import checker
        ===============================
        
        .. image:: https://travis-ci.com/bagerard/flake8-illegal-import.svg?branch=master
           :alt: Build Status
           :target: https://travis-ci.com/bagerard/flake8-illegal-import
        
        .. image:: http://codecov.io/github/bagerard/flake8-illegal-import/coverage.svg?branch=master
           :alt: Coverage Status
           :target: http://codecov.io/github/bagerard/flake8-illegal-import?branch=master
        
        An extension for `Flake8 <https://pypi.python.org/pypi/flake8>`_ to make sure
        that certain packages aren't imported in a directory
        
        
        Plugin for Flake8
        -----------------
        
        When both Flake8 and ``flake8-illegal-import`` are installed, the plugin
        is available in ``flake8``::
        
          $ flake8 --version
          3.6.0 (flake8-illegal-import: 0.1.0, […]
        
        
        Parameters
        ----------
        
        This module requires 2 parameters:
        --illegal-import-dir={path}
        --illegal-import-packages={pkg1},{pkg2}
        
        E.g usage::
        
          $ flake8 ./sample.py --illegal-import-dir=./ --illegal-import-packages=os --select=II101
        
        >>/home/.../test/sample.py:14:1: II101 importing this package is forbidden in this directory (os)
        
        
        Error codes
        -----------
        
        This plugin is using the following error codes:
        
        +---------------------------------------------------------------------+
        | Presence of forbidden imports                                       |
        +-------+-------------------------------------------------------------+
        | II101 | importing this package is forbidden in this directory {pkg} |
        +-------+-------------------------------------------------------------+
        
        
        Operation
        ---------
        
        The plugin will go through all imports and find out if forbidden packages
        are imported in the given directory
        
        
        Changes
        -------
        
        0.1.0 - 2019-01-XX
        ``````````````````
        * Initial release
        
Keywords: flake8 import reject
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
