https://github.com/openprocurement/web-renderer
https://github.com/openprocurement/web-renderer
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/openprocurement/web-renderer
- Owner: openprocurement
- Created: 2020-07-09T06:42:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-02T14:16:24.000Z (over 3 years ago)
- Last Synced: 2025-05-08T03:13:30.617Z (about 1 year ago)
- Language: Python
- Size: 729 KB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# web-renderer
### Debug mode
```
export DEBUG=true
```
### Requests:
```
paths:
/:
post:
summary: Render a document.
requestBody:
json_data:
description: json data
content: application/json:
template:
description: template .docx file
content: application/msword
include_attachments:
description: include attachment files
content: True
document_names:
description: output document names without extensions
content: application/json
fields: {
"contractProforma": "contractProformaFileName",
"contractData" : "contractDataFileName",
"contractTemplate": "contractTemplateFileName"
}
responses:
'200':
file:
description: Generated file
content: application/pdf
post:
summary: Get template JSON schema.
requestBody:
json_data:
description: json data
content: application/json:
template:
description: template .docx file
content: application/msword
get_template_json_schema:
content: True
hide_empty_fields:
description: hide empty fields of the schema
content: True or False
responses:
'200':
data:
description: generated JSON schema of the document
content: application/json
# Additional requests:
post:
summary: Get template JSON tag schema.
requestBody:
json_data:
description: json data
content: application/json:
template:
description: template .docx file
content: application/msword
get_template_tag_schema:
content: True
responses:
'200':
data:
description: generated JSON tag schema of the document
content: application/json
post:
summary: display html form from the document
requestBody:
json_data:
description: json data
content: application/json:
template:
description: template .docx file
content: application/msword
display_template_form:
content: True
responses:
'200':
data:
description: generated HTML document
content: text/html
```
### Renderer features:
- #### Pictures replacement:
Renderer have some limitations such as can't add picture to header or footer using `InlineImage`, for resolve this problem, renderer has reserved keyword in context `replace_pics` its array of objects which contains two attributes:
- `current_name` - name of dummy picture already placed in template.
- `url` - link for picture which will replace dummy picture.
example:
```python
>>> context = {
... 'title': 'My company',
... 'phone': '+15552345712',
... 'replace_pics': [
... {'current_name': 'dummy_logo.png', 'url': ''}
... ]
... }
```
**Note**: the aspect ratio will be the same as the replaced image
### Jinja template functions:
- ##### `{{ iso_str_date | format_date}}`
The function for formating an ISO date to the string one.
- **input:** date (ISO): 2019-08-22T13:35:00+03:00
- **output:** date (str): "22" серпня 2019 року
- ##### `{{ str_float_number | to_float}}`
The function for formatting comma float string to float.
- **input:** "12\xa0588\xa0575.00"
- **output:** 12588575.0
- ##### `{{ str_float_number | convert_amount_to_words}}`
The function for formatting an amount of money to the word string.
- **input:** "12\xa0588\xa0575.00"
- **output:** "триста двадцять двi тисячi шiстсот шiстдесят дев'ять гривень 00 копійок"
- ##### `{{ items_list | common_classification }}`
The function for formatting common classification of all items in format "ДК021 32100000-1, Текстовий опис класифікатора"
- **input:** "Список айтемів контракту"
- **output:** "Текстове значення класифікатора у форматі: 'ДК021 32100000-1, Текстовий опис класифікатора'"
- ##### `{{ items_list | common_classification_code}}`
The function for formatting common classification of all items in format "ДК021 32100000-1
- **input:** "Список айтемів контракту"
- **output:** "Текстове значення класифікатора у форматі: 'ДК021 32100000-1'"
- ##### `{{ items_list | common_classification_description}}`
The function for getting common classification description of all items
- **input:** "Список айтемів контракту"
- **output:** "Текстовий опис спільного для всіх айтемів класифікатора"
- ##### `{{ classification_data | classification}}`
The function for getting classification description
- **input:** "об'єкт класифікатора"
- **output:** "Текстовий опис класифікатора згідно словника"
- ##### `{{ data | json_query ('search_string')}}`
The function for searching a string using JMESPATH format in data JSON.
- **input:**:
- data: JSON data, e.g: contract.supplier
- search_string, e.g: 'id'
- **output:**
- search result
- ##### `{{ data | default ('default')}}`
If data is empty return default
- ##### `{{ unit_code | unit_shortcut}}`
The function for getting the shortcut of measurement units
- **input:** "MLT"
- **output:** "мл."
- ##### `{{ Image | InlineImage(width=50, height=50, unit=’mm’)}}`
The function for getting image by download url
Units: Inches, Cm, Mm, Pt, Emu
- **input:** "Image url"
- **output:** "InlineImage"
### Run tests
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pytest --cov
```