Invenio-Drafts-Resources

https://img.shields.io/travis/inveniosoftware/Invenio-Drafts-Resources.svg https://img.shields.io/coveralls/inveniosoftware/Invenio-Drafts-Resources.svg https://img.shields.io/github/tag/inveniosoftware/Invenio-Drafts-Resources.svg https://img.shields.io/pypi/dm/Invenio-Drafts-Resources.svg https://img.shields.io/github/license/inveniosoftware/Invenio-Drafts-Resources.svg

Invenio Drafts Resources module to create REST APIs

TODO: Please provide feature overview of module

Further documentation is available on https://Invenio-Drafts-Resources.readthedocs.io/

User’s Guide

This part of the documentation will show you how to get started in using Invenio-Drafts-Resources.

Installation

Invenio-Drafts-Resources is on PyPI so all you need is:

$ pip install invenio-drafts-resources[opensearch2,postgresql]

Configuration

Usage

Invenio Drafts Resources module to create REST APIs.

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

API Docs

Additional Notes

Notes on how to contribute, legal information and changes are here for the interested.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

Report bugs at https://github.com/inveniosoftware/Invenio-Drafts-Resources/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Invenio-Drafts-Resources could always use more documentation, whether as part of the official Invenio-Drafts-Resources docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/inveniosoftware/Invenio-Drafts-Resources/issues.

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up Invenio-Drafts-Resources for local development.

  1. Fork the inveniosoftware/Invenio-Drafts-Resources repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/Invenio-Drafts-Resources.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv Invenio-Drafts-Resources
$ cd Invenio-Drafts-Resources/
$ pip install -e .[all]

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass tests:

    $ ./run-tests.sh

    The tests will provide you with test coverage and also check PEP8 (code style), PEP257 (documentation), flake8 as well as build the Sphinx documentation and run doctests.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -s
    -m "component: title without verbs"
    -m "* NEW Adds your new feature."
    -m "* FIX Fixes an existing issue."
    -m "* BETTER Improves and existing feature."
    -m "* Changes something that should not be visible in release notes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests and must not decrease test coverage.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.

  3. The pull request should work for Python 2.7, 3.5 and 3.6. Check https://travis-ci.org/inveniosoftware/Invenio-Drafts-Resources/pull_requests and make sure that the tests pass for all supported Python versions.

Changes

Version 1.11.0 (2023-09-21)

  • resources: add etag headers

  • resources: add search request param to schema

Version 1.10.1 (2023-09-18)

  • models: avoid flushing when getting records

Version 1.10.0 (2023-09-05)

  • uow: add ParentRecordCommitOp uow

Version 1.9.0 (2023-09-05)

  • service: allow passing of ‘extra_filter’ via kwargs to searches

Version 1.8.1 (2023-08-25)

  • tasks: add margin time window for search to purge deleted documents

  • services: move reindex latest records from records-resources

Version 1.8.0 (2023-08-16)

  • components: conditional lock of files

  • components: refactor file workflow

Version 1.7.1 (2023-08-14)

  • fix an issue where the next version of the draft is incorrectly set

Version 1.7.0 (2023-08-10)

  • records: read_latest method now accepts parent_id and it will return the latest version of a record also by parent_id

  • change error message when publishing with missing files, depending if the record can be metadata only

Version 1.6.0 (2023-07-21)

  • Add parent id resolver

Version 1.5.0 (2023-07-11)

  • add media files components

Version 1.4.2 (2023-07-05)

  • transifex: update config

  • components: add default files enabled variable

Version 1.4.1 (2023-06-06)

  • fix permission check for managing files

Version 1.4.0 (2023-04-25)

  • upgrade invenio-records-resources

  • ensure testing of file indexing

Version 1.3.0 (2023-04-20)

  • upgrade invenio-records-resources

Version 1.2.0 (2023-03-24)

  • bump invenio-records-resources to v2.0.0

Version 1.1.1 (2023-03-03)

  • permissions: add can manage files permission to the draft

Version 1.1.0 (2023-03-02)

  • remove deprecated flask-babelex dependency and imports

  • install invenio-i18n explicitly

Version 1.0.4 (2023-02-22)

  • service: allow to ignore field-level permission checks in validate_draft

  • files: publishing files pending download from Fetch

Version 1.0.3 (2022-12-02)

  • Fix rebuild index memory usage

Version 1.0.2 (2022-11-25)

  • Add i18n translations.

Version 1.0.1 (2022-11-15)

  • Use bulk indexing for service rebuild_index method.

Version 1.0.0 (2022-11-04)

  • Bump invenio-records-resources version

Version 0.2.2 (2020-08-19)

  • Fix support for Elasticsearch 6 and 7

Version 0.2.1 (2020-08-18)

  • Initial public release.

License

MIT License

Copyright (C) 2020 CERN. Copyright (C) 2020 Northwestern University.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Note

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

Authors

Invenio Records Resources module to create REST APIs