Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/withprecedent/ashford
Powerful, flexible factory, registration, and validation tools for Python
https://github.com/withprecedent/ashford
factory factory-pattern python registration registrty validate validation
Last synced: about 2 months ago
JSON representation
Powerful, flexible factory, registration, and validation tools for Python
- Host: GitHub
- URL: https://github.com/withprecedent/ashford
- Owner: WithPrecedent
- License: other
- Created: 2021-10-07T19:25:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-29T16:42:09.000Z (over 1 year ago)
- Last Synced: 2024-11-14T00:11:56.058Z (about 2 months ago)
- Topics: factory, factory-pattern, python, registration, registrty, validate, validation
- Language: Python
- Homepage:
- Size: 184 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ashford
| | |
| --- | --- |
| Version | [](https://pypi.org/project/ashford/) [](https://github.com/WithPrecedent/ashford/releases)
| Status | [](https://github.com/WithPrecedent/ashford/actions/workflows/ci.yml?query=branch%3Amain) [](https://www.repostatus.org/#active) [](https://pypi.org/project/ashford/)
| Documentation | [](https://WithPrecedent.github.io/ashford)
| Tools | [](https://squidfunk.github.io/mkdocs-material/) [](https://github.com/astral-sh/Ruff) [](https://PDM.fming.dev) [](https://github.com/TezRomacH/python-package-template/blob/master/.pre-commit-config.yaml) [](https://github.com/features/actions) [](https://editorconfig.org/) [](https://www.github.com/WithPrecedent/ashford) [](https://github.com/dependabot)
| Compatibility | [](https://pypi.python.org/pypi/ashford/) [](https://www.linux.org/) [](https://www.apple.com/macos/) [](https://www.microsoft.com/en-us/windows?r=1)
| Stats | [](https://pypi.org/project/ashford) [](https://github.com/WithPrecedent/ashford/stargazers) [](https://github.com/WithPrecedent/ashford/graphs/contributors) [](https://github.com/WithPrecedent/ashford/graphs/contributors) [](https://github.com/WithPrecedent/ashford/forks)
| | |
-----
## What is ashford?
This package provides classes and decorators for a variety of Python implementations of registration, factories, and type validators.
## Why use ashford?
## Registries
* `registered`: a decorator that stores a registry in a `registry` attribute of the function or class which is wrapped by the decorator.
* `Registrar`: a mixin for automatic subclass registration.
## Factories
* `InstanceFactory`: mixin that stores all subclass instances in the `instances` class attribute and returns stored instances when the `create` classmethod is called.
* `LibraryFactory`: mixin that stores all subclasses and subclass instances in the `library` class attribute and returns stored subclasses and/or instances when the `create` classmethod is called.
* `SourceFactory`: mixin that calls the appropriate creation method based on the type of passed first argument to `create` and the types stored in the keys of the `sources` class attribute.
* `StealthFactory`: mixin that returns stored subclasses when the `create` classmethod is called without having a `subclasses` class attribute like SubclassFactory.
* `SubclassFactory`: mixin that stores all subclasses in the `subclasses` class attribute and returns stored subclasses when the `create` classmethod is called.
* `TypeFactory`: mixin that calls the appropriate creation method based on the type of passed first argument to `create` and the snakecase name of the type. This factory is prone to significant key errors unless you are sure of the snakecase names of all possible submitted type names. SourceFactory avoids this problem by allowing you to declare corresponding types and string names.
## Validators
* `bonafide`: decorator that validates or converts types based on type annotations of the wrapped function or dataclass (under construction)
ashford`s framework supports a wide range of coding styles. You can create complex multiple inheritance structures with mixins galore or simpler, compositional objects. Even though the data structures are necessarily object-oriented, all of the tools to modify them are also available as functions, for those who prefer a more funcitonal approaching to programming.
The project is also highly internally documented so that users and developers can easily make ashford work with their projects. It is designed for Python coders at all levels. Beginners should be able to follow the readable code and internal documentation to understand how it works. More advanced users should find complex and tricky problems addressed through efficient code.
## Getting started
### Requirements
[TODO: List any OS or other restrictions and pre-installation dependencies]
### Installation
To install `ashford`, use `pip`:
```sh
pip install ashford
```
### Usage
[TODO: Describe common use cases, with possible example(s)]
## Contributing
Contributors are always welcome. Feel free to grab an [issue](https://www.github.com/WithPrecedent/ashford/issues) to work on or make a suggested improvement. If you wish to contribute, please read the [Contribution Guide](https://www.github.com/WithPrecedent/ashford/contributing.md) and [Code of Conduct](https://www.github.com/WithPrecedent/ashford/code_of_conduct.md).
## Similar Projects
[TODO: If they exist, it is always nice to acknowledge other similar efforts]
## Acknowledgments
[TODO: Mention any people or organizations that warrant a special acknowledgment]
## License
Use of this repository is authorized under the [Apache Software License 2.0](https://www.github.com/WithPrecedent/ashford/blog/main/LICENSE).