Skip to content
Normal view Permalink
README.md 957 B
Newer Older
Dom Sekotill's avatar
Initial commit
Dom Sekotill committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 
[![licence-badge]](/LICENCE.txt)


Trove Classifiers Enums
=======================

**Trove classifiers made available as enums for strict type and value checking**


Installation
------------

Install with pip:
Dom Sekotill's avatar
Fix note in README.md  
Dom Sekotill committed
15 
> **Note:**
Dom Sekotill's avatar
Initial commit
Dom Sekotill committed
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 
> These are interim instructions, with project release this will be updated.

```shell
pip install https://code.kodo.org.uk/dom/trove-classifiers-enum
```


Usage
-----

Lookups can be either via normal Enum class access, with Classifier subclasses sometimes
being nested; or by calling the Classifier base class with a value.

The following each produce the same object:

```python
from trove_classifiers_enums import Classifier, OperatingSystem

Classifier("Operating System :: POSIX :: Linux")

OperatingSystem.POSIX("Operating System :: POSIX :: Linux")

OperatingSystem.POSIX['Linux']

OperatingSystem.POSIX.Linux
```

---

[licence-badge]:
  https://img.shields.io/badge/licence-Apache--2.0-orange.svg
  "Licence: Apache-2.0"