invenio-records-resources


Nameinvenio-records-resources JSON
Version 6.4.0 PyPI version JSON
download
home_pagehttps://github.com/inveniosoftware/invenio-records-resources
SummaryInvenio resources module to create REST APIs.
upload_time2024-11-08 14:00:44
maintainerNone
docs_urlNone
authorCERN
requires_python>=3.7
licenseMIT
keywords invenio records rest api_blueprints
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
    Copyright (C) 2020 CERN.

    Invenio-Records-Resources 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-Resources
==========================

.. image:: https://github.com/inveniosoftware/invenio-records-resources/workflows/CI/badge.svg
        :target: https://github.com/inveniosoftware/invenio-records-resources/actions?query=workflow%3ACI

.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-records-resources.svg
        :target: https://coveralls.io/r/inveniosoftware/invenio-records-resources

.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-records-resources.svg
        :target: https://github.com/inveniosoftware/invenio-records-resources/releases

.. image:: https://img.shields.io/pypi/dm/invenio-records-resources.svg
        :target: https://pypi.python.org/pypi/invenio-records-resources

.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-records-resources.svg
        :target: https://github.com/inveniosoftware/invenio-records-resources/blob/master/LICENSE

Invenio Resources module to create REST APIs

TODO: Please provide feature overview of module

Further documentation is available on
https://invenio-records-resources.readthedocs.io/

..
    Copyright (C) 2020-2024 CERN.

    Invenio-Records-Resources 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 v6.4.0 (released 2024-11-08)

- transformer: add new RestrictedTerm and RestrictedTermValue to restrict search for
  individual fields based on permissions

Version v6.3.1 (released 2024-10-01)

- uow: moved Unit of Work pattern and non-record Operations to invenio-db.
  Added backwards compatible imports.

Version v6.3.0 (released 2024-08-08)

- files: sync file access status
- files: syncing metadata changes for uploaded files
- files: update for retriveing files bucket

Version v6.2.0 (released 2024-08-02)

- service: add bulk create/update method

Version v6.1.1 (released 2024-07-30)

- services: reraise permission errors for records

Version 6.1.0 (released 2024-07-05)

- files: sync metadata on file edit

Version 6.0.0 (released 2024-06-04)

- uow: updated Task Operation to use `apply_async` instead of `delay`
- uow: added Revoke Task Operation

Version 5.9.2 (released 2024-05-22)

- isort: fix imports

Version 5.9.1 (released 2024-05-22)

- errors: add error handler for RecordPermissionDeniedError

Version 5.9.0 (released 2024-05-22)

- errors: add RecordPermissionDeniedError

Version 5.8.0 (released 2024-05-21)

- processors: optionally use PyVIPS for image metadata

Version 5.7.0 (released 2024-05-06)

- files-schema: hide `uri` from serialization
- records: added access field to files

Version 5.6.0 (released 2024-04-23)

- services: add support for nested links

Version 5.5.0 (released 2024-04-09)

* records: add calculated system field with indexing; allows calculated system field to cache the value in the index, and
  use the cached value when reading from the index.

Version 5.4.0 (released 2024-03-22)

- installation: upgrade invenio-app, invenio-base, invenio-accounts
  (removes before_first_request_deprecation)

Version 5.3.0 (released 2024-03-20)

- facets: provide new CombinedTermsFacet (facet to use for nested subjects)

Version 5.2.4 (released 2024-02-27)

- processors: updated file metadata extractor to handle multi-sequence images

Version 5.2.3 (released 2024-02-16)

- schema: avoid mutating original data in pre_load

Version 5.2.2 (released 2024-02-09)

- models: restore file record key unique index

Version 5.2.1 (released 2024-02-09)

- models: remove unique constraint for file record key

Version 5.2.0 (released 2024-02-05)

- models: fix record file indices
- models: add index on object_version_id
- tasks: improve exception log grouping

Version 5.1.0 (released 2024-02-02)

