Skip to content

Commit 64b950a

Browse files
committed
cove: readme: Remove redundant information
1 parent 933273f commit 64b950a

File tree

1 file changed

+3
-174
lines changed

1 file changed

+3
-174
lines changed

cove/README.rst

Lines changed: 3 additions & 174 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,11 @@
11
CoVE - Convert Validate & Explore
22
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33

4-
.. image:: https://requires.io/github/OpenDataServices/cove/requirements.svg?branch=master
5-
:target: https://requires.io/github/OpenDataServices/cove/requirements/?branch=master
6-
:alt: Requirements Status
7-
8-
.. image:: https://coveralls.io/repos/OpenDataServices/cove/badge.png?branch=master
9-
:target: https://coveralls.io/r/OpenDataServices/cove?branch=master
10-
11-
.. image:: https://img.shields.io/badge/license-AGPLv3-blue.svg
12-
:target: https://github.com/OpenDataServices/cove/blob/master/AGPLv3.txt
13-
14-
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!
154

165
Introduction
176
============
187

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
209

2110
Why convert data?
2211
+++++++++++++++++
@@ -45,111 +34,6 @@ User Flows
4534

4635
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
4736

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)
74-
* Compile the translations
75-
* Run the development server
76-
77-
.. code:: bash
78-
79-
git clone https://github.com/OpenDataServices/cove.git
80-
cd cove
81-
python3 -m venv .ve
82-
source .ve/bin/activate
83-
pip install -r requirements_dev.txt
84-
DJANGO_SETTINGS_MODULE={cove_MODULENAME}.settings python manage.py migrate
85-
python manage.py compilemessages
86-
87-
Then, for 360Giving run:
88-
89-
.. code:: bash
90-
91-
DJANGO_SETTINGS_MODULE=cove_360.settings python manage.py runserver
92-
93-
Follow the instructions in your terminal to open the application in your browser.
94-
95-
Extra installation steps for IATI
96-
+++++++++++++++++++++++++++++++++
97-
98-
The following steps are for Ubuntu but equivalent packages are available for other distros.
99-
100-
.. code:: bash
101-
102-
sudo apt-get install build-essential libxml2-dev libxslt1-dev python3-dev
103-
pip install -r requirements_iati.txt
104-
105-
Then run the development server:
106-
107-
.. code:: bash
108-
109-
DJANGO_SETTINGS_MODULE=cove_iati.settings python manage.py runserver
110-
111-
112-
Deployment
113-
==========
114-
115-
See https://cove.readthedocs.io/en/latest/deployment/
116-
117-
Run tests
118-
=========
119-
120-
`Set up chromedriver <https://chromedriver.chromium.org/getting-started>`_, then run:
121-
122-
.. code:: bash
123-
124-
./run_tests.sh
125-
126-
To run functional tests with a different browser:
127-
128-
.. code:: bash
129-
130-
BROWSER=Chrome ./run_tests.sh
131-
132-
See http://selenium-python.readthedocs.io/api.html for browser options.
133-
134-
To generate a coverage report (in the htmlcov directory):
135-
136-
.. code:: bash
137-
138-
py.test --cov cove --cov-report html
139-
140-
The tests include functional tests (actually interacting with the website in selenium). These can also be run against a deployed copy of the website:
141-
142-
.. code:: bash
143-
144-
CUSTOM_SERVER_URL=http://dev.cove.opendataservices.coop py.test fts
145-
146-
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
15337

15438
Translations
15539
============
@@ -159,7 +43,7 @@ Translations
15943
16044
Translations for Translators
16145
++++++++++++++++++++++++++++
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
16347

16448
Translations for Developers
16549
+++++++++++++++++++++++++++
@@ -206,59 +90,4 @@ To check that all new text is written so that it is able to be translated you co
20690
.. code:: bash
20791
20892
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:
258-
259-
.. code:: bash
260-
261-
python get_iati_non_embedded_codelists.py
262-
263-
264-
93+
django-template-i18n-lint cove

0 commit comments

Comments
 (0)