Name: ckanext-datarequests
Owner: Open Knowledge International
Description: A plugin that allows users to request data that is not published yet
Created: 2015-07-27 14:42:54.0
Updated: 2016-02-04 17:24:33.0
Pushed: 2016-02-05 11:34:19.0
Homepage: null
Size: 170
Language: Python
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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.
You have two ways for creating, updating, deleting, viewing and closing a datarequest: you can use the graphical interface or the programatic API.
If you prefer to use the graphical interface, you should click on the “Data Requests” section that will appear in the header of your CKAN instance. In this section you'll be able to view the current data requests. In addition, there will be a button that will allow you to create a new data request. In the form that will appear, you will have to introduce the following information:
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:
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):
http[s]://[CKAN_HOST]:[CKAN_PORT]/api/action/[ACTION_NAME]
Here you have a brief description of all the implemented actions:
datarequest_create(context, data_dict)
Action to create a new data request. This function checks the access rights of the user before creating the data request. If the user is not allowed, a NotAuthorized
exception will be risen.
In addition, you should note that the parameters will be checked and an exception (ValidationError
) will be risen if some of these parameters are not valid.
data_dict
):title
(string): the title of the data requestdescription
(string): a brief description for your data requestorganization_id
(string): the ID of the organization in case you want to assing the data request to an organization.A dict with the data request (id
, user_id
, title
, description
,organization_id
, open_time
, accepted_dataset
, close_time
, closed
).
datarequest_show(context, data_dict)
Action to retrieve the information of a data request. The only required parameter is the id
of the data request. A NotFound
exception will be risen if the id
is not found.
Access rights will be checked before returning the information and an exception will be risen (NotAuthorized
) if the user is not authorized.
data_dict
):id
(string): the ID of the datarequest to be displayedA dict with the data request (id
, user_id
, title
, description
,organization_id
, open_time
, accepted_dataset
, close_time
, closed
).
datarequest_update(context, data_dict)
Action to update a dara request. The function checks the access rights of the user before updating the data request. If the user is not allowed, a NotAuthorized
exception will be risen
In addition, you should note that the parameters will be checked and an exception (ValidationError
) will be risen if some of these parameters are not valid.
data_dict
):id
(string): the ID of the datarequest to be updatedtitle
(string): the title of the data requestdescription
(string): a brief description for your data requestorganization_id
(string): the ID of the organization in case you want to assing the data request to an organization.A dict with the data request (id
, user_id
, title
, description
,organization_id
, open_time
, accepted_dataset
, close_time
, closed
).
datarequest_index(context, data_dict)
Returns a list with the existing data requests. Rights access will be checked before returning the results. If the user is not allowed, a NotAuthorized
exception will be risen
data_dict
):organization_id
(string) (optional): to filter the result by organizationuser_id
(string) (optional): to filter the result by userclosed
(string) (optional): to filter the result by state (True
: Closed, False
: Open)offset
(int) (optional) (default 0
): the first element to be returnedlimit
(int) (optional) (default 10
): The max number of data requests to be returnedA dict with three fields: result
(a list of data requests), facets
(a list of the facets that can be used) and count
(the total number of existing data requests)
datarequest_delete(context, data_dict)
Action to delete a new dara request. The function checks the access rights of the user before deleting the data request. If the user is not allowed, a NotAuthorized
exception will be risen.
data_dict
):id
(string): the ID of the datarequest to be deletedA dict with the data request (id
, user_id
, title
, description
,organization_id
, open_time
, accepted_dataset
, close_time
, closed
).
datarequest_close(context, data_dict)
Action to close a data request. Access rights will be checked before closing the data request. If the user is not allowed, a NotAuthorized
exception will be risen
data_dict
):id
(string): the ID of the datarequest to be closedaccepted_dataset
(string): The ID of the dataset accepted as solution for the data requestA dict with the data request (id
, user_id
, title
, description
,organization_id
, open_time
, accepted_dataset
, close_time
, closed
).
datarequest_comment(context, data_dict)
Action to create a comment in a data request. Access rights will be checked before creating the comment and a NotAuthorized
exception will be risen if the user is not allowed to create the comment
data_dict
):datarequest_id
(string): the ID of the datarequest to be commentedcomment
(string): The comment to be added to the data requestA dict with the data request comment (id
, user_id
, datarequest_id
, time
and comment
)
datarequest_comment_show(context, data_dict)
Action to retrieve a comment. Access rights will be checked before getting the comment and a NotAuthorized
exception will be risen if the user is not allowed to get the comment
data_dict
):id
(string): The ID of the comment to be retrievedA dict with the following fields: id
, user_id
, datarequest_id
, time
and comment
datarequest_comment_list(context, data_dict)
Action to retrieve all the comments of a data request. Access rights will be checked before getting the comments and a NotAuthorized
exception will be risen if the user is not allowed to read the comments
data_dict
):datarequest_id
(string): The ID of the datarequest whose comments want to be retrievedA list with all the comments of a data request. Every comment is a dict with the following fields: id
, user_id
, datarequest_id
, time
and comment
datarequest_comment_update(context, data_dict)
Action to update a comment of a data request. Access rights will be checked before updating the comment and a NotAuthorized
exception will be risen if the user is not allowed to update the comment
data_dict
):id
(string): The ID of the comment to be updatedcomment
(string): The new commentA dict with the data request comment (id
, user_id
, datarequest_id
, time
and comment
)
datarequest_comment_delete(context, data_dict)
Action to delete a comment of a data request. Access rights will be checked before deleting the comment and a NotAuthorized
exception will be risen if the user is not allowed to delete the comment
data_dict
):id
(string): The ID of the comment to be deletedA dict with the data request comment (id
, user_id
, datarequest_id
, time
and comment
)
Install this extension in your CKAN instance is as easy as intall any other CKAN extension.
Activate your virtual environment
sr/lib/ckan/default/bin/activate
Install the extension
install ckanext-datarequests
Note: If you prefer, you can also download the source code and install the extension manually. To do so, execute the following commands:
t clone https://github.com/conwetlab/ckanext-datarequests.git ckanext-datarequests thon setup.py install
Modify your configuration file (generally in /etc/ckan/default/production.ini
) and add datarequests
in the ckan.plugins
property.
.plugins = datarequests <OTHER_PLUGINS>
Enable or disable the comments system by setting up the ckan.datarequests.comments
property in the configuration file (by default, the comments system is enabled).
.datarequests.comments = [true|false]
Enable or disable a badge to show the number of data requests in the menu by setting up the ckan.datarequests.show_datarequests_badge
property in the configuration file (by default, the badge is not shown).
.datarequests.show_datarequests_badge = [true|false]
Restart your apache2 reserver
service apache2 restart
That's All!
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):
on setup.py nosetests
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
).