https://github.com/timothy-bartlett/trove-classifiers
Canonical source for classifiers on PyPI.
https://github.com/timothy-bartlett/trove-classifiers
Last synced: 3 months ago
JSON representation
Canonical source for classifiers on PyPI.
- Host: GitHub
- URL: https://github.com/timothy-bartlett/trove-classifiers
- Owner: timothy-bartlett
- License: apache-2.0
- Created: 2024-08-21T22:16:26.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T00:06:18.000Z (10 months ago)
- Last Synced: 2025-01-23T13:43:52.100Z (5 months ago)
- Language: Python
- Homepage:
- Size: 313 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Canonical source for [classifiers][1] on [PyPI][2].
Classifiers [categorize projects][3] per [PEP 301][4]. Use this package to
validate classifiers in packages for PyPI upload or download.
## Usage
To install [from PyPI][5]:
```
$ pip install trove-classifiers
```
This package can be invoked as a module to print a list of classifiers:
```
$ python -m trove_classifiers | grep -Ei pyramid
Framework :: Pyramid
```
In addition, this package's API is two importable objects:
### Classifiers (`trove_classifiers.classifiers`)
A `set` containing classifiers (as strings). Useful for determining membership.
Example - determine if a classifier is valid:
```python
>>> from trove_classifiers import classifiers
>>> 'License :: OSI Approved' in classifiers
True
>>> 'Fuzzy :: Wuzzy :: Was :: A :: Bear' in classifiers
False
>>>
```
### Deprecated classifiers (`trove_classifiers.deprecated_classifiers`)
A `dict`, mapping a deprecated classifier (string) to a list of classifiers
which replaces it (strings).
Example - determine if a classifier is deprecated:
```python
>>> from trove_classifiers import deprecated_classifiers
>>> 'License :: OSI Approved' in deprecated_classifiers
False
>>> 'Natural Language :: Ukranian' in deprecated_classifiers
True
>>> deprecated_classifiers["Natural Language :: Ukranian"]
['Natural Language :: Ukrainian']
```
[1]: https://pypi.org/classifiers/
[2]: https://pypi.org
[3]: https://packaging.python.org/specifications/core-metadata/#classifier-multiple-use
[4]: https://www.python.org/dev/peps/pep-0301/
[5]: https://pypi.org/project/trove-classifiers/