Lookup and instantiate classes with style.
Project description
Class Resolver
Lookup and instantiate classes with style.
💪 Getting Started
from class_resolver import Resolver
class A: pass
class B: pass
# Index
resolver = Resolver([A, B])
# Lookup
assert A == resolver.lookup('a')
# Instantiate
assert isinstance(resolver.make('a'), A)
⬇️ Installation
The most recent release can be installed from PyPI with:
$ pip install class_resolver
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/class-resolver.git
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/class-resolver.git
$ cd class-resolver
$ pip install -e .
⚖️ License
The code in this package is licensed under the MIT License.
🙏 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
🍪 Cookiecutter Acknowledgement
This package was created with @audreyr's cookiecutter package using @cthoyt's cookiecutter-python-package template.
🛠️ Development
The final section of the README is for if you want to get involved by making a code contribution.
❓ Testing
After cloning the repository and installing tox
with pip install tox
, the unit tests in
the tests/
folder can be run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
📦 Making a Release
After installing the package in development mode and installing
tox
with pip install tox
, the commands for making a new release are contained within
the finish
environment in tox.ini
. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfg
andsrc/class_resolver/version.py
to not have the-dev
suffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine
. Be sure to have a.pypirc
file configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by
minor, you can use
tox -e bumpversion minor
after.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for class_resolver-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85f5fd2286dcb3f07f02d398c8827c33470253050313cb1ed948af9ff180953d |
|
MD5 | 279bcaf16625140883da055a6012416d |
|
BLAKE2b-256 | 65ed1183fce3171ea2daed086f0f9f38bb7823a8b4f3c806c15350bdde0e3330 |