Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bcwaldon/warlock

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/bcwaldon/warlock
Owner: bcwaldon
License: apache-2.0
Created: 2012-06-01T20:52:55.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2023-06-05T13:06:45.000Z (over 1 year ago)
Last Synced: 2024-10-02T00:33:14.398Z (2 months ago)
Language: Python
Size: 124 KB
Stars: 148
Watchers: 12
Forks: 43
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-github-repos - bcwaldon/warlock - (Python)

README

        # Warlock 🧙‍♀️

**Create self-validating Python objects using JSON schema.**

[![PyPI](https://img.shields.io/pypi/v/warlock.svg)][warlock]

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlock.svg)][warlock]

[![PyPI - Downloads](https://img.shields.io/pypi/dw/warlock.svg)][pypistats]

[![Build Status](https://github.com/bcwaldon/warlock/actions/workflows/ci.yaml/badge.svg)][ci-builds]

[![Coverage Status](https://coveralls.io/repos/github/bcwaldon/warlock/badge.svg?branch=master)][coveralls]

![GitHub commits since latest release (branch)](https://img.shields.io/github/commits-since/bcwaldon/warlock/latest/master.svg)

[![Package management: poetry](https://img.shields.io/badge/deps-poetry-blueviolet.svg)][poetry]

[![Code Style Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black/)

## Installation

Warlock is [available on PyPI][warlock]:

```shell

pip install warlock

```

## Usage

1) Create your schema

    ```python

    >>> schema = {

        'name': 'Country',

        'properties': {

            'name': {'type': 'string'},

            'abbreviation': {'type': 'string'},

            'population': {'type': 'integer'},

        },

        'additionalProperties': False,

    }

    ```

2) Create a model

    ```python

    >>> import warlock

    >>> Country = warlock.model_factory(schema)

    ```

3) Create an object using your model

    ```python

    >>> sweden = Country(name='Sweden', abbreviation='SE')

    ```

4) Let the object validate itself

    ```python

    >>> sweden.name = 5

    Traceback (most recent call last):

    File "", line 1, in 

    File "warlock/core.py", line 53, in __setattr__

        raise InvalidOperation(msg)

    warlock.core.InvalidOperation: Unable to set 'name' to '5'

    >>> sweden.overlord = 'Bears'

    Traceback (most recent call last):

      File "", line 1, in 

      File "warlock/core.py", line 53, in __setattr__

        raise InvalidOperation(msg)

    warlock.core.InvalidOperation: Unable to set 'overlord' to 'Bears'

    ```

5) Generate a [JSON Patch document](http://tools.ietf.org/html/draft-ietf-appsawg-json-patch) to track changes

    ```python

    >>> sweden.population=9453000

    >>> sweden.patch

    '[{"path": "/population", "value": 9453000, "op": "add"}]'

    ```

[warlock]: https://pypi.org/project/warlock/

[pip]: https://pip.pypa.io/en/stable/

[ci-builds]: https://github.com/bcwaldon/warlock/actions/workflows/ci.yaml

[coveralls]: https://coveralls.io/github/bcwaldon/warlock?branch=master

[poetry]: https://poetry.eustace.io/docs/

[pypistats]: https://pypistats.org/packages/warlock