Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MichalGawor committed Aug 27, 2024
1 parent c9f6277 commit 5cfc08a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ PID's can be passed as parameters to URL query in following formats:
Available endpoints:

`/api/schema`, provides OpenApi 3.0 specification of the API.
`/api/openapi.json`, provides OpenApi 3.0 specification of the API.

`/api/sniff/?pid`, Checks whether PID points to resources in registered repository.

`/api/fetch/?pid`, Fetches all PIDs referenced in the metadata, supports PID and list of PIDs to metadata in formats.

`/api/identify/?pid`, identifies PID (VLO request).

`/api/repostatus/`, dictionary with Registered Repositories as keys and PID:status pairs

## Installation
Install packages by running following commands in the project's root dir (order matters):
Install DOG by running following commands in the project's root dir:
```bash
pip install ./dogapi
pip install ./dogui
pip install ./dogconfig
pip install .
```

## Testing
Expand All @@ -38,4 +38,5 @@ To start the project local installation of `dogapi` and `dogui` is required, con
```bash
python ./dogconfig/manage.py runserver
```
By default DOG homepage should be available at your `localhost:8000` and API endpoints at `localhost:8000/api/<functionality>`
By default DOG homepage should be available at your `localhost:8000` and API endpoints at `localhost:8000/api/<functionality>`

0 comments on commit 5cfc08a

Please sign in to comment.