added documentation

This commit is contained in:
Guillaume Raffy 2023-10-06 16:59:49 +02:00
parent 16268289ba
commit 7cce4efc5a
3 changed files with 18 additions and 3 deletions

View File

@ -0,0 +1,12 @@
## how to use
```sh
graffy@graffy-ws2:~/work/convheb$ python -m venv convheb.venv
graffy@graffy-ws2:~/work/convheb$ source ./convheb.venv/bin/activate
(convheb.venv) graffy@graffy-ws2:~/work/convheb$ pip install requirements.txt
(convheb.venv) graffy@graffy-ws2:~/work/convheb$ python ./create_list_for_annex.py
```
note: cocluto can be found [here](https://git.ipr.univ-rennes1.fr/cellinfo/cocluto)

View File

@ -3,7 +3,7 @@ from cocluto.inventory import Inventory
from cocluto.SimpaDbUtil import SqlDatabaseReader, SqlFile from cocluto.SimpaDbUtil import SqlDatabaseReader, SqlFile
from urllib.parse import urlparse from urllib.parse import urlparse
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from sys import stdout # from sys import stdout
import re import re
@ -157,9 +157,10 @@ def main():
machines_fqdn = get_hosted_machines_fqdn(inventory) machines_fqdn = get_hosted_machines_fqdn(inventory)
print('ipr machines hosted at the dsi (%d):' % len(machines_fqdn)) print('ipr machines hosted at the dsi (%d):' % len(machines_fqdn))
table_renderer = MarkdownTableRenderer() table_renderer = TsvTableRenderer()
print_machine_table(machines_fqdn, inventory, stdout, table_renderer) with open('ipr-machines-at-dsi.csv', 'wt') as tsv_file:
print_machine_table(machines_fqdn, inventory, tsv_file, table_renderer)
if __name__ == '__main__': if __name__ == '__main__':

2
requirements.txt Normal file
View File

@ -0,0 +1,2 @@
cocluto==1.0
mysqlclient==2.1.0