- queryparser: add search field value mapping

Version 5.0.0 (released 2024-01-29)

- installation: bump invenio-accounts

Version 4.19.0 (2024-01-18)

- file manager: copy from other bucket to improve performance

Version 4.18.3 (2023-12-13)

- files: limit amount of files in the REST API

Version 4.18.2 (2023-12-08)

- records: allow overriding of permission action for read method

Version 4.18.1 (2023-11-30)

- files: fix unknown extension return value

Version 4.18.0 (2023-11-29)

- custom_fields: fix EDTF datetime field
- files: changed file key type to string
- files archive: handle broken files

Version 4.17.2 (2023-11-21)

- api: add get file extension from key

Version 4.17.1 (2023-11-09)

- api: do not synchronise db session on delete statement

Version 4.17.0 (2023-11-07)

- file manager: add teardown method (optimise performance)
- api: add remove_all to FileRecord (optimise performance)

Version 4.16.3 (2023-10-26)

- files: updated urls for published files
- files: allowing slash in url

Version 4.16.2 (2023-10-25)

- error: improve error wording in `FailedFileUploadException`

Version 4.16.1 (2023-10-25)

- files: abort with 400 on upload failures

Version 4.16.0 (2023-10-23)

- uow: add record delete index op

Version 4.15.0 (2023-10-20)

- base: add possibility to override search options class

Version 4.14.1 (2023-10-19)

- sort: fallback safely to sort_options

Version 4.14.0 (2023-10-19)

- services: custom_fields: date: use parse_edtf from babel-edtf
- params: validate param option against all available options if exist

Version 4.13.0 (2023-10-19)

- resolver: raises `PIDDoesNotExistError` when record is deleted

Version 4.12.0 (2023-10-11)

- setup: upgrade marshmallow-utils

Version 4.11.7 (2023-10-02)

- bump invenio-stats

Version 4.11.6 (2023-10-02)

- components: handle file upload interruption

Version 4.11.5 (2023-09-29)

- service: add `extra_filter` to reindex method

Version 4.11.4 (2023-09-28)

- params: make sort/facets params immutable

Version 4.11.3 (2023-09-19)

- revert fix bool comparison in api

Version 4.11.2 (2023-09-18)

-  api: fix bool comparison

Version 4.11.1 (2023-09-15)

- records: added link template for read_many calls.

Version 4.11.0 (2023-09-14)

- expanded fields: add null checks
- files: set bucket quota
- service: add sort to read_many

Version 4.10.1 (2023-09-12)

- systemfields: revert files dumping
- systemfields: support conditional dumping of files

Version 4.10.0 (2023-09-05)

- uow: run bulk indexing on post commit hook

Version 4.9.1 (2023-09-05)

- files: dump files order and preview only if entries are dumped (revert)

Version 4.9.0 (2023-09-05)

- files: dump files order and preview only if entries are dumped

Version 4.8.0 (2023-08-25)

