classipypi

Neural PyPI package 'Trove classifier' selector.

Motivation

PyPI 'Trove classifiers' are used in setup.py or pyproject.toml files to convey to PyPI users the conditions under which the package has been used or tested, the topic of the software, etc. such as

• Operating System :: POSIX :: Linux
• Topic :: Software Development :: Libraries
• Intended Audience :: Developers

Installation

pip install classipypi

Usage

ls

usage: classipypi ls [-h] [-i [INCLUDE ...]] [-e [EXCLUDE ...]] [-t] [-g]

Configure input filtering and output display.

options:
  -h, --help            show this help message and exit
  -i [INCLUDE ...], --include [INCLUDE ...]
                        Strings to filter tags for.
                        (default: [])
  -e [EXCLUDE ...], --exclude [EXCLUDE ...]
                        Strings to filter tags against.
                        (default: [])
  -t, --toml            Whether to display the tags as a TOML-compatible list.
                        (default: False)
  -g, --group           Whether to display tags grouped by section.
                        (default: False)

For example, to show the Development Status tags (but skip any with "Alpha" in):

classipypi ls -i "Development Status" -e Alpha

Development Status :: 1 - Planning
Development Status :: 4 - Beta
Development Status :: 5 - Production/Stable
Development Status :: 6 - Mature
Development Status :: 7 - Inactive

sel

Use -q or --query to select classifiers based on a description:

classipypi -q "3D scientific visualisation tool"

usage: classipypi sel [-h] [-q QUERY] [-s SOURCE] [-t] [-g]

Configure source and y.

options:
  -h, --help            show this help message and exit
  -q QUERY, --query QUERY
                        The query string.
                        (default: None)
  -s SOURCE, --source SOURCE
                        The source code.
                        (default: None)
  -t, --toml            Whether to display the tags as a TOML-compatible list.
                        (default: False)
  -g, --group           Whether to display tags grouped by section.
                        (default: False)

Use -s or --source to select classifiers based on source code:

classipypi --source ./local_package_repo/

Development

• To set up pre-commit hooks (to keep the CI bot happy) run pre-commit install-hooks so all git commits trigger the pre-commit checks. I use Conventional Commits. This runs black, flake8, autopep8, pyupgrade, etc.

• To set up a dev env, I first create a new conda environment and use it in PDM with which python > .pdm-python. To use virtualenv environment instead of conda, skip that. Run pdm install and a .venv will be created if no Python binary path is found in .pdm-python.

• To run tests, run pdm run python -m pytest and the PDM environment will be used to run the test suite.