{"author":"ghandic","author_email":null,"bugtrack_url":null,"classifiers":["License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python :: 3"],"description":"

\n jsf\n

\n\n

\n \n $\"Coverage\"$ \n \n \n $\"Docs\"$ \n \n \n $\"PyPI$ \n \n
\n \n $\"License\"$ \n \n \n $\"Code$ \n \n

\n\nUse **jsf** along with fake data generators to provide consistent and meaningful fake data for your system.\n\n## Main Features\n\n- Provides out of the box data generation from any JSON schema 📦\n- Extendable custom data providers using any lambda functions 🔗\n- Multi level state for dependant data (eg multiple objects sharing value, such as children with same surname) 🤓\n- Inbuilt validation of fake JSON produced ✅\n- In memory conversion from JSON Schema to Pydantic Models with generated examples 🤯\n- Seamless integration with [FastAPI](https://fastapi.tiangolo.com/) 🚀\n\n## Installation\n\n

\n\n```console\n$ pip install jsf\n\n---> 100%\n```\n\n

\n\n## Usage\n\n### Basic 😊\n\n```python\nfrom jsf import JSF\n\nfaker = JSF(\n {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\"type\": \"string\", \"$provider\": \"faker.name\"},\n \"email\": {\"type\": \"string\", \"$provider\": \"faker.email\"},\n },\n \"required\": [\"name\", \"email\"],\n }\n)\n\nfake_json = faker.generate()\n```\n\nResults in ...\n\n```python\n{\n 'name': 'Jesse Phillips', \n 'email': 'xroberson@hotmail.com'\n}\n```\n\n### From JSON file 📁\n\n```python\nfrom jsf import JSF\n\nfaker = JSF.from_json(\"demo-schema.json\")\nfake_json = faker.generate()\n```\n\n

Or run straight from the commandline...

\n\n#### Native install\n\n```bash\npip install jsf[cli]\njsf --schema jsf/tests/data/custom.json --instance wow.json\n```\n\n#### Docker\n\n```bash\ndocker run -v $PWD:/data challisa/jsf jsf --schema /data/custom.json --instance /data/example.json\n```\n\n

\n\n### FastAPI Integration 🚀\n\nCreate a file main.py with:\n\n```python\nfrom jsf import JSF\nfrom fastapi import FastAPI\n\napp = FastAPI(docs_url=\"/\")\ngenerator = JSF.from_json(\"custom.json\")\n\n\n@app.get(\"/generate\", response_model=generator.pydantic())\ndef read_root():\n return generator.generate()\n\n```\n\nRun the server with:\n\n

\n\n```console\n$ uvicorn main:app --reload\n\nINFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)\nINFO: Started reloader process [28720]\nINFO: Started server process [28722]\nINFO: Waiting for application startup.\nINFO: Application startup complete.\n```\n\nNavigate to [http://127.0.0.1:8000](http://127.0.0.1:8000) and check out your endpoint. Notice the following are all automatically created:\n\n- Schema with descriptions and examples\n- Example response\n- Data generation by clicking \"try it out\"\n\n![Example Swagger UI - Page 1](docs/assets/imgs/ui-1.png)\n![Example Swagger UI - Page 2](docs/assets/imgs/ui-2.png)\n![Example Swagger UI - Page 3](docs/assets/imgs/ui-3.png)\n![Example Swagger UI - Page 4](docs/assets/imgs/ui-4.png)\n\n

\n\n### Partially supported features\n\n- string `contentMediaType` - only a subset of these are supported, however they can be expanded within [this file](jsf/schema_types/string_utils/content_type/__init__.py) \n\n## Credits\n\n- This repository is a Python port of [json-schema-faker](https://github.com/json-schema-faker/json-schema-faker) with some minor differences in implementation.\n\n## License\n\n- [MIT License](/LICENSE)\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/ghandic/jsf","keywords":"JSON Schema, Fake data, Test data, Schema, JSON, Faker, Hypothesis, Rapid Prototype, Data contract","license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"jsf","package_url":"https://pypi.org/project/jsf/","platform":null,"project_url":"https://pypi.org/project/jsf/","project_urls":{"Homepage":"https://github.com/ghandic/jsf"},"provides_extra":null,"release_url":"https://pypi.org/project/jsf/0.11.2/","requires_dist":["faker>=15.3.4","jsonschema>=4.17.3","pydantic>=2.0.0","rstr>=3.2.0","smart-open[http]>=6.3.0","typing-extensions>=4.9.0","typer>=0.7.0; extra == \"cli\""],"requires_python":">=3.8","summary":"Creates fake JSON files from a JSON schema","version":"0.11.2","yanked":false,"yanked_reason":null}

Dependency	Optional
faker	false
jsonschema	false
pydantic	false
rstr	false
smart-open	false
typing-extensions	false
typer	true

Package search

jsf

project_urls

Dependencies

All package metadata

Releases