https://github.com/openprocurement/prozorroukr-openprocurement.api

API interface to OpenProcurement database
https://github.com/openprocurement/prozorroukr-openprocurement.api

Last synced: 2 months ago
JSON representation

API interface to OpenProcurement database

• Host: GitHub
• URL: https://github.com/openprocurement/prozorroukr-openprocurement.api
• Owner: openprocurement
• License: apache-2.0
• Created: 2020-03-06T16:35:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T01:41:21.000Z (3 months ago)
• Last Synced: 2024-10-30T03:59:09.752Z (3 months ago)
• Language: Python
• Size: 67 MB
• Stars: 4
• Watchers: 7
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# OpenProcurement Api

## Installation

```

docker-compose build

docker-compose up

```

## Documentation

OpenProcurement is initiative to develop software 

powering tenders database and reverse auction.

'openprocurement.api' is component responsible for 

exposing the tenders database to brokers and public.

Documentation about this API is accessible at

https://prozorro-api-docs.readthedocs.io/en/latest/

### Install

1. Install requirements

```

virtualenv -p python2.7 venv

source venv/bin/activate

pip install -r docs/source/requirements.txt

```

2. Add "couchdb" to be resolved to localhost in /etc/hosts

```

echo "127.0.0.1 couchdb" >> /etc/hosts

```

3. To run couchdb if you don't have one

```

docker-compose up -d couchdb

```

### Update

Running tests to update http files::

```

py.test docs/tests  # all

py.test docs/tests/test_belowthreshold.py -k test_docs_milestones  # specific

```

### Build

Run

```

sphinx-build -b html docs/source/ docs/build/html

```

or

```

cd docs

make html

```

### Translation

For translation into *uk* (2 letter ISO language code), you have to follow the scenario:

1. Pull all translatable strings out of documentation

```

cd docs

make gettext

```

2. Update translation with new/changed strings

```

cd docs

sphinx-intl update -p build/locale -l uk -w 0

```

3. Update updated/missing strings in `docs/source/locale//LC_MESSAGES/*.po` with your-favorite-editor/poedit/transifex/pootle/etc. to have all translations complete/updated.

4. Compile the translation

```

cd docs

sphinx-intl build

```