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
Development work on CoVE by Open Data Services is carried out in sprints. The issues for each sprint can be found at https://github.com/OpenDataServices/cove/projects . Other work is carried out from time to time, and contributions from the community are welcome. Outstanding issues for CoVE can be found at https://github.com/OpenDataServices/cove/issues . Please report any bugs!
15
4
16
5
Introduction
17
6
============
18
7
19
-
CoVE is an web application to Convert, Validate and Explore data following certain open data standards - currently 360Giving and the Open Contracting Data standard. http://cove.opendataservices.coop
8
+
CoVE is an web application to Convert, Validate and Explore data following certain open data standards. http://cove.opendataservices.coop
20
9
21
10
Why convert data?
22
11
+++++++++++++++++
@@ -45,111 +34,6 @@ User Flows
45
34
46
35
Overviews of how users flow through the application are maintained at https://docs.google.com/drawings/d/1pVbEu6dJaVk8t3NctjYuE5irsqltc9Th0gVQ_zeJyFA/edit and https://docs.google.com/drawings/d/1wFH4lZlBZWso7Tj_g7CyTF3YaFfnly59sVufpztmEg8/edit
47
36
48
-
Putting code live
49
-
=================
50
-
51
-
There are live instances at:
52
-
https://dataquality.threesixtygiving.org/
53
-
http://standard.open-contracting.org/review/
54
-
https://iati.cove.opendataservices.coop/
55
-
56
-
Code is deployed to live when it is merged into the master branch. (Instructions on how to do this at https://cove.readthedocs.io/en/latest/deployment/).
57
-
58
-
Feature requests, bugs, questions and answers etc are all handled via GitHub.
59
-
60
-
Requirements
61
-
============
62
-
This application is built using Django and Python 3.5
63
-
64
-
Installation
65
-
============
66
-
Steps to installation:
67
-
68
-
* Clone the repository
69
-
* Change into the cloned repository
70
-
* Create a virtual environment (note this application uses python3)
71
-
* Activate the virtual environment
72
-
* Install dependencies
73
-
* Set up the database (sqlite3) (you need to pass the django settings for the module (ie. 360, iati) you want to run)
We also use flake8 to test code quality, see https://github.com/OpenDataServices/developer-docs/blob/master/tests.md#flake8
147
-
148
-
The development requirements include xdist to allow running tests in parallel:
149
-
150
-
.. code:: bash
151
-
152
-
py.test -n2
153
37
154
38
Translations
155
39
============
@@ -159,7 +43,7 @@ Translations
159
43
160
44
Translations for Translators
161
45
++++++++++++++++++++++++++++
162
-
Translators can provide translations for this application by becomming a collaborator on Transifex https://www.transifex.com/OpenDataServices/cove
46
+
Translators can provide translations for this application by becoming a collaborator on Transifex https://www.transifex.com/OpenDataServices/cove
163
47
164
48
Translations for Developers
165
49
+++++++++++++++++++++++++++
@@ -206,59 +90,4 @@ To check that all new text is written so that it is able to be translated you co
206
90
.. code:: bash
207
91
208
92
pip install django-template-i18n-lint
209
-
django-template-i18n-lint cove
210
-
211
-
Adding and updating requirements
212
-
================================
213
-
214
-
Add a new requirements to ``requirements.in`` or ``requirements_dev.in`` depending on whether it is just a development requirement or not.
215
-
216
-
217
-
Then, run ``./update_requirements --new-only`` this will populate ``requirements.txt`` and/or ``requirements_dev.txt`` with pinned versions of the new requirement and it's dependencies.
218
-
219
-
WARNING: The ``./update_requirements`` script will delete and recreate your current ``.ve`` directory.
220
-
221
-
``./update_requirements`` without any flags will update all pinned requirements to the latest version. Generally we don't want to do this at the same time as adding a new dependency, to make testing any problems easier.
222
-
223
-
224
-
Command Line Interface
225
-
======================
226
-
227
-
**IATI**
228
-
229
-
.. code:: bash
230
-
231
-
./iati-cli --options file-name
232
-
233
-
``file-name`` can be a XML or an Excel/CSV file.
234
-
235
-
Options:
236
-
237
-
``--output-dir -o`` Directory where the output will be created, defaults to the name of the file.
238
-
239
-
``--exclude-file -e`` Do not include the file in the output directory.
240
-
241
-
``--delete -d`` Delete the output directory if it already exists.
242
-
243
-
``--orgids -i`` Run org-ids rule check for IATI identifier prefixes.
244
-
245
-
``--openag -a`` Run ruleset checks for IATI OpenAg data.
246
-
247
-
248
-
If the file is in spreadsheet format, the output directory will contain a *unflattened.xml* file converted from Excel or CSV to XML format
249
-
250
-
**OpenaAg** rulesets check that the data contains the XML elements ``<opeang:tag>`` and ``<location>``, and that they include the right attributes expected for OpenAg data. Please read `OpenAg ruleset feature files <cove_iati/rulesets/iati_openag_ruleset/>`_ (written in `Gerkhin <https://github.com/cucumber/cucumber/wiki/Gherkin/>`_ style) for more information.
251
-
252
-
**Org-ids** rulesets check that all organisation identifiers are prefixed with a registered `org-ids <http://org-id.guide>`_ prefix. Please read `Org-ids ruleset feature file <cove_iati/rulesets/iati_orgids_ruleset/>`_ for more information
253
-
254
-
255
-
**Non Embedded Codelists**
256
-
257
-
Non embedded codelists need to be periodically downloaded and committed to this repo. To do this run in the virtualenv:
0 commit comments