{"author":"Arkadiusz Bokowy","author_email":"arkadiusz.bokowy@gmail.com","bugtrack_url":null,"classifiers":["Framework :: Flake8","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Topic :: Software Development :: Libraries :: Python Modules","Topic :: Software Development :: Quality Assurance"],"description":"Package requirements checker\n============================\n\nThis module provides a plug-in for `flake8 `_, which checks/validates\npackage import requirements. It reports missing and/or not used project direct dependencies.\n\nThis plug-in adds new flake8 warnings:\n\n- ``I900``: Package is not listed as a requirement.\n- ``I901``: Package is required but not used. (not implemented yet)\n\nImportant notice\n----------------\n\nIn order to collect project's dependencies, this checker evaluates Python code from the\n``setup.py`` file stored in the project's root directory. Code evaluation is done with the `eval()\n`_ function. As a fall-back method, this\nchecker also tries to load dependencies, in order, from the ``setup.cfg``, the ``pyproject.toml``\nfile from the `PEP 621 `_ project section, the ``pyproject.toml``\nfile from the `poetry `_ tool section, or from the\n``requirements.txt`` text file in the project's root directory.\n\nAt this point it is very important to be aware of the consequences of the above approach. One\nmight inject malicious code into the ``setup.py`` file, which will be executed by this checker.\nHence, this checker shall NEVER be use to check code from an unknown source! However, in most\ncases, one validates code from a known source (e.g. own code) and one will run script stored in\nthe ``setup.py`` file anyway. The worst case scenario is, that this checker will execute the\nequivalent of the ``python setup.py``, which shall be idempotent (it's a horribly designed\n``setup.py`` file if it's not).\n\nIf you have noticed some side effects during the ``flake8`` check and your ``setup.py`` file is\nwritten in a standard way (e.g. `pypa-sampleproject\n`_), please fill out a bug report.\n\nInstallation\n------------\n\nYou can install, upgrade, or uninstall ``flake8-requirements`` with these commands::\n\n $ pip install flake8-requirements\n $ pip install --upgrade flake8-requirements\n $ pip uninstall flake8-requirements\n\nCustomization\n-------------\n\nFor projects with custom (private) dependencies, one can provide mapping between project name and\nprovided modules. Such a mapping can be set on the command line during the flake8 invocation with\nthe ``--known-modules`` option or alternatively in the ``[flake8]`` section of the configuration\nfile, e.g. ``setup.cfg``. The syntax of the custom mapping looks like follows::\n\n 1st-project-name:[module1,module2,...],2nd-project-name:[moduleA,moduleB,...],...\n\nIf some local project lacks \"name\" attribute in the ``setup.py`` file (it is highly discouraged\nnot to provide the \"name\" attribute, though), one can omit the project name in the mapping and do\nas follows::\n\n :[localmodule1,localmodule2,...],1st-local-library:[moduleA,moduleB,...],...\n\nReal life example::\n\n $ cat setup.cfg\n [flake8]\n max-line-length = 100\n known-modules = my-lib:[mylib.drm,mylib.encryption]\n\nIf you use `Flake8-pyproject `_\n(can include for installation using ``flake8-requirements[pyproject]``),\nyou can also configure the known modules using a nicer syntax in ``pyproject.toml``::\n\n $ cat pyproject.toml\n ...\n [tool.flake8]\n max-line-length = 100\n\n [tool.flake8.known-modules]\n my-lib = [\"mylib.drm\", \"mylib.encryption\"]\n\nNote that if the module's name contains dots, you have to quote it in pyproject.toml (e.g.\n``\"my_namespace.my_lib\" = [...]``).\n\nIt is also possible to scan host's site-packages directory for installed packages. This feature is\ndisabled by default, but user can enable it with the ``--scan-host-site-packages`` command line\noption. Please note, however, that the location of the site-packages directory will be determined\nby the Python version used for flake8 execution.\n\nIn order to read requirements from the text file, user shall provide the location of such a file\nwith the ``--requirements-file`` option. If the given location is not an absolute path, then it\nhas to be specified as a path relative to the project's root directory.\n\nIf you use the ``-r`` flag in your requirements text file with more than one level of recursion\n(in other words, one file includes another, the included file includes yet another, and so on),\nadd the ``--requirements-max-depth`` option to flake8 (for example, ``--requirements-max-depth=3``\nto allow three levels of recursion).\n\nFAQ\n---\n\n| **Q:** Package is added to the requirements, but flake8 still reports \"I900 '' not listed\n as a requirement\".\n| **A:** It happens when the name of the package is not the same as the name of the module. In such\n a case, you have to provide the mapping between the package name and the module name. See\n the \"`Customization <#customization>`_\" section for more details. If the package for which\n that happens is a well-known package, please fill out a bug report or add mapping to the\n `KNOWN_3RD_PARTIES `_ and submit a pull request.\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/Arkq/flake8-requirements","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"flake8-requirements","package_url":"https://pypi.org/project/flake8-requirements/","platform":null,"project_url":"https://pypi.org/project/flake8-requirements/","project_urls":{"Homepage":"https://github.com/Arkq/flake8-requirements"},"provides_extra":["pyproject"],"release_url":"https://pypi.org/project/flake8-requirements/2.2.1/","requires_dist":["flake8>=4.0.0","setuptools>=10.0.0","tomli>=1.2.1; python_version < \"3.11\"","Flake8-pyproject; extra == \"pyproject\""],"requires_python":null,"summary":"Package requirements checker, plugin for flake8","version":"2.2.1","yanked":false,"yanked_reason":null}

Dependencies of flake8-requirements (4).
Dependency	Optional
flake8	false
setuptools	false
tomli	false
Flake8-pyproject	true

Package search

flake8-requirements

project_urls

Dependencies

All package metadata

Releases