..
This file is part of Invenio.
Copyright (C) 2015-2018 CERN.
Invenio is free software; you can redistribute it and/or modify it
under the terms of the MIT License; see LICENSE file for more details.
======================
Invenio-Records-REST
======================
.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-records-rest.svg
:target: https://github.com/inveniosoftware/invenio-records-rest/blob/master/LICENSE
.. image:: https://github.com/inveniosoftware/invenio-records-rest/workflows/CI/badge.svg
:target: https://github.com/inveniosoftware/invenio-records-rest/actions?query=workflow%3ACI
.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-records-rest.svg
:target: https://coveralls.io/r/inveniosoftware/invenio-records-rest
.. image:: https://img.shields.io/pypi/v/invenio-records-rest.svg
:target: https://pypi.org/pypi/invenio-records-rest
REST API for Invenio-Records.
Further documentation is available on
https://invenio-records-rest.readthedocs.io/.
..
This file is part of Invenio.
Copyright (C) 2015-2023 CERN.
Copyright (C) 2024 Graz University of Technology.
Invenio is free software; you can redistribute it and/or modify it
under the terms of the MIT License; see LICENSE file for more details.
Changes
=======
Version 3.0.0 (2024-12-09)
- tests: fix sneaking in indices
- tests: remove before_first_request use
- tests: apply changes for sqlalchemy>=2.0
- setup: change to reusable workflows
- setup: bump major dependencies
Version 2.4.1 (2024-05-08)
- marhsmallow: remove deprecation warning
Version 2.4.0 (2023-12-08)
- facet: Allow more than one possibility on range facets
- search: possibility to specify a different query_parser
- facets: New parameter, RECORDS_REST_FACETS_FILTER, to filter the facets based on a category based on all the other categories
- i18n-global: add compile-catalog fuzzy (#323)
Version 2.3.1 (2023-11-10)
- facets: apply some fixes on nested filter
Version 2.3.0 (2023-11-07)
- facets: add a new filter for nested filters
Version 2.2.0 (2023-03-03)
- remove deprecated flask-babelex dependency and imports
- upgrade invenio-i18n
Version 2.1.0 (2022-10-03)
- Add support to OpenSearch v2
- Remove `search_type` param
Version 2.0.2 (2022-09-28)
- Bump invenio-indexer
Version 2.0.1 (2022-09-27)
- Bump invenio-records
Version 2.0.0 (2022-09-24)
- Add support for OpenSearch
- Drop support for Elasticsearch < 7
- Upper pin Invenio dependencies
- Rename all occurrences of Elasticsearch to `search`
- Remove iterator from `MarshmallowErrors` class
- Breaking: rename func `check_elasticsearch` to `check_search`,
conf `RECORDS_REST_ELASTICSEARCH_ERROR_HANDLERS` to
`RECORDS_REST_SEARCH_ERROR_HANDLERS`
- Fix CI tests
Version 1.9.0 (2021-11-29)
- Fixes `MarshmallowErrors.get_body` due to Werkzeug 2.0.x changes
- Upgrade invenio packages
- Upgrade cite-proc
Version 1.8.0 (2020-12-09)
- Adds Cache-Control: 'no-cache' header to 200 responses to
ensure that browsers will not cache responses client side.
- Unpins the ftfy library.
Version 1.7.2 (2020-08-28)
- Fixes an issue with record PID resolution error handling.
- URL PID converter is now "lazier" and initializes its internal resolver via a
property.
- Fixes classifiers to reflect Python verisons
Version 1.7.1 (released 2020-05-07)
- Sphinx set to ``<3`` because of errors related to application context
- Stop using example app
Version 1.7.0 (released 2020-03-13)
- Removes support for python 2.7
- Centralises management of Flask dependency by invenio-base
Version 1.6.4 (released 2019-12-11)
- Fixes loaders error payload to add support for nested fields
Version 1.6.3 (released 2019-11-19)
- Upgrades `six` package minimal version
Version 1.6.2 (released 2019-10-02)
- Changes PID field in Marshmallow Schema to String instead of Integer.
Version 1.6.1 (released 2019-09-23)
- Fixes wrong `size` url arg upper limit
- Upgrades `invenio-rest` dependency
Version 1.6.0 (released 2019-09-11)
- Adds support to serialization using Marshmallow with versions 2 and 3
- Enables to choose response search serializer via url argument
Version 1.5.0 (released 2019-08-02)
- Adds improved support for infinite scroll
- Adds ES7 support
- Adds CSV serializer
- Adds ``record`` to marshmallow context
- Uses html allowed tags and attributes for bleach from config
Version 1.4.2 (released 2019-05-07)
- Marshmallow JSON schema: add getter method to customize and retrieve the PID
field name per schema.
Version 1.4.1 (released 2019-04-02)
- Added ``RECORDS_REST_DEFAULT_RESULTS_SIZE`` variable to change the default
``size`` of the search results. The default value remains ``10``.
Version 1.4.0 (released 2019-02-22)
- Removed unused resolver parameter from views classes.
- Improved documentation of record_class in URL patterns.
Version 1.3.0 (released 2018-12-14)
- Enhance Elasticsearch error handling.
- Refactor Marshmallow schemas to allow PID injection.
Version 1.2.2 (released 2018-11-16)
- Changes ``str`` to ``text_type`` on filter dsl.
Version 1.2.1 (released 2018-09-17)
- Adds source filtering support for ES 5.
Version 1.2.0 (released 2018-08-24)
- Adds PersistentIdentifier field to handle record PIDs.
- Adds Nested class to improve reporting of validation errors.
Version 1.1.2 (released 2018-06-26)
- Rename authentication of GET operation over
RecordsListResource from 'read_list' to 'list'.
Version 1.1.1 (released 2018-06-25)
- Adds authentication to GET operation over
RecordsListResource.
- Bumps invenio-db version (min v1.0.2).
Version 1.1.0 (released 2018-05-26)
- Moves RecordSchemaJSONV1 marshmallow schema from
invenio_records_rest.serializers.schemas to
invenio_records_rest.schemas.
- Fixes missing API documentation.
- Adds blueprint factory (requires Invenio-Base v1.0.1+).
- Adds marshmallow loaders, fields and schemas.
Version 1.0.1 (released 2018-03-27)
- Fixes unicode query handling
- Fixes Datacite v4.1 serialization
Version 1.0.0 (released 2018-03-23)
- Initial public release.
Raw data
{
"_id": null,
"home_page": "https://github.com/inveniosoftware/invenio-records-rest",
"name": "invenio-records-rest",
"maintainer": null,
"docs_url": "https://pythonhosted.org/invenio-records-rest/",
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "invenio api",
"author": "CERN",
"author_email": "info@inveniosoftware.org",
"download_url": "https://files.pythonhosted.org/packages/21/60/5c237cdaef7068a5290e56d3d3b149704c04ba55343b99b9031d3860aa24/invenio_records_rest-3.0.0.tar.gz",
"platform": "any",
"description": "..\n This file is part of Invenio.\n Copyright (C) 2015-2018 CERN.\n\n Invenio is free software; you can redistribute it and/or modify it\n under the terms of the MIT License; see LICENSE file for more details.\n\n======================\n Invenio-Records-REST\n======================\n\n.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-records-rest.svg\n :target: https://github.com/inveniosoftware/invenio-records-rest/blob/master/LICENSE\n\n.. image:: https://github.com/inveniosoftware/invenio-records-rest/workflows/CI/badge.svg\n :target: https://github.com/inveniosoftware/invenio-records-rest/actions?query=workflow%3ACI\n\n.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-records-rest.svg\n :target: https://coveralls.io/r/inveniosoftware/invenio-records-rest\n\n.. image:: https://img.shields.io/pypi/v/invenio-records-rest.svg\n :target: https://pypi.org/pypi/invenio-records-rest\n\nREST API for Invenio-Records.\n\nFurther documentation is available on\nhttps://invenio-records-rest.readthedocs.io/.\n\n\n..\n This file is part of Invenio.\n Copyright (C) 2015-2023 CERN.\n Copyright (C) 2024 Graz University of Technology.\n\n Invenio is free software; you can redistribute it and/or modify it\n under the terms of the MIT License; see LICENSE file for more details.\n\nChanges\n=======\n\nVersion 3.0.0 (2024-12-09)\n\n- tests: fix sneaking in indices\n- tests: remove before_first_request use\n- tests: apply changes for sqlalchemy>=2.0\n- setup: change to reusable workflows\n- setup: bump major dependencies\n\nVersion 2.4.1 (2024-05-08)\n\n- marhsmallow: remove deprecation warning\n\nVersion 2.4.0 (2023-12-08)\n\n- facet: Allow more than one possibility on range facets\n- search: possibility to specify a different query_parser\n- facets: New parameter, RECORDS_REST_FACETS_FILTER, to filter the facets based on a category based on all the other categories\n- i18n-global: add compile-catalog fuzzy (#323)\n\nVersion 2.3.1 (2023-11-10)\n\n- facets: apply some fixes on nested filter\n\nVersion 2.3.0 (2023-11-07)\n\n- facets: add a new filter for nested filters\n\nVersion 2.2.0 (2023-03-03)\n\n- remove deprecated flask-babelex dependency and imports\n- upgrade invenio-i18n\n\nVersion 2.1.0 (2022-10-03)\n\n- Add support to OpenSearch v2\n- Remove `search_type` param\n\nVersion 2.0.2 (2022-09-28)\n\n- Bump invenio-indexer\n\nVersion 2.0.1 (2022-09-27)\n\n- Bump invenio-records\n\nVersion 2.0.0 (2022-09-24)\n\n- Add support for OpenSearch\n- Drop support for Elasticsearch < 7\n- Upper pin Invenio dependencies\n- Rename all occurrences of Elasticsearch to `search`\n- Remove iterator from `MarshmallowErrors` class\n- Breaking: rename func `check_elasticsearch` to `check_search`,\n conf `RECORDS_REST_ELASTICSEARCH_ERROR_HANDLERS` to\n `RECORDS_REST_SEARCH_ERROR_HANDLERS`\n- Fix CI tests\n\nVersion 1.9.0 (2021-11-29)\n\n- Fixes `MarshmallowErrors.get_body` due to Werkzeug 2.0.x changes\n- Upgrade invenio packages\n- Upgrade cite-proc\n\nVersion 1.8.0 (2020-12-09)\n\n- Adds Cache-Control: 'no-cache' header to 200 responses to\n ensure that browsers will not cache responses client side.\n\n- Unpins the ftfy library.\n\nVersion 1.7.2 (2020-08-28)\n\n- Fixes an issue with record PID resolution error handling.\n- URL PID converter is now \"lazier\" and initializes its internal resolver via a\n property.\n- Fixes classifiers to reflect Python verisons\n\nVersion 1.7.1 (released 2020-05-07)\n\n- Sphinx set to ``<3`` because of errors related to application context\n- Stop using example app\n\nVersion 1.7.0 (released 2020-03-13)\n\n- Removes support for python 2.7\n- Centralises management of Flask dependency by invenio-base\n\nVersion 1.6.4 (released 2019-12-11)\n\n- Fixes loaders error payload to add support for nested fields\n\nVersion 1.6.3 (released 2019-11-19)\n\n- Upgrades `six` package minimal version\n\nVersion 1.6.2 (released 2019-10-02)\n\n- Changes PID field in Marshmallow Schema to String instead of Integer.\n\nVersion 1.6.1 (released 2019-09-23)\n\n- Fixes wrong `size` url arg upper limit\n- Upgrades `invenio-rest` dependency\n\nVersion 1.6.0 (released 2019-09-11)\n\n- Adds support to serialization using Marshmallow with versions 2 and 3\n- Enables to choose response search serializer via url argument\n\nVersion 1.5.0 (released 2019-08-02)\n\n- Adds improved support for infinite scroll\n- Adds ES7 support\n- Adds CSV serializer\n- Adds ``record`` to marshmallow context\n- Uses html allowed tags and attributes for bleach from config\n\nVersion 1.4.2 (released 2019-05-07)\n\n- Marshmallow JSON schema: add getter method to customize and retrieve the PID\n field name per schema.\n\nVersion 1.4.1 (released 2019-04-02)\n\n- Added ``RECORDS_REST_DEFAULT_RESULTS_SIZE`` variable to change the default\n ``size`` of the search results. The default value remains ``10``.\n\nVersion 1.4.0 (released 2019-02-22)\n\n- Removed unused resolver parameter from views classes.\n- Improved documentation of record_class in URL patterns.\n\nVersion 1.3.0 (released 2018-12-14)\n\n- Enhance Elasticsearch error handling.\n- Refactor Marshmallow schemas to allow PID injection.\n\nVersion 1.2.2 (released 2018-11-16)\n\n- Changes ``str`` to ``text_type`` on filter dsl.\n\nVersion 1.2.1 (released 2018-09-17)\n\n- Adds source filtering support for ES 5.\n\nVersion 1.2.0 (released 2018-08-24)\n\n- Adds PersistentIdentifier field to handle record PIDs.\n- Adds Nested class to improve reporting of validation errors.\n\nVersion 1.1.2 (released 2018-06-26)\n\n- Rename authentication of GET operation over\n RecordsListResource from 'read_list' to 'list'.\n\nVersion 1.1.1 (released 2018-06-25)\n\n- Adds authentication to GET operation over\n RecordsListResource.\n- Bumps invenio-db version (min v1.0.2).\n\nVersion 1.1.0 (released 2018-05-26)\n\n- Moves RecordSchemaJSONV1 marshmallow schema from\n invenio_records_rest.serializers.schemas to\n invenio_records_rest.schemas.\n- Fixes missing API documentation.\n- Adds blueprint factory (requires Invenio-Base v1.0.1+).\n- Adds marshmallow loaders, fields and schemas.\n\nVersion 1.0.1 (released 2018-03-27)\n\n- Fixes unicode query handling\n- Fixes Datacite v4.1 serialization\n\nVersion 1.0.0 (released 2018-03-23)\n\n- Initial public release.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\"REST API for invenio-records.\"",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/inveniosoftware/invenio-records-rest"
},
"split_keywords": [
"invenio",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5602aa30a4df0d4fb0a53d470653338742270e66c5b168b4af01f3f4d9530d1c",
"md5": "af34fdae3a6087cae2ca8df9ce703f08",
"sha256": "c4dbaba0a83e0a732906697851867a5e1d4474925abc949ac3ebc4fac2d0494d"
},
"downloads": -1,
"filename": "invenio_records_rest-3.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "af34fdae3a6087cae2ca8df9ce703f08",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 65670,
"upload_time": "2024-12-09T08:22:34",
"upload_time_iso_8601": "2024-12-09T08:22:34.452995Z",
"url": "https://files.pythonhosted.org/packages/56/02/aa30a4df0d4fb0a53d470653338742270e66c5b168b4af01f3f4d9530d1c/invenio_records_rest-3.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21605c237cdaef7068a5290e56d3d3b149704c04ba55343b99b9031d3860aa24",
"md5": "b0acf6809aacc30d6e396482a11eb36b",
"sha256": "69c09a50f568b5cbf8e6d8bee2360e2725ce415b2c63e2d40aaf28a45e6cec7d"
},
"downloads": -1,
"filename": "invenio_records_rest-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b0acf6809aacc30d6e396482a11eb36b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 86929,
"upload_time": "2024-12-09T08:22:35",
"upload_time_iso_8601": "2024-12-09T08:22:35.792448Z",
"url": "https://files.pythonhosted.org/packages/21/60/5c237cdaef7068a5290e56d3d3b149704c04ba55343b99b9031d3860aa24/invenio_records_rest-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 08:22:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "inveniosoftware",
"github_project": "invenio-records-rest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "invenio-records-rest"
}