Metadata-Version: 1.2
Name: darglint
Version: 0.0.2
Summary: A utility for ensuring Google-style docstringsstay up to date with the source code.
Home-page: http://github.com/terrencepreilly/darglint
Author: Terrence Reilly
Author-email: terrencepreilly@gmail.com
License: MIT
Description-Content-Type: UNKNOWN
Description: # Darglint
        
        A limited docstring linter which checks that function/method parameters
        are defined in their docstrings.  *Darglint* expects docstrings to be
        formatted using the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html).
        
        Darglint is in a very early stage, and fails for a lot of things.
        Certain features, such as a robust command-line interface, still
        do not exist.
        
        ## Installation
        
        
        ## Usage
        
        Given a python source file, `serializers.py`, you would check the docstrings
        as follows:
        
        ```
        darglint serializers.py
        ```
        
        ## Features planned and implemented
        
        - [x] Function definitions can be checked.
        - [x] Methods definitions of top-level class can be checked.
        - [x] Line number printout for function/method definition.
        - [ ] Add type hint integration.
        - [ ] Add support for python versions earlier than 3.6.
        (The typing module is being used, which is the only real
        limiting factor.)
        - [ ] Syntastic support. (Syntastic is not accepting new checkers until
        their next API stabilizes, so this may take some time.)
        - [ ] Add command line interface.
        
        ## Development
        
        Install `darglint`. First, clone the repository:
        
        ```
        git clone https://github.com/terrencepreilly/darglint.git
        ```
        
        `cd` into the directory, create a virtual environment (optional), then setup:
        
        ```
        cd darglint/
        virtualenv -p python3.6 .env
        source .env/bin/activate
        pip install -e .
        ```
        
        You can run the tests using
        
        ```
        python setup.py test
        ```
        
        Or, install `pytest` manually, `cd` to the project's root directory,
        and run
        
        ```
        pytest
        ```
        
        Contributions welcome.
        
Keywords: documentation linter development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
