diff options
Diffstat (limited to 'python-bento-lib.spec')
| -rw-r--r-- | python-bento-lib.spec | 442 |
1 files changed, 442 insertions, 0 deletions
diff --git a/python-bento-lib.spec b/python-bento-lib.spec new file mode 100644 index 0000000..2da16c7 --- /dev/null +++ b/python-bento-lib.spec @@ -0,0 +1,442 @@ +%global _empty_manifest_terminate_build 0 +Name: python-bento-lib +Version: 7.0.0 +Release: 1 +Summary: A set of common utilities and helpers for Bento platform services. +License: LGPLv3 +URL: https://github.com/bento-platform/bento_lib +Source0: https://mirrors.aliyun.com/pypi/web/packages/4c/7e/a8d31ae588122669b987225377022d7c0abb7831e0ecf4aebfffef281c11/bento_lib-7.0.0.tar.gz +BuildArch: noarch + +Requires: python3-aiohttp +Requires: python3-jsonschema +Requires: python3-psycopg2-binary +Requires: python3-redis +Requires: python3-requests +Requires: python3-Werkzeug +Requires: python3-Django +Requires: python3-djangorestframework +Requires: python3-fastapi +Requires: python3-Flask + +%description +# Bento Library (for Python Bento microservices) + + + +[](https://codecov.io/gh/bento-platform/bento_lib) +[](https://badge.fury.io/py/bento-lib) + +Common utilities and helpers for Bento platform services. + + +## Running Tests + +```bash +python3 -m tox +``` + + +## Releasing + + +### 1. Release Checklist + + * [ ] All tests pass and test coverage has not been reduced + + * [ ] Package version has been updated (following semver) in + `bento_lib/package.cfg` + + * [ ] The latest changes have been merged from the `develop` branch into the + `master` branch + + * [ ] A release has been created, tagged in the format of `v#.#.#` and named + in the format of `Version #.#.#`, listing any changes made, in the GitHub + releases page **tagged from the master branch!** + + +#### 1A. Note on Versioning + +The `bento_lib` project uses [semantic versioning](https://semver.org/) for +releasing. If the API is broken in any way, including minor differences in the +way a function behaves given an identical set of parameters (excluding bugfixes +for unintentional behaviour), the MAJOR version must be incremented. In this +way, we guarantee that projects relying on this API do not accidentally break +upon upgrading. + + +### 2. Releasing automatically + +When a version is tagged on GitHub, a build + release CI pipeline is automatically triggered. +Make sure that the tagged version is a valid semantic versioning translation of the version in +`package.cfg`, and that the versions otherwise match. + + +## Modules + +### `auth` + +`auth` provides Python service middleware for dealing with the Bento authorization service. + +### `drs` + +`drs` provides utilities for fetching data and record metadata from +GA4GH-compatible DRS services, and Bento's own implementation (which has some +non-standard extensions.) + +### `events` + +`events` facilitates JSON-serialized message-passing between Bento +microservices. Serialized objects can be at most 512 MB. + +Events should have a lower-case type which is type-insensitively unique and +adequately describes the associated data. + +All Bento channels are prefixed with `bento.`. + +### `responses` + +`responses` contains standardized error message-generating functions +and exception handling functions for different Python web frameworks. + +### `schemas` + +`schemas` contains common JSON schemas which may be useful to a variety of +different Bento services. + +`schemas.bento` contains Bento-specific schemas, and `schemas.ga4gh` contains +GA4GH-standardized schemas (possibly not exactly to spec.) + +### `search` + +`search` contains definitions, validators, and transformations for the query +syntax for Bento, as well as a transpiler to the `psycopg2` PostgreSQL IR. + +The query syntax for Bento takes advantage of JSON schemas augmented with +additional properties about the field's accessibility and, in the case of +Postgres, how the field maps to a table column (or JSON column sub-field.) + +`search.data_structure` contains code for evaluating a Bento query against a +Python data structure. + +`search.operations` contains constants representing valid search operations one +can allow against particular fields from within an augmented JSON schema. + +`search.postgres` contains a "transpiler" from the Bento query syntax to the +`psycopg2`-provided +[intermediate representation (IR)](https://www.psycopg.org/docs/sql.html) for +PostgreSQL, allowing safe queries against a Postgres database. + +`search.queries` provides definitions for the Bento query AST and some helper +methods for creating and processing ASTs. + +### `types` + +`types` contains Python type hints for different standard Bento +dictionaries/objects. + +### `workflows` + +`workflows` contains common code used for handling workflow metadata processing +and response generation, as well as code associated with Bento's ingestion +routines across the different data services. + + +%package -n python3-bento-lib +Summary: A set of common utilities and helpers for Bento platform services. +Provides: python-bento-lib +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-bento-lib +# Bento Library (for Python Bento microservices) + + + +[](https://codecov.io/gh/bento-platform/bento_lib) +[](https://badge.fury.io/py/bento-lib) + +Common utilities and helpers for Bento platform services. + + +## Running Tests + +```bash +python3 -m tox +``` + + +## Releasing + + +### 1. Release Checklist + + * [ ] All tests pass and test coverage has not been reduced + + * [ ] Package version has been updated (following semver) in + `bento_lib/package.cfg` + + * [ ] The latest changes have been merged from the `develop` branch into the + `master` branch + + * [ ] A release has been created, tagged in the format of `v#.#.#` and named + in the format of `Version #.#.#`, listing any changes made, in the GitHub + releases page **tagged from the master branch!** + + +#### 1A. Note on Versioning + +The `bento_lib` project uses [semantic versioning](https://semver.org/) for +releasing. If the API is broken in any way, including minor differences in the +way a function behaves given an identical set of parameters (excluding bugfixes +for unintentional behaviour), the MAJOR version must be incremented. In this +way, we guarantee that projects relying on this API do not accidentally break +upon upgrading. + + +### 2. Releasing automatically + +When a version is tagged on GitHub, a build + release CI pipeline is automatically triggered. +Make sure that the tagged version is a valid semantic versioning translation of the version in +`package.cfg`, and that the versions otherwise match. + + +## Modules + +### `auth` + +`auth` provides Python service middleware for dealing with the Bento authorization service. + +### `drs` + +`drs` provides utilities for fetching data and record metadata from +GA4GH-compatible DRS services, and Bento's own implementation (which has some +non-standard extensions.) + +### `events` + +`events` facilitates JSON-serialized message-passing between Bento +microservices. Serialized objects can be at most 512 MB. + +Events should have a lower-case type which is type-insensitively unique and +adequately describes the associated data. + +All Bento channels are prefixed with `bento.`. + +### `responses` + +`responses` contains standardized error message-generating functions +and exception handling functions for different Python web frameworks. + +### `schemas` + +`schemas` contains common JSON schemas which may be useful to a variety of +different Bento services. + +`schemas.bento` contains Bento-specific schemas, and `schemas.ga4gh` contains +GA4GH-standardized schemas (possibly not exactly to spec.) + +### `search` + +`search` contains definitions, validators, and transformations for the query +syntax for Bento, as well as a transpiler to the `psycopg2` PostgreSQL IR. + +The query syntax for Bento takes advantage of JSON schemas augmented with +additional properties about the field's accessibility and, in the case of +Postgres, how the field maps to a table column (or JSON column sub-field.) + +`search.data_structure` contains code for evaluating a Bento query against a +Python data structure. + +`search.operations` contains constants representing valid search operations one +can allow against particular fields from within an augmented JSON schema. + +`search.postgres` contains a "transpiler" from the Bento query syntax to the +`psycopg2`-provided +[intermediate representation (IR)](https://www.psycopg.org/docs/sql.html) for +PostgreSQL, allowing safe queries against a Postgres database. + +`search.queries` provides definitions for the Bento query AST and some helper +methods for creating and processing ASTs. + +### `types` + +`types` contains Python type hints for different standard Bento +dictionaries/objects. + +### `workflows` + +`workflows` contains common code used for handling workflow metadata processing +and response generation, as well as code associated with Bento's ingestion +routines across the different data services. + + +%package help +Summary: Development documents and examples for bento-lib +Provides: python3-bento-lib-doc +%description help +# Bento Library (for Python Bento microservices) + + + +[](https://codecov.io/gh/bento-platform/bento_lib) +[](https://badge.fury.io/py/bento-lib) + +Common utilities and helpers for Bento platform services. + + +## Running Tests + +```bash +python3 -m tox +``` + + +## Releasing + + +### 1. Release Checklist + + * [ ] All tests pass and test coverage has not been reduced + + * [ ] Package version has been updated (following semver) in + `bento_lib/package.cfg` + + * [ ] The latest changes have been merged from the `develop` branch into the + `master` branch + + * [ ] A release has been created, tagged in the format of `v#.#.#` and named + in the format of `Version #.#.#`, listing any changes made, in the GitHub + releases page **tagged from the master branch!** + + +#### 1A. Note on Versioning + +The `bento_lib` project uses [semantic versioning](https://semver.org/) for +releasing. If the API is broken in any way, including minor differences in the +way a function behaves given an identical set of parameters (excluding bugfixes +for unintentional behaviour), the MAJOR version must be incremented. In this +way, we guarantee that projects relying on this API do not accidentally break +upon upgrading. + + +### 2. Releasing automatically + +When a version is tagged on GitHub, a build + release CI pipeline is automatically triggered. +Make sure that the tagged version is a valid semantic versioning translation of the version in +`package.cfg`, and that the versions otherwise match. + + +## Modules + +### `auth` + +`auth` provides Python service middleware for dealing with the Bento authorization service. + +### `drs` + +`drs` provides utilities for fetching data and record metadata from +GA4GH-compatible DRS services, and Bento's own implementation (which has some +non-standard extensions.) + +### `events` + +`events` facilitates JSON-serialized message-passing between Bento +microservices. Serialized objects can be at most 512 MB. + +Events should have a lower-case type which is type-insensitively unique and +adequately describes the associated data. + +All Bento channels are prefixed with `bento.`. + +### `responses` + +`responses` contains standardized error message-generating functions +and exception handling functions for different Python web frameworks. + +### `schemas` + +`schemas` contains common JSON schemas which may be useful to a variety of +different Bento services. + +`schemas.bento` contains Bento-specific schemas, and `schemas.ga4gh` contains +GA4GH-standardized schemas (possibly not exactly to spec.) + +### `search` + +`search` contains definitions, validators, and transformations for the query +syntax for Bento, as well as a transpiler to the `psycopg2` PostgreSQL IR. + +The query syntax for Bento takes advantage of JSON schemas augmented with +additional properties about the field's accessibility and, in the case of +Postgres, how the field maps to a table column (or JSON column sub-field.) + +`search.data_structure` contains code for evaluating a Bento query against a +Python data structure. + +`search.operations` contains constants representing valid search operations one +can allow against particular fields from within an augmented JSON schema. + +`search.postgres` contains a "transpiler" from the Bento query syntax to the +`psycopg2`-provided +[intermediate representation (IR)](https://www.psycopg.org/docs/sql.html) for +PostgreSQL, allowing safe queries against a Postgres database. + +`search.queries` provides definitions for the Bento query AST and some helper +methods for creating and processing ASTs. + +### `types` + +`types` contains Python type hints for different standard Bento +dictionaries/objects. + +### `workflows` + +`workflows` contains common code used for handling workflow metadata processing +and response generation, as well as code associated with Bento's ingestion +routines across the different data services. + + +%prep +%autosetup -n bento_lib-7.0.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-bento-lib -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 7.0.0-1 +- Package Spec generated |