Package: phx-class-registry
ClassRegistryAt the intersection of the Registry and Factory patterns lies theClassRegistry:Define global factories that generate new class instances based on
configurable keys.Seamlessly create powerful service registries.Integrate with setuptools’sentry_pointssystem to make your registries
infinitely extensible by 3rd-party libraries!And more!Getting StartedCreate a registry using theclass_registry.ClassRegistryclass, then
decorate any classes that you wish to register with itsregistermethod:fromclass_registryimportClassRegistrypokedex=ClassRegistry()@pokedex.register('fire')classCharizard(Pokemon):...@pokedex.register('grass')classBulbasaur(Pokemon):...@pokedex.register('water')classSquirtle(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']Advanced UsageThere’s a whole lot more you can do with ClassRegistry, including:Provide args and kwargs to new class instances.Automatically register non-abstract classes.Integrate with setuptools’sentry_pointssystem so that 3rd-party
libraries can add their own classes to your registries.Wrap your registry in an instance cache to create a service registry.And more!For more advanced usage, check out the documentation onReadTheDocs!RequirementsClassRegistry is known to be compatible with the following Python versions:3.123.113.10NoteI’m only one person, so to keep from getting overwhelmed, I’m only committing
to supporting the 3 most recent versions of Python.  ClassRegistry’s code is
pretty simple, so it’s likely to be compatible with versions not listed here;
there just won’t be any test coverage to prove it 😇InstallationInstall the latest stable version via pip:pip install phx-class-registryImportantMake sure to installphx-class-registry,notclass-registry.  I
created the latter at a previous job years ago, and after I left they never
touched that project again and stopped responding to my emails — so in the
end I had to fork it 🤷Running Unit TestsInstall the package with thetest-runnerextra to set up the necessary
dependencies, and then you can run the tests with thetoxcommand:pip install -e .[test-runner]
tox -pTo run tests in the current virtualenv:python -m unittestDocumentationDocumentation is available onReadTheDocs.If you are installing from source (see above), you can also build the
documentation locally:Install extra dependencies (you only have to do this once):pip install -e '.[docs-builder]'Switch to thedocsdirectory:cd docsBuild the documentation:make htmlReleasesSteps to build releases are based onPackaging Python Projects TutorialImportantMake sure to build releases off of themainbranch, and check that all
changes fromdevelophave been merged before creating the release!1. Build the ProjectInstall extra dependencies (you only have to do this once):pip install -e '.[build-system]'Delete artefacts from previous builds, if applicable:rm dist/*Run the build:python -m buildThe build artefacts will be located in thedistdirectory at the top
level of the project.2. Upload to PyPICreate a PyPI API token(you only have to do this once).Increment the version number inpyproject.toml.Check that the build artefacts are valid, and fix any errors that it finds:python -m twine check dist/*Upload build artefacts to PyPI:python -m twine upload dist/*3. Create GitHub ReleaseCreate a tag and push to GitHub:git tag <version>
git push<version>must match the updated version number inpyproject.toml.Go to theReleases page for the repo.ClickDraft a new release.Select the tag that you created in step 1.Specify the title of the release (e.g.,ClassRegistry v1.2.3).Write a description for the release.  Make sure to include:
- Credit for code contributed by community members.
- Significant functionality that was added/changed/removed.
- Any backwards-incompatible changes and/or migration instructions.
- SHA256 hashes of the build artefacts.GPG-sign the description for the release (ASCII-armoured).Attach the build artefacts to the release.ClickPublish release.