phx-class-registry 3.0.3

Getting Started

Create a registry using the class_registry.ClassRegistry class, then decorate any classes that you wish to register with its register method:

from class_registry import ClassRegistry

pokedex = ClassRegistry()

@pokedex.register('fire')
class Charizard(Pokemon):
  ...

@pokedex.register('grass')
class Bulbasaur(Pokemon):
  ...

@pokedex.register('water')
class Squirtle(Pokemon):
  ...

To create a class instance from a registry, use the subscript operator:

# Charizard, I choose you!
fighter1 = pokedex['fire']

# CHARIZARD fainted!
# How come my rival always picks the type that my pokémon is weak against??
fighter2 = pokedex['grass']

Requirements

ClassRegistry is compatible with the following Python versions:

• 3.8

• 3.7

• 3.6

• 3.5

pypy3 is also supported.

Installation

Install the latest stable version via pip:

pip install class-registry

Running Unit Tests

To run unit tests after installing from source:

python setup.py test

This project is also compatible with tox, which will run the unit tests in different virtual environments (one for each supported version of Python).

To run the unit tests, it is recommended that you use the detox library. detox speeds up the tests by running them in parallel.

Install the package with the test-runner extra to set up the necessary dependencies, and then you can run the tests with the detox command:

pip install -e .[test-runner]
detox

Documentation

Documentation is available on ReadTheDocs.

If you are installing from source (see above), you can also build the documentation locally:

1. Install extra dependencies (you only have to do this once):

   pip install '.[docs-builder]'

2. Switch to the docs directory:

   cd docs

3. Build the documentation:

   make html