phx-class-registry 4.0.0

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 known to be compatible with the following Python versions:

• 3.11

• 3.10

• 3.9

Installation

Install the latest stable version via pip:

pip install phx-class-registry

Running Unit Tests

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

pip install -e .[test-runner]
tox -p all

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 -e '.[docs-builder]'

2. Switch to the docs directory:

   cd docs

3. Build the documentation:

   make html

Releases

Steps to build releases are based on Packaging Python Projects Tutorial

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

   pip install -e '.[build-system]'

2. Run the build:

   python -m build