You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-14
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,9 @@
1
-
CKAN Data Requests [](https://build.conwet.fi.upm.es/jenkins/job/ckan_datarequests/)
2
-
=====================
1
+
# CKAN Data Requests [](https://build.conwet.fi.upm.es/jenkins/job/ckan_datarequests/)
3
2
4
3
CKAN extension that allows users to ask for datasets that are not already published in the CKAN instance. In this way we can set up a Data Market, not only with data supplies but also with data demands.
5
4
6
-
How it works
7
-
------------
5
+
## How it works
6
+
8
7
You have two ways for creating, updating, deleting, viewing and closing a datarequest: you can use the graphical interface or the programatic API.
9
8
10
9
### User Interface
@@ -14,10 +13,10 @@ If you prefer to use the graphical interface, you should click on the "Data Requ
14
13
***Description**: a long description for your data request. You should include as much details as you can in order to allow others to understand you needs and upload a dataset that fulfil your requeriments.
15
14
***Organization**: in some cases, you want to ask specific data to an specific organization. If you are in such situation, you should complete this field.
16
15
17
-
Once that you have created your data request, you can view it by clicking on the link provided when you created it. When you are the owner of a data request, you will also be able of:
18
-
***Closing the data request** if you consider that there is a new dataset that fulfil your needs
19
-
***Updating the data request** if you can to add/remove some information
20
-
***Deleting the data request** if you do not want it to be available any more
16
+
Once that you have created your data request, you can view it by clicking on the link provided when you created it. When you are the owner of a data request, you will also be able to:
17
+
***Close the data request** if you consider that there is a new dataset that fulfil your needs
18
+
***Update the data request** if you can to add/remove some information
19
+
***Delete the data request** if you do not want it to be available any more
21
20
22
21
### API
23
22
On the other hand, you can also use the API. To access this API, you should POST the following URL (as you do for other actions):
@@ -156,8 +155,8 @@ Action to delete a comment of a data request. Access rights will be checked befo
156
155
##### Returns:
157
156
A dict with the data request comment (`id`, `user_id`, `datarequest_id`, `time` and `comment`)
158
157
159
-
Installation
160
-
------------
158
+
## Installation
159
+
161
160
Install this extension in your CKAN instance is as easy as intall any other CKAN extension.
162
161
163
162
* Activate your virtual environment
@@ -193,8 +192,8 @@ sudo service apache2 restart
193
192
```
194
193
* That's All!
195
194
196
-
Translations
197
-
------------
195
+
## Translations
196
+
198
197
Help us to translate this extension so everyone can create data requests. Currently, the extension is translated to English and Spanish. If you want to contribute with your translation, the first step is to close this repo. Then, create the locale for your translation by executing:
This will generate the required `mo` file. Once this file has been generated, commit your changes and create a Pull Request.
218
217
219
-
Tests
220
-
-----
218
+
## Tests
219
+
221
220
This sofware contains a set of test to detect errors and failures. You can run this tests by running the following command (this command will generate coverage reports):
222
221
```
223
222
python setup.py nosetests
224
223
```
225
224
**Note:** The `test.ini` file contains a link to the CKAN `test-core.ini` file. You will need to change that link to the real path of the file in your system (generally `/usr/lib/ckan/default/src/ckan/test-core.ini`).
0 commit comments