Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/python-formate/flake8-dunder-all

A Flake8 plugin and pre-commit hook which checks to ensure modules have defined '__all__'.
https://github.com/python-formate/flake8-dunder-all

flake8 python

Last synced: 3 months ago
JSON representation

A Flake8 plugin and pre-commit hook which checks to ensure modules have defined '__all__'.

Host: GitHub
URL: https://github.com/python-formate/flake8-dunder-all
Owner: python-formate
License: mit
Created: 2020-08-21T20:54:43.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-26T11:12:39.000Z (4 months ago)
Last Synced: 2024-07-27T11:22:16.355Z (3 months ago)
Topics: flake8, python
Language: Python
Homepage: https://flake8-dunder-all.readthedocs.io/en/latest
Size: 396 KB
Stars: 7
Watchers: 1
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE

Awesome Lists containing this project

awesome-flake8-extensions - flake8-dunder-all - Ensures that modules have defined `__all__`. (Bugs)

README

        ##################

flake8-dunder-all

##################

.. start short_desc

**A Flake8 plugin and pre-commit hook which checks to ensure modules have defined '__all__'.**

.. end short_desc

.. start shields

.. list-table::

	:stub-columns: 1

	:widths: 10 90

	* - Docs

	  - |docs| |docs_check|

	* - Tests

	  - |actions_linux| |actions_windows| |actions_macos| |coveralls|

	* - PyPI

	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|

	* - Anaconda

	  - |conda-version| |conda-platform|

	* - Activity

	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|

	* - QA

	  - |codefactor| |actions_flake8| |actions_mypy|

	* - Other

	  - |license| |language| |requires|

.. |docs| image:: https://img.shields.io/readthedocs/flake8-dunder-all/latest?logo=read-the-docs

	:target: https://flake8-dunder-all.readthedocs.io/en/latest

	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/python-formate/flake8-dunder-all/workflows/Docs%20Check/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22Docs+Check%22

	:alt: Docs Check Status

.. |actions_linux| image:: https://github.com/python-formate/flake8-dunder-all/workflows/Linux/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22Linux%22

	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/python-formate/flake8-dunder-all/workflows/Windows/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22Windows%22

	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/python-formate/flake8-dunder-all/workflows/macOS/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22macOS%22

	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/python-formate/flake8-dunder-all/workflows/Flake8/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22Flake8%22

	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/python-formate/flake8-dunder-all/workflows/mypy/badge.svg

	:target: https://github.com/python-formate/flake8-dunder-all/actions?query=workflow%3A%22mypy%22

	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-dunder-all/badge.svg

	:target: https://dependency-dash.repo-helper.uk/github/python-formate/flake8-dunder-all/

	:alt: Requirements Status

.. |coveralls| image:: https://img.shields.io/coveralls/github/python-formate/flake8-dunder-all/master?logo=coveralls

	:target: https://coveralls.io/github/python-formate/flake8-dunder-all?branch=master

	:alt: Coverage

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/python-formate/flake8-dunder-all?logo=codefactor

	:target: https://www.codefactor.io/repository/github/python-formate/flake8-dunder-all

	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/flake8-dunder-all

	:target: https://pypi.org/project/flake8-dunder-all/

	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/flake8-dunder-all?logo=python&logoColor=white

	:target: https://pypi.org/project/flake8-dunder-all/

	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/flake8-dunder-all

	:target: https://pypi.org/project/flake8-dunder-all/

	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/flake8-dunder-all

	:target: https://pypi.org/project/flake8-dunder-all/

	:alt: PyPI - Wheel

.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/flake8-dunder-all?logo=anaconda

	:target: https://anaconda.org/domdfcoding/flake8-dunder-all

	:alt: Conda - Package Version

.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/flake8-dunder-all?label=conda%7Cplatform

	:target: https://anaconda.org/domdfcoding/flake8-dunder-all

	:alt: Conda - Platform

.. |license| image:: https://img.shields.io/github/license/python-formate/flake8-dunder-all

	:target: https://github.com/python-formate/flake8-dunder-all/blob/master/LICENSE

	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/python-formate/flake8-dunder-all

	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/python-formate/flake8-dunder-all/v0.4.1

	:target: https://github.com/python-formate/flake8-dunder-all/pulse

	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/python-formate/flake8-dunder-all

	:target: https://github.com/python-formate/flake8-dunder-all/commit/master

	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2024

	:alt: Maintenance

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/flake8-dunder-all

	:target: https://pypi.org/project/flake8-dunder-all/

	:alt: PyPI - Downloads

.. end shields

|

Installation

--------------

.. start installation

``flake8-dunder-all`` can be installed from PyPI or Anaconda.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install flake8-dunder-all

To install with ``conda``:

	* First add the required channels

	.. code-block:: bash

		$ conda config --add channels https://conda.anaconda.org/conda-forge

		$ conda config --add channels https://conda.anaconda.org/domdfcoding

	* Then install

	.. code-block:: bash

		$ conda install flake8-dunder-all

.. end installation

flake8 codes

--------------

============== ====================================

Code           Description

============== ====================================

DALL000        Module lacks __all__.

============== ====================================

Use as a pre-commit hook

--------------------------

See `pre-commit `_ for instructions

Sample ``.pre-commit-config.yaml``:

.. code-block:: yaml

	 - repo: https://gitlab.com/pycqa/flake8

	   rev: 3.8.1

	   hooks:

	    - id: flake8

	      additional_dependencies: [flake8-dunder-all==0.4.1]

``ensure-dunder-all`` script

There is also a script which will automatically add __all__ for files which don't have it.

See `the documentation `_

for details.