Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve the documentation #30

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 47 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Install
Choose a version of elasticsearch and a DB, then run:

.. code-block:: console

pipenv run pip install -e .[all]
pipenv run pip install invenio-search[elasticsearch7]
pipenv run pip install invenio-db[postgresql,versioning]
Expand All @@ -51,4 +51,49 @@ Tests

.. code-block:: console

pipenv run ./run-tests.sh
pipenv run ./run-tests.sh

Features
========

This package serves as a MARC21 datamodel for the repository. Following features
are already implemented:

- [ ] create a record

- [ ] over rest API
- [ ] over GUI

- [ ] modify a record

- [ ] over rest API
- [ ] over GUI

- [ ] inherit from the global permission system and customize it if necessary

- [ ] create a curator for marc21 records over the normal interface for it
- [ ] inherit ownership of records
- [ ] lock records / make read only

- [ ] landing page

- [ ] export record as json

- [ ] search about a record

- [ ] create a search page only for marc21 records
- [ ] make records findable also in the common search (search over all
standards used in the repository)

- [ ] add records to a community
- [ ] validate records
- [ ] add a DOI

- [ ] with a special DOI schema (e.g. PREFIX/oer-NUMBER)

- [ ] provide the records to the OAI-PMH server


Examples where this packages is already used:

- <https://github.com/tu-graz-library/invenio-alma>