- services: move reindex latest records to drafts-resources
- processors: make image formats (checked for metadata) configurable (#484)

Version 4.7.0 (2023-08-16)

- Implement file syncing when publishing a record
- Fixes deletion of files to default to soft deletion unless
  the correct flags are being used.

Version 4.6.0 (2023-08-14)

- service: add a method to reindex all record's versions, with the
  latest first.

Version 4.5.0 (2023-07-11)

- relations: reindex by chunk

Version 4.4.0 (2023-07-11)

- make files component file attributes configurable

Version 4.3.0 (2023-06-15)

- upgrade invenio-accounts

Version 4.2.0 (2023-06-02)

- schemas: fix 'size' value not being dumped if it is 0
- expanded fields: add a non-resolvable system record

Version 4.1.0 (2023-05-04)

- add ServiceResultResolver and ServiceResultProxy

Version 4.0.0 (2023-04-24)

- files: add support for files metadata indexing

Version 3.0.0 (2023-04-20)

- query parser: add allow list and fields to fine tune query parsing

Version 2.0.0 (2023-03-24)

- expandable-field: add a new abstractmethod called `ghost_record` that returns the
  unresolvable representation aka "ghost" of the expanding entity.
- global: renames resolvers to entity_resolvers

Version 1.3.1 (2023-03-23)

- custom-fields: control `field_cls` customization

Version 1.3.0 (2023-03-17)

- errors: add FileKeyNotFoundError

Version 1.2.1 (2023-03-14)

- setup: install invenio_stats

Version 1.2.0 (2023-03-13)

- resource: add event emitter for usage statistics calculation

Version 1.1.1 (2023-03-08)

- dependencies: bump flask-resources

Version 1.1.0 (2023-03-02)

- remove deprecated flask-babelex dependency and imports
- upgrade invenio-pidstore, invenio-records-permissions, invenio-i18n, invenio-records

Version 1.0.9 (2023-02-24)

- serialization: remove files URI for local files

Version 1.0.8 (2023-02-13)

- service: add record indexer service mixin

Version 1.0.7 (2023-02-06)

- service utils: add utility to map query parameters to a dictionary based
  on the service config

Version 1.0.6 (2023-01-23)

- resources: add archive download endpoint for record files

Version 1.0.5 (2023-01-10)

- facets: add facet not found exception

Version 1.0.4 (2022-12-19)

- search: added query parse cls to search config

Version 1.0.3 (2022-12-01)

- Breaking change: FieldsResolver.expand() method is changed to require an identity parameter.
- Breaking change: LinksTemplate.expand() method is changed to require an identity parameter.

Version 1.0.2 (2022-11-25)

- Add i18n translations.

Version 1.0.1 (2022-11-15)

- Compute file status based on storage class.
- Use bulk indexing on when rebuilding indices.

Version 1.0.0

- Initial public release.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/inveniosoftware/invenio-records-resources",
    "name": "invenio-records-resources",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "invenio records rest api_blueprints",
    "author": "CERN",
    "author_email": "info@inveniosoftware.org",
    "download_url": "https://files.pythonhosted.org/packages/2f/49/af59fd9a9cb0089feb9a533805e9fbb5fe6bf21b431566497c65eba6ae59/invenio-records-resources-6.4.0.tar.gz",
    "platform": "any",
    "description": "..\n    Copyright (C) 2020 CERN.\n\n    Invenio-Records-Resources is free software; you can redistribute it and/or\n    modify it under the terms of the MIT License; see LICENSE file for more\n    details.\n\n==========================\n Invenio-Records-Resources\n==========================\n\n.. image:: https://github.com/inveniosoftware/invenio-records-resources/workflows/CI/badge.svg\n        :target: https://github.com/inveniosoftware/invenio-records-resources/actions?query=workflow%3ACI\n\n.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-records-resources.svg\n        :target: https://coveralls.io/r/inveniosoftware/invenio-records-resources\n\n.. image:: https://img.shields.io/github/tag/inveniosoftware/invenio-records-resources.svg\n        :target: https://github.com/inveniosoftware/invenio-records-resources/releases\n\n.. image:: https://img.shields.io/pypi/dm/invenio-records-resources.svg\n        :target: https://pypi.python.org/pypi/invenio-records-resources\n\n.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-records-resources.svg\n        :target: https://github.com/inveniosoftware/invenio-records-resources/blob/master/LICENSE\n\nInvenio Resources module to create REST APIs\n\nTODO: Please provide feature overview of module\n\nFurther documentation is available on\nhttps://invenio-records-resources.readthedocs.io/\n\n..\n    Copyright (C) 2020-2024 CERN.\n\n    Invenio-Records-Resources is free software; you can redistribute it and/or\n    modify it under the terms of the MIT License; see LICENSE file for more\n    details.\n\nChanges\n=======\n\nVersion v6.4.0 (released 2024-11-08)\n\n- transformer: add new RestrictedTerm and RestrictedTermValue to restrict search for\n  individual fields based on permissions\n\nVersion v6.3.1 (released 2024-10-01)\n\n- uow: moved Unit of Work pattern and non-record Operations to invenio-db.\n  Added backwards compatible imports.\n\nVersion v6.3.0 (released 2024-08-08)\n\n- files: sync file access status\n- files: syncing metadata changes for uploaded files\n- files: update for retriveing files bucket\n\nVersion v6.2.0 (released 2024-08-02)\n\n- service: add bulk create/update method\n\nVersion v6.1.1 (released 2024-07-30)\n\n- services: reraise permission errors for records\n\nVersion 6.1.0 (released 2024-07-05)\n\n- files: sync metadata on file edit\n\nVersion 6.0.0 (released 2024-06-04)\n\n- uow: updated Task Operation to use `apply_async` instead of `delay`\n- uow: added Revoke Task Operation\n\nVersion 5.9.2 (released 2024-05-22)\n\n- isort: fix imports\n\nVersion 5.9.1 (released 2024-05-22)\n\n- errors: add error handler for RecordPermissionDeniedError\n\nVersion 5.9.0 (released 2024-05-22)\n\n- errors: add RecordPermissionDeniedError\n\nVersion 5.8.0 (released 2024-05-21)\n\n- processors: optionally use PyVIPS for image metadata\n\nVersion 5.7.0 (released 2024-05-06)\n\n- files-schema: hide `uri` from serialization\n- records: added access field to files\n\nVersion 5.6.0 (released 2024-04-23)\n\n- services: add support for nested links\n\nVersion 5.5.0 (released 2024-04-09)\n\n* records: add calculated system field with indexing; allows calculated system field to cache the value in the index, and\n  use the cached value when reading from the index.\n\nVersion 5.4.0 (released 2024-03-22)\n\n- installation: upgrade invenio-app, invenio-base, invenio-accounts\n  (removes before_first_request_deprecation)\n\nVersion 5.3.0 (released 2024-03-20)\n\n- facets: provide new CombinedTermsFacet (facet to use for nested subjects)\n\nVersion 5.2.4 (released 2024-02-27)\n\n- processors: updated file metadata extractor to handle multi-sequence images\n\nVersion 5.2.3 (released 2024-02-16)\n\n- schema: avoid mutating original data in pre_load\n\nVersion 5.2.2 (released 2024-02-09)\n\n- models: restore file record key unique index\n\nVersion 5.2.1 (released 2024-02-09)\n\n- models: remove unique constraint for file record key\n\nVersion 5.2.0 (released 2024-02-05)\n\n- models: fix record file indices\n- models: add index on object_version_id\n- tasks: improve exception log grouping\n\nVersion 5.1.0 (released 2024-02-02)\n\n- queryparser: add search field value mapping\n\nVersion 5.0.0 (released 2024-01-29)\n\n- installation: bump invenio-accounts\n\nVersion 4.19.0 (2024-01-18)\n\n- file manager: copy from other bucket to improve performance\n\nVersion 4.18.3 (2023-12-13)\n\n- files: limit amount of files in the REST API\n\nVersion 4.18.2 (2023-12-08)\n\n- records: allow overriding of permission action for read method\n\nVersion 4.18.1 (2023-11-30)\n\n- files: fix unknown extension return value\n\nVersion 4.18.0 (2023-11-29)\n\n- custom_fields: fix EDTF datetime field\n- files: changed file key type to string\n- files archive: handle broken files\n\nVersion 4.17.2 (2023-11-21)\n\n- api: add get file extension from key\n\nVersion 4.17.1 (2023-11-09)\n\n- api: do not synchronise db session on delete statement\n\nVersion 4.17.0 (2023-11-07)\n\n- file manager: add teardown method (optimise performance)\n- api: add remove_all to FileRecord (optimise performance)\n\nVersion 4.16.3 (2023-10-26)\n\n- files: updated urls for published files\n- files: allowing slash in url\n\nVersion 4.16.2 (2023-10-25)\n\n- error: improve error wording in `FailedFileUploadException`\n\nVersion 4.16.1 (2023-10-25)\n\n- files: abort with 400 on upload failures\n\nVersion 4.16.0 (2023-10-23)\n\n- uow: add record delete index op\n\nVersion 4.15.0 (2023-10-20)\n\n- base: add possibility to override search options class\n\nVersion 4.14.1 (2023-10-19)\n\n- sort: fallback safely to sort_options\n\nVersion 4.14.0 (2023-10-19)\n\n- services: custom_fields: date: use parse_edtf from babel-edtf\n- params: validate param option against all available options if exist\n\nVersion 4.13.0 (2023-10-19)\n\n- resolver: raises `PIDDoesNotExistError` when record is deleted\n\nVersion 4.12.0 (2023-10-11)\n\n- setup: upgrade marshmallow-utils\n\nVersion 4.11.7 (2023-10-02)\n\n- bump invenio-stats\n\nVersion 4.11.6 (2023-10-02)\n\n- components: handle file upload interruption\n\nVersion 4.11.5 (2023-09-29)\n\n- service: add `extra_filter` to reindex method\n\nVersion 4.11.4 (2023-09-28)\n\n- params: make sort/facets params immutable\n\nVersion 4.11.3 (2023-09-19)\n\n- revert fix bool comparison in api\n\nVersion 4.11.2 (2023-09-18)\n\n-  api: fix bool comparison\n\nVersion 4.11.1 (2023-09-15)\n\n- records: added link template for read_many calls.\n\nVersion 4.11.0 (2023-09-14)\n\n- expanded fields: add null checks\n- files: set bucket quota\n- service: add sort to read_many\n\nVersion 4.10.1 (2023-09-12)\n\n- systemfields: revert files dumping\n- systemfields: support conditional dumping of files\n\nVersion 4.10.0 (2023-09-05)\n\n- uow: run bulk indexing on post commit hook\n\nVersion 4.9.1 (2023-09-05)\n\n- files: dump files order and preview only if entries are dumped (revert)\n\nVersion 4.9.0 (2023-09-05)\n\n- files: dump files order and preview only if entries are dumped\n\nVersion 4.8.0 (2023-08-25)\n\n- services: move reindex latest records to drafts-resources\n- processors: make image formats (checked for metadata) configurable (#484)\n\nVersion 4.7.0 (2023-08-16)\n\n- Implement file syncing when publishing a record\n- Fixes deletion of files to default to soft deletion unless\n  the correct flags are being used.\n\nVersion 4.6.0 (2023-08-14)\n\n- service: add a method to reindex all record's versions, with the\n  latest first.\n\nVersion 4.5.0 (2023-07-11)\n\n- relations: reindex by chunk\n\nVersion 4.4.0 (2023-07-11)\n\n- make files component file attributes configurable\n\nVersion 4.3.0 (2023-06-15)\n\n- upgrade invenio-accounts\n\nVersion 4.2.0 (2023-06-02)\n\n- schemas: fix 'size' value not being dumped if it is 0\n- expanded fields: add a non-resolvable system record\n\nVersion 4.1.0 (2023-05-04)\n\n- add ServiceResultResolver and ServiceResultProxy\n\nVersion 4.0.0 (2023-04-24)\n\n- files: add support for files metadata indexing\n\nVersion 3.0.0 (2023-04-20)\n\n- query parser: add allow list and fields to fine tune query parsing\n\nVersion 2.0.0 (2023-03-24)\n\n- expandable-field: add a new abstractmethod called `ghost_record` that returns the\n  unresolvable representation aka \"ghost\" of the expanding entity.\n- global: renames resolvers to entity_resolvers\n\nVersion 1.3.1 (2023-03-23)\n\n- custom-fields: control `field_cls` customization\n\nVersion 1.3.0 (2023-03-17)\n\n- errors: add FileKeyNotFoundError\n\nVersion 1.2.1 (2023-03-14)\n\n- setup: install invenio_stats\n\nVersion 1.2.0 (2023-03-13)\n\n- resource: add event emitter for usage statistics calculation\n\nVersion 1.1.1 (2023-03-08)\n\n- dependencies: bump flask-resources\n\nVersion 1.1.0 (2023-03-02)\n\n- remove deprecated flask-babelex dependency and imports\n- upgrade invenio-pidstore, invenio-records-permissions, invenio-i18n, invenio-records\n\nVersion 1.0.9 (2023-02-24)\n\n- serialization: remove files URI for local files\n\nVersion 1.0.8 (2023-02-13)\n\n- service: add record indexer service mixin\n\nVersion 1.0.7 (2023-02-06)\n\n- service utils: add utility to map query parameters to a dictionary based\n  on the service config\n\nVersion 1.0.6 (2023-01-23)\n\n- resources: add archive download endpoint for record files\n\nVersion 1.0.5 (2023-01-10)\n\n- facets: add facet not found exception\n\nVersion 1.0.4 (2022-12-19)\n\n- search: added query parse cls to search config\n\nVersion 1.0.3 (2022-12-01)\n\n- Breaking change: FieldsResolver.expand() method is changed to require an identity parameter.\n- Breaking change: LinksTemplate.expand() method is changed to require an identity parameter.\n\nVersion 1.0.2 (2022-11-25)\n\n- Add i18n translations.\n\nVersion 1.0.1 (2022-11-15)\n\n- Compute file status based on storage class.\n- Use bulk indexing on when rebuilding indices.\n\nVersion 1.0.0\n\n- Initial public release.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Invenio resources module to create REST APIs.",
    "version": "6.4.0",
    "project_urls": {
        "Homepage": "https://github.com/inveniosoftware/invenio-records-resources"
    },
    "split_keywords": [
        "invenio",
        "records",
        "rest",
        "api_blueprints"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d01306e4dd544112b1b817a5f340a8b0f05c23af77939582ab8a1bed6849eff",
                "md5": "4691605968dce0357d82a7045862f455",
                "sha256": "94e55406f5ffe14bee49db0e8dc8b2a9bd1c5c97a229617249a857c8b6d6aedf"
            },
            "downloads": -1,
            "filename": "invenio_records_resources-6.4.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4691605968dce0357d82a7045862f455",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 221332,
            "upload_time": "2024-11-08T14:00:42",
            "upload_time_iso_8601": "2024-11-08T14:00:42.319867Z",
            "url": "https://files.pythonhosted.org/packages/1d/01/306e4dd544112b1b817a5f340a8b0f05c23af77939582ab8a1bed6849eff/invenio_records_resources-6.4.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2f49af59fd9a9cb0089feb9a533805e9fbb5fe6bf21b431566497c65eba6ae59",
                "md5": "13941940a9ffcbb0c7644587e11b683a",
                "sha256": "03c6e80311a8a5c38c13333f81b79c2277d1f7d100a0cf5c530fce3c1227801d"
            },
            "downloads": -1,
            "filename": "invenio-records-resources-6.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "13941940a9ffcbb0c7644587e11b683a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 146190,
            "upload_time": "2024-11-08T14:00:44",
            "upload_time_iso_8601": "2024-11-08T14:00:44.632470Z",
            "url": "https://files.pythonhosted.org/packages/2f/49/af59fd9a9cb0089feb9a533805e9fbb5fe6bf21b431566497c65eba6ae59/invenio-records-resources-6.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-08 14:00:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "inveniosoftware",
    "github_project": "invenio-records-resources",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "invenio-records-resources"
}
        
Elapsed time: 1.32865s