https://github.com/clarin-eric/resource-families-html-generator
Script for generating html table containing data about corpora from .csv file
https://github.com/clarin-eric/resource-families-html-generator
Last synced: 5 months ago
JSON representation
Script for generating html table containing data about corpora from .csv file
- Host: GitHub
- URL: https://github.com/clarin-eric/resource-families-html-generator
- Owner: clarin-eric
- License: gpl-3.0
- Created: 2019-09-20T01:13:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T13:47:09.000Z (over 1 year ago)
- Last Synced: 2025-09-10T03:14:15.580Z (9 months ago)
- Language: Python
- Size: 2.41 MB
- Stars: 3
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
ClarTable
=========
Installation
------------
Works with Python `^3.9`
```bash
git clone git@github.com:clarin-eric/resource-families-html-generator.git # via SSH or
git clone https://github.com/clarin-eric/resource-families-html-generator.git # via HTTPS
cd ./resource-families-html-generator/
pip install .
```
About
-----
*ClarTable* is a Python module for generating html presentation layer for tabular data from .csv file.
### Usage
#### Locally:
```bash
usage: python -m rfhg [-h] -i PATH -r PATH -o PATH
Create html table from given data and rules.
To navigate static resources within the module prepend `static.`
to the path, eg. `-r static.rules/rules.json`
optional arguments:
-h, --help show this help message and exit
-i PATH path to a .csv file or folder with .csv files
-r PATH path to a .json file with rules
-o PATH path to file where output html table will be generated
```
#### Via CI:
The html tables for resource families can be generated via GitHub. Push new .csv files to `/resouce_families` and after processing they will appear in gh-pages branch.
### CSV format
In order to create html table from .csv file with default rules, the file requires __all of following columns__ (order not important). Note that names of columns are case sensitive. If you need generator to consider additional columns contact or adjust __rules.json__.
Make sure, that your .csv files __use ; (semicolon)__ as a column separator.
Single cell may containt multiple paragraphs or structures split with __#SEP__ separator. Following the example below the Description cell consists of 3 paragraphs. Some of the cells depend on others, looking into Buttons cell there are 2 buttons names split with the separator and respective URLs in Buttons_URL.
Corpus | Corpus_URL | Language | Size | Annotation | Licence | Description | Buttons | Buttons_URL | Publication | Publication_URL | Note
-------|------------|----------|------|------------|---------|-------------|---------|-------------|-------------|-----------------|-------
Example Corpus Name | www.examplaryurl.com | English | 100 million tokens | tokenised, PoS-tagged, lemmatised | CC-BY | First examplary sentence #SEPSecond examplary sentence to be started from new line #SEPExample with ```hyperlink``` in it | Concordancer#SEPDownload | https://www.concordancer.com/ #SEPhttps://www.download.com | Smith et al. (3019) | https://publication.url | Note text to be displayed in button field
Resulting table:
### Table titles and ordering
Table title will be derived from the .csv file name in format X-table_title.csv, where X is index used for table ordering.
Tables can be grouped into sections by storing them in the intermediate directory within corpora that is subject to the same indexation principle as .csv files.
For example corpora with structure:
```bash
Historical corpora
├── 1-Historical corpora in the CLARIN infrastructure
│ ├── 1-Monolingual corpora.csv
│ └── 2-Multilingual corpora.csv
└── 2-Other historical corpora
├── 1-Monolingual corpora.csv
└── 2-Multilingual corpora.csv
```
Will produce:
### Rules format
Rules are composed of nested json notation of tags and field.
Given rule:
```javascript
{"tags": [
{"tag": "", "tags": [
{"tag": "", "tags": [
{"tag": "", "tags": [
{"tag": "", "text": "Corpus name"}
]}
]},
{"tag": "", "tags": [
{"tag": "", "tags": [
{"tag": "", "fields": [
{"text": "Field data will be inserted here: %s", "columns": ['column_name_in_csv_file']}
]}
]}
]}
]}
]}
]}
```
Generated html table with names of corpora, assuming there were only 2 rows in a .csv file
```html
Corpus name
Field data will be inserted here: NKJP 2.1.4
Field data will be inserted here: Common Crawl
```
Corpus name
Some text here
Field data will be inserted here: NKJP 2.1.4
Some text here
Field data will be inserted here: Common Crawl
\ tag encloses tags and fields for row creation, only tags nested within \ ... \ can contain "fields": []