diff options
Diffstat (limited to 'python-openalchemy.spec')
| -rw-r--r-- | python-openalchemy.spec | 725 |
1 files changed, 725 insertions, 0 deletions
diff --git a/python-openalchemy.spec b/python-openalchemy.spec new file mode 100644 index 0000000..0faac42 --- /dev/null +++ b/python-openalchemy.spec @@ -0,0 +1,725 @@ +%global _empty_manifest_terminate_build 0 +Name: python-openalchemy +Version: 2.5.0 +Release: 1 +Summary: Maps an OpenAPI schema to SQLAlchemy models. +License: Apache-2.0 +URL: https://github.com/jdkandersson/OpenAlchemy +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ac/20/20530bc445d1fbbed62bfa8fdd1a762665c0c5fe40bf4a02b00b799adc6c/OpenAlchemy-2.5.0.tar.gz +BuildArch: noarch + +Requires: python3-Jinja2 +Requires: python3-SQLAlchemy +Requires: python3-jsonschema +Requires: python3-sqlalchemy-stubs +Requires: python3-typing_extensions + +%description +# OpenAlchemy + + + +[](https://openapi-sqlalchemy.readthedocs.io/en/latest/?badge=latest) + + + + +Translates an OpenAPI schema to SQLAlchemy models. + +Supports OpenAPI 3.0 and 3.1. + +Get started with the online editor that will guide you through using your +existing OpenAPI specification to define your database schema and offers +installing your models using `pip`: +[Online Editor](https://editor.openalchemy.io) + +## Installation + +```bash +python -m pip install OpenAlchemy +# To be able to load YAML file +python -m pip install OpenAlchemy[yaml] +``` + +## Example + +For example, given the following OpenAPI specification: + +```yaml +# ./examples/simple/example-spec.yml +openapi: "3.0.0" + +info: + title: Test Schema + description: API to illustrate OpenAlchemy MVP. + version: "0.1" + +paths: + /employee: + get: + summary: Used to retrieve all employees. + responses: + 200: + description: Return all employees from the database. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/Employee" + +components: + schemas: + Employee: + description: Person that works for a company. + type: object + x-tablename: employee + properties: + id: + type: integer + description: Unique identifier for the employee. + example: 0 + x-primary-key: true + x-autoincrement: true + name: + type: string + description: The name of the employee. + example: David Andersson + x-index: true + division: + type: string + description: The part of the company the employee works in. + example: Engineering + x-index: true + salary: + type: number + description: The amount of money the employee is paid. + example: 1000000.00 + required: + - id + - name + - division +``` + +The SQLALchemy models file then becomes: + +```python +# models.py +from open_alchemy import init_yaml + +init_yaml("./examples/simple/example-spec.yml") +``` + +The _Base_ and _Employee_ objects can be accessed: + +```python +from open_alchemy.models import Base +from open_alchemy.models import Employee +``` + +With the _models_filename_ parameter a file is auto generated with type hints +for the SQLAlchemy models at the specified location, for example: +[type hinted models example](examples/simple/models_auto.py). This adds support +for IDE auto complete, for example for the model initialization: + + + +and for properties and methods available on an instance: + + + +An extensive set of examples with a range of features is here: + +[examples for main features](examples) + +An example API has been defined using connexion and Flask here: + +[example connexion app](examples/app) + +## Documentation + +[Read the Docs](https://openapi-sqlalchemy.readthedocs.io/en/latest/) + +## Buy me a coffee + +[](https://www.buymeacoffee.com/jdkandersson) + +## Features + +- initializing from JSON, +- initializing from YAML, +- build a package with the models for distribution, packaged as sdist or wheel, +- automatically generate a models file, +- `integer` (32 and 64 bit), +- `number` (float only), +- `boolean`, +- `string`, +- `password`, +- `byte`, +- `binary`, +- `date`, +- `date-time`, +- generic JSON data, +- `$ref` references for columns and models, +- remote `$ref` to other files on the same file system + (_not supported on Windows_), +- remote `$ref` to other files at a URL, +- primary keys, +- auto incrementing, +- indexes, +- composite indexes, +- unique constraints, +- composite unique constraints, +- column nullability, +- foreign keys, +- default values for columns (both application and database side), +- many to one relationships, +- one to one relationships, +- one to many relationships, +- many to many relationships, +- many to many relationships with custom association tables, +- custom foreign keys for relationships, +- back references for relationships, +- `allOf` inheritance for columns and models, +- joined and single table inheritance, +- `from_str` model methods to construct from JSON string, +- `from_dict` model methods to construct from dictionaries, +- `to_str` model methods to convert instances to JSON string, +- `__str__` model methods to support the python `str` function, +- `__repr__` model methods to support the python `repr` function, +- `to_dict` model methods to convert instances to dictionaries, +- `readOnly` and `writeOnly` for influence the conversion to and from + dictionaries, +- exposing created models under `open_alchemy.models` removing the need for + `models.py` files, +- ability to mix in arbitrary classes into a model, +- can use the short `x-` prefix or a namespaced `x-open-alchemy-` prefix for + extension properties and +- grouping models into schemas. + +## Contributing + +Fork and checkout the repository. To install: + +```bash +poetry install +``` + +To run tests: + +```bash +poetry run pytest +``` + +Make your changes and raise a pull request. + +## Compiling Docs + +```bash +poetry shell +cd docs +make html +``` + +This creates the `index.html` file in `docs/build/html/index.html`. + +## Release Commands + +```bash +rm -r dist/* +poetry build +poetry publish +``` + + + +%package -n python3-openalchemy +Summary: Maps an OpenAPI schema to SQLAlchemy models. +Provides: python-openalchemy +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-openalchemy +# OpenAlchemy + + + +[](https://openapi-sqlalchemy.readthedocs.io/en/latest/?badge=latest) + + + + +Translates an OpenAPI schema to SQLAlchemy models. + +Supports OpenAPI 3.0 and 3.1. + +Get started with the online editor that will guide you through using your +existing OpenAPI specification to define your database schema and offers +installing your models using `pip`: +[Online Editor](https://editor.openalchemy.io) + +## Installation + +```bash +python -m pip install OpenAlchemy +# To be able to load YAML file +python -m pip install OpenAlchemy[yaml] +``` + +## Example + +For example, given the following OpenAPI specification: + +```yaml +# ./examples/simple/example-spec.yml +openapi: "3.0.0" + +info: + title: Test Schema + description: API to illustrate OpenAlchemy MVP. + version: "0.1" + +paths: + /employee: + get: + summary: Used to retrieve all employees. + responses: + 200: + description: Return all employees from the database. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/Employee" + +components: + schemas: + Employee: + description: Person that works for a company. + type: object + x-tablename: employee + properties: + id: + type: integer + description: Unique identifier for the employee. + example: 0 + x-primary-key: true + x-autoincrement: true + name: + type: string + description: The name of the employee. + example: David Andersson + x-index: true + division: + type: string + description: The part of the company the employee works in. + example: Engineering + x-index: true + salary: + type: number + description: The amount of money the employee is paid. + example: 1000000.00 + required: + - id + - name + - division +``` + +The SQLALchemy models file then becomes: + +```python +# models.py +from open_alchemy import init_yaml + +init_yaml("./examples/simple/example-spec.yml") +``` + +The _Base_ and _Employee_ objects can be accessed: + +```python +from open_alchemy.models import Base +from open_alchemy.models import Employee +``` + +With the _models_filename_ parameter a file is auto generated with type hints +for the SQLAlchemy models at the specified location, for example: +[type hinted models example](examples/simple/models_auto.py). This adds support +for IDE auto complete, for example for the model initialization: + + + +and for properties and methods available on an instance: + + + +An extensive set of examples with a range of features is here: + +[examples for main features](examples) + +An example API has been defined using connexion and Flask here: + +[example connexion app](examples/app) + +## Documentation + +[Read the Docs](https://openapi-sqlalchemy.readthedocs.io/en/latest/) + +## Buy me a coffee + +[](https://www.buymeacoffee.com/jdkandersson) + +## Features + +- initializing from JSON, +- initializing from YAML, +- build a package with the models for distribution, packaged as sdist or wheel, +- automatically generate a models file, +- `integer` (32 and 64 bit), +- `number` (float only), +- `boolean`, +- `string`, +- `password`, +- `byte`, +- `binary`, +- `date`, +- `date-time`, +- generic JSON data, +- `$ref` references for columns and models, +- remote `$ref` to other files on the same file system + (_not supported on Windows_), +- remote `$ref` to other files at a URL, +- primary keys, +- auto incrementing, +- indexes, +- composite indexes, +- unique constraints, +- composite unique constraints, +- column nullability, +- foreign keys, +- default values for columns (both application and database side), +- many to one relationships, +- one to one relationships, +- one to many relationships, +- many to many relationships, +- many to many relationships with custom association tables, +- custom foreign keys for relationships, +- back references for relationships, +- `allOf` inheritance for columns and models, +- joined and single table inheritance, +- `from_str` model methods to construct from JSON string, +- `from_dict` model methods to construct from dictionaries, +- `to_str` model methods to convert instances to JSON string, +- `__str__` model methods to support the python `str` function, +- `__repr__` model methods to support the python `repr` function, +- `to_dict` model methods to convert instances to dictionaries, +- `readOnly` and `writeOnly` for influence the conversion to and from + dictionaries, +- exposing created models under `open_alchemy.models` removing the need for + `models.py` files, +- ability to mix in arbitrary classes into a model, +- can use the short `x-` prefix or a namespaced `x-open-alchemy-` prefix for + extension properties and +- grouping models into schemas. + +## Contributing + +Fork and checkout the repository. To install: + +```bash +poetry install +``` + +To run tests: + +```bash +poetry run pytest +``` + +Make your changes and raise a pull request. + +## Compiling Docs + +```bash +poetry shell +cd docs +make html +``` + +This creates the `index.html` file in `docs/build/html/index.html`. + +## Release Commands + +```bash +rm -r dist/* +poetry build +poetry publish +``` + + + +%package help +Summary: Development documents and examples for openalchemy +Provides: python3-openalchemy-doc +%description help +# OpenAlchemy + + + +[](https://openapi-sqlalchemy.readthedocs.io/en/latest/?badge=latest) + + + + +Translates an OpenAPI schema to SQLAlchemy models. + +Supports OpenAPI 3.0 and 3.1. + +Get started with the online editor that will guide you through using your +existing OpenAPI specification to define your database schema and offers +installing your models using `pip`: +[Online Editor](https://editor.openalchemy.io) + +## Installation + +```bash +python -m pip install OpenAlchemy +# To be able to load YAML file +python -m pip install OpenAlchemy[yaml] +``` + +## Example + +For example, given the following OpenAPI specification: + +```yaml +# ./examples/simple/example-spec.yml +openapi: "3.0.0" + +info: + title: Test Schema + description: API to illustrate OpenAlchemy MVP. + version: "0.1" + +paths: + /employee: + get: + summary: Used to retrieve all employees. + responses: + 200: + description: Return all employees from the database. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/Employee" + +components: + schemas: + Employee: + description: Person that works for a company. + type: object + x-tablename: employee + properties: + id: + type: integer + description: Unique identifier for the employee. + example: 0 + x-primary-key: true + x-autoincrement: true + name: + type: string + description: The name of the employee. + example: David Andersson + x-index: true + division: + type: string + description: The part of the company the employee works in. + example: Engineering + x-index: true + salary: + type: number + description: The amount of money the employee is paid. + example: 1000000.00 + required: + - id + - name + - division +``` + +The SQLALchemy models file then becomes: + +```python +# models.py +from open_alchemy import init_yaml + +init_yaml("./examples/simple/example-spec.yml") +``` + +The _Base_ and _Employee_ objects can be accessed: + +```python +from open_alchemy.models import Base +from open_alchemy.models import Employee +``` + +With the _models_filename_ parameter a file is auto generated with type hints +for the SQLAlchemy models at the specified location, for example: +[type hinted models example](examples/simple/models_auto.py). This adds support +for IDE auto complete, for example for the model initialization: + + + +and for properties and methods available on an instance: + + + +An extensive set of examples with a range of features is here: + +[examples for main features](examples) + +An example API has been defined using connexion and Flask here: + +[example connexion app](examples/app) + +## Documentation + +[Read the Docs](https://openapi-sqlalchemy.readthedocs.io/en/latest/) + +## Buy me a coffee + +[](https://www.buymeacoffee.com/jdkandersson) + +## Features + +- initializing from JSON, +- initializing from YAML, +- build a package with the models for distribution, packaged as sdist or wheel, +- automatically generate a models file, +- `integer` (32 and 64 bit), +- `number` (float only), +- `boolean`, +- `string`, +- `password`, +- `byte`, +- `binary`, +- `date`, +- `date-time`, +- generic JSON data, +- `$ref` references for columns and models, +- remote `$ref` to other files on the same file system + (_not supported on Windows_), +- remote `$ref` to other files at a URL, +- primary keys, +- auto incrementing, +- indexes, +- composite indexes, +- unique constraints, +- composite unique constraints, +- column nullability, +- foreign keys, +- default values for columns (both application and database side), +- many to one relationships, +- one to one relationships, +- one to many relationships, +- many to many relationships, +- many to many relationships with custom association tables, +- custom foreign keys for relationships, +- back references for relationships, +- `allOf` inheritance for columns and models, +- joined and single table inheritance, +- `from_str` model methods to construct from JSON string, +- `from_dict` model methods to construct from dictionaries, +- `to_str` model methods to convert instances to JSON string, +- `__str__` model methods to support the python `str` function, +- `__repr__` model methods to support the python `repr` function, +- `to_dict` model methods to convert instances to dictionaries, +- `readOnly` and `writeOnly` for influence the conversion to and from + dictionaries, +- exposing created models under `open_alchemy.models` removing the need for + `models.py` files, +- ability to mix in arbitrary classes into a model, +- can use the short `x-` prefix or a namespaced `x-open-alchemy-` prefix for + extension properties and +- grouping models into schemas. + +## Contributing + +Fork and checkout the repository. To install: + +```bash +poetry install +``` + +To run tests: + +```bash +poetry run pytest +``` + +Make your changes and raise a pull request. + +## Compiling Docs + +```bash +poetry shell +cd docs +make html +``` + +This creates the `index.html` file in `docs/build/html/index.html`. + +## Release Commands + +```bash +rm -r dist/* +poetry build +poetry publish +``` + + + +%prep +%autosetup -n openalchemy-2.5.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-openalchemy -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 2.5.0-1 +- Package Spec generated |