sob


Namesob JSON
Version 2.1.1 PyPI version JSON
download
home_pageNone
SummaryA type-enforced framework for serializing and deserializing JSON
upload_time2025-09-02 00:50:43
maintainerNone
docs_urlNone
authorNone
requires_python~=3.9
licenseNone
keywords serial
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # sob

[![test](https://github.com/enorganic/sob/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/enorganic/sob/actions/workflows/test.yml)
[![PyPI version](https://badge.fury.io/py/sob.svg?icon=si%3Apython)](https://badge.fury.io/py/sob)

`sob` is an object serialization/deserialization library intended to facilitate
automated authoring of models for JSON web APIs which are readable and
introspective, and to expedite data validation and integration testing.

- [Documentation](https://sob.enorganic.org)
- [Contributing](https://sob.enorganic.org/contributing)

## Installation

You can install `sob` with pip:

```shell
pip3 install sob
```

## Background Information

This library is developed in concert with, and in support of, the
[oapi](https://enorganic.github.io/oapi/) library, which facilitates
generating client libraries ("SDKs") based on an
[Open API](https://www.openapis.org/) specification. For very niche use cases,
`sob` remains a separate library, but the development roadmap and all feature
requests should be viewed in the context of supporting the definition and
validation of data as described by an [Open API](https://www.openapis.org/)
specification.

When authoring server-side code for your web API, I recommend
[pydantic](https://docs.pydantic.dev/latest/). The `sob` library is designed
primarily to support API *client* data models, and for automated model module
creation based on metadata generated either using
[sob.thesaurus](https://sob.enorganic.org/api/thesaurus) or
[oapi](https://oapi.enorganic.org/).

The name "sob" is not a profane acronym (in this case), it is a portmanteau
of "serial" and "object". Originally, this library was named "serial",
but was renamed with version 1 due to a namespace conflict with
[pyserial](https://pyserial.readthedocs.io/en/latest/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sob",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.9",
    "maintainer_email": null,
    "keywords": "serial",
    "author": null,
    "author_email": "david@belais.me",
    "download_url": "https://files.pythonhosted.org/packages/6e/57/0c2feac01d9b753fb4d2d228ba98ae15be9f21a894b488de4a60d0f8f82d/sob-2.1.1.tar.gz",
    "platform": null,
    "description": "# sob\n\n[![test](https://github.com/enorganic/sob/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/enorganic/sob/actions/workflows/test.yml)\n[![PyPI version](https://badge.fury.io/py/sob.svg?icon=si%3Apython)](https://badge.fury.io/py/sob)\n\n`sob` is an object serialization/deserialization library intended to facilitate\nautomated authoring of models for JSON web APIs which are readable and\nintrospective, and to expedite data validation and integration testing.\n\n- [Documentation](https://sob.enorganic.org)\n- [Contributing](https://sob.enorganic.org/contributing)\n\n## Installation\n\nYou can install `sob` with pip:\n\n```shell\npip3 install sob\n```\n\n## Background Information\n\nThis library is developed in concert with, and in support of, the\n[oapi](https://enorganic.github.io/oapi/) library, which facilitates\ngenerating client libraries (\"SDKs\") based on an\n[Open API](https://www.openapis.org/) specification. For very niche use cases,\n`sob` remains a separate library, but the development roadmap and all feature\nrequests should be viewed in the context of supporting the definition and\nvalidation of data as described by an [Open API](https://www.openapis.org/)\nspecification.\n\nWhen authoring server-side code for your web API, I recommend\n[pydantic](https://docs.pydantic.dev/latest/). The `sob` library is designed\nprimarily to support API *client* data models, and for automated model module\ncreation based on metadata generated either using\n[sob.thesaurus](https://sob.enorganic.org/api/thesaurus) or\n[oapi](https://oapi.enorganic.org/).\n\nThe name \"sob\" is not a profane acronym (in this case), it is a portmanteau\nof \"serial\" and \"object\". Originally, this library was named \"serial\",\nbut was renamed with version 1 due to a namespace conflict with\n[pyserial](https://pyserial.readthedocs.io/en/latest/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A type-enforced framework for serializing and deserializing JSON",
    "version": "2.1.1",
    "project_urls": {
        "Documentation": "https://sob.enorganic.org",
        "Repository": "https://github.com/enorganic/sob"
    },
    "split_keywords": [
        "serial"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8e90c364e799a15e34676c1c727e9ad86238a75803f2e53c995914fb4f82dda6",
                "md5": "93a495a53e5a367f49b97ddb912af44e",
                "sha256": "2d89791b2961f6a7ef6faa48d3d4eb36bd735d8cf61d9c20aea04ce2d16f144a"
            },
            "downloads": -1,
            "filename": "sob-2.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93a495a53e5a367f49b97ddb912af44e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.9",
            "size": 73468,
            "upload_time": "2025-09-02T00:50:45",
            "upload_time_iso_8601": "2025-09-02T00:50:45.172018Z",
            "url": "https://files.pythonhosted.org/packages/8e/90/c364e799a15e34676c1c727e9ad86238a75803f2e53c995914fb4f82dda6/sob-2.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6e570c2feac01d9b753fb4d2d228ba98ae15be9f21a894b488de4a60d0f8f82d",
                "md5": "45fd5fa5bc978a555011e9482c5a7c21",
                "sha256": "154542994ad2b5d1f4da2731714c3c862f413eb42689107b5d2e84a271fbe7b4"
            },
            "downloads": -1,
            "filename": "sob-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "45fd5fa5bc978a555011e9482c5a7c21",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.9",
            "size": 65523,
            "upload_time": "2025-09-02T00:50:43",
            "upload_time_iso_8601": "2025-09-02T00:50:43.894140Z",
            "url": "https://files.pythonhosted.org/packages/6e/57/0c2feac01d9b753fb4d2d228ba98ae15be9f21a894b488de4a60d0f8f82d/sob-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-02 00:50:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "enorganic",
    "github_project": "sob",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sob"
}
        
Elapsed time: 1.12641s