Skip to content

Commit

Permalink
Merge branch 'develop' for release 0.3.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Aitor Magán García committed Aug 18, 2017
2 parents 0014234 + 03db821 commit 39bfe7f
Show file tree
Hide file tree
Showing 6 changed files with 514 additions and 17 deletions.
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
CKAN Data Requests [![Build Status](https://build.conwet.fi.upm.es/jenkins/buildStatus/icon?job=ckan_datarequests)](https://build.conwet.fi.upm.es/jenkins/job/ckan_datarequests/)
=====================
# CKAN Data Requests [![Build Status](https://build.conwet.fi.upm.es/jenkins/buildStatus/icon?job=ckan_datarequests)](https://build.conwet.fi.upm.es/jenkins/job/ckan_datarequests/)

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.

How it works
------------
## How it works

You have two ways for creating, updating, deleting, viewing and closing a datarequest: you can use the graphical interface or the programatic API.

### User Interface
Expand All @@ -14,10 +13,10 @@ If you prefer to use the graphical interface, you should click on the "Data Requ
* **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.
* **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.

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:
* **Closing the data request** if you consider that there is a new dataset that fulfil your needs
* **Updating the data request** if you can to add/remove some information
* **Deleting the data request** if you do not want it to be available any more
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:
* **Close the data request** if you consider that there is a new dataset that fulfil your needs
* **Update the data request** if you can to add/remove some information
* **Delete the data request** if you do not want it to be available any more

### API
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):
Expand Down Expand Up @@ -156,8 +155,8 @@ Action to delete a comment of a data request. Access rights will be checked befo
##### Returns:
A dict with the data request comment (`id`, `user_id`, `datarequest_id`, `time` and `comment`)

Installation
------------
## Installation

Install this extension in your CKAN instance is as easy as intall any other CKAN extension.

* Activate your virtual environment
Expand Down Expand Up @@ -193,8 +192,8 @@ sudo service apache2 restart
```
* That's All!
Translations
------------
## Translations
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:
```
Expand All @@ -216,10 +215,17 @@ python setup.py compile_catalog
This will generate the required `mo` file. Once this file has been generated, commit your changes and create a Pull Request.
Tests
-----
## Tests
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):
```
python 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`).
## Changelog
### v0.3.3
* New: German Translation (thanks to @kvlahrosch)
8 changes: 6 additions & 2 deletions bin/setup_and_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ POSTGRES_PORT=${POSTGRES_PORT:=5432}
echo "Downloading CKAN..."
git clone https://github.com/ckan/ckan
cd ckan
git checkout release-v2.5.2
git checkout release-v2.5.3
cd $WD


Expand All @@ -31,7 +31,7 @@ then
if [ ! -d "$CACHE_DIR/$SOLAR_UNZIP_FOLDER" ]
then
# Download the solar installation file if it does not exist
wget --no-verbose --timestamping --directory-prefix=$CACHE_DIR http://ftp.cixug.es/apache/lucene/solr/4.10.4//$FILE
wget --no-verbose --timestamping --directory-prefix=$CACHE_DIR http://archive.apache.org/dist/lucene/solr/4.10.4/$FILE

# Unzip the folder
tar -xf "$CACHE_DIR/$FILE" --directory "$CACHE_DIR"
Expand Down Expand Up @@ -59,6 +59,10 @@ source virtualenv/bin/activate
pip install --upgrade pip


# Force html5lib version to be used
pip install html5lib==0.9999999


echo "Installing CKAN dependencies..."
cd ckan
python setup.py develop
Expand Down
Binary file not shown.
Loading

0 comments on commit 39bfe7f

Please sign in to comment.