README.md 1.06 KB
Newer Older
Hervé Ménager's avatar
Hervé Ménager committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
BioDBLinks
==========

BioDBLinks is a Django app to help connect a bio-related django-based database
with other existing references databases.


Quick start
-----------

1. Add "polls" to your INSTALLED_APPS setting like this:

```python
INSTALLED_APPS = [
    ...
    'biodblinks',
]
```

2. Add the various configuration variables to the settings:

```python
# Django BioDbLinks settings
24
25
26
27
28
LABLINKS_ID_PREFIX = "https://biodbexample.org"
LABLINKS_PROVIDER_ID = "XXXX"
LABLINKS_RESOURCE_NAME = "BioDB"
LABLINKS_RESOURCE_DESCRIPTION = "BioDB : An example database"
LABLINKS_CONTACT_EMAIL = "curation@biodbexample.org"
Hervé Ménager's avatar
Hervé Ménager committed
29
30
31
32
33
34
35
36
37
38
39
40
41
```

3. Create a LabsLink export command for your data, in the `management/commands`
   folder of the relevant application. The only thing you need to declare is a 
   subclass of LabsLinkCommand with a queryset class property that generates 
   for each link the following fields, to be used in the _links_ file:
   - title
   - url
   - record_id and record_source
   - or doi
   An example command is available in the `biodblinks/tests/test_lablinks.py` 
   file.

Hervé  MENAGER's avatar
Hervé MENAGER committed
42