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

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

procurement python

Last synced: 5 days ago
JSON representation

API interface to OpenProcurement database

• Host: GitHub
• URL: https://github.com/openprocurement/openprocurement.api
• Owner: openprocurement
• License: apache-2.0
• Created: 2014-10-14T17:42:51.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T06:34:53.000Z (4 months ago)
• Last Synced: 2024-07-16T08:53:13.512Z (4 months ago)
• Topics: procurement, python
• Language: Python
• Homepage: http://api-docs.openprocurement.org/
• Size: 6.03 MB
• Stars: 104
• Watchers: 27
• Forks: 73
• Open Issues: 65
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - openprocurement/openprocurement.api - API interface to OpenProcurement database (python)

README

        
.. image:: https://travis-ci.org/openprocurement/openprocurement.api.svg?branch=master

    :target: https://travis-ci.org/openprocurement/openprocurement.api

.. image:: https://coveralls.io/repos/openprocurement/openprocurement.api/badge.svg

  :target: https://coveralls.io/r/openprocurement/openprocurement.api

.. image:: https://readthedocs.org/projects/openprocurementapi/badge/?version=latest

    :target: http://api-docs.openprocurement.org/

.. image:: https://img.shields.io/hexpm/l/plug.svg

    :target: https://github.com/openprocurement/openprocurement.api/blob/master/LICENSE.txt

.. image:: https://badges.gitter.im/Join%20Chat.svg

    :target: https://gitter.im/openprocurement/openprocurement.api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

    :alt: Gitter

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

http://api-docs.openprocurement.org/

Building documentation

----------------------

Use following commands to build documentation from `docs/source` into `docs/html`::

 python bootstrap.py -c docs.cfg

 bin/buildout -N -c docs.cfg

 bin/docs

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

 1. Pull all translatable strings out of documentation::

     (cd docs/_build; make gettext)

 2. Update translation with new/changed strings::

     bin/sphinx-intl update -c docs/source/conf.py -p docs/_build/locale -l 

    

 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::

      bin/sphinx-intl build -c docs/source/conf.py

 5. Build translated documentations::

     (cd docs/_build; make -e SPHINXOPTS="-D language='uk'" html)