Differences

This shows you the differences between two versions of the page.

--- devel:brewerjsonpythonmodule [2015/09/21 08:54] – ajberjon
+++ devel:brewerjsonpythonmodule [2022/10/20 08:00] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 The Brewer JSON Python Module provides the functions to connect to the RBCC-E database and to download data of the different Brewer equipments.
-We describe here the functions and data structured implemented in brewerjson.py module. The last version of the python module is available from [[http://rbcce.aemet.es/svn/python/libbrewerjson/|rbcce subversion repository]].
+We describe here the functions implemented in brewerjson.py module. The last version of the python module is available from [[http://rbcce.aemet.es/svn/python/libbrewerjson/|rbcce subversion repository]].
 ===== Installation =====
-Brewer JSON library can be imported from python code adding the path to brewer.py module to the Python path (list of directories Python goes through to search for modules and files):
+Brewer JSON library can be imported from python code adding the path to brewerjson.py module to the Python path (list of directories Python goes through to search for modules and files):
   import sys
   sys.path.append("/home/to/module/")
+By default the sys.path variable includes the current directory, so if brewerjson.py is in the same directory as the Python script, the module can be directly imported.
 Alternatively, you can download brewer.py file to the standard location for third-party Python modules. This location varies by platform and by how you built/installed Python itself. Typical locations are shown in the following table:
@@ Line 20: / Line 22: @@
 ===== Functions =====
-The functions of this module
+The functions of this module are:
+^ Field ^ Description ^
+^ [[devel:brewerjsonpythonmodule#getDataList|getDataList()]] | Retrieve a list of dictionaries with data from RBCC-E between two dates. ^
+^ [[devel:brewerjsonpythonmodule#writejson|writejson()]] | Write list of dictionaries (measures, config,..) to file. ^
+^ [[devel:brewerjsonpythonmodule#readjson|readjson()]] | Read list of dictionaries (measures, config,..) from file. ^
+=== getDataList() ===
+This function retrieve a list of [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#data_structures|dictionaries]] with data of the registered brewers at the RBCC-E database. Arguments are //berwerid//, //user//, //password//, //function//, //date1// and //date2//. If //date2// is omitted the function returns only data of the day //data1//.
+The returned dictionaries structures depend on the //function// argument value:
+^ //function// ^ Dictionaries ^
+^ 'DS' | [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#measure|measure]] ^
+^ 'SL' | [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#measure|measure]] ^
+^ 'ConfigbyDate' | [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#config|config]] ^
+**Example**
+    import brewerjson
+    import datetime
+    d1=datetime.date(2014,10,01)
+    d2=datetime.date(2014,10,02)
+    data=brewerjson.getDataList(185,'user,'password','DS',d1,d2)
+=== writejson() ===
+This function save a list of [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#data_structures|dictionaries]] to file. The values of 'gmt' and 'date' are transformed to strings.
+**Example**
+    import brewerjson
+    import datetime
+    d1=datetime.date(2014,10,01)
+    d2=datetime.date(2014,10,02)
+    data=brewerjson.getDataList(185,'user,'password','DS',d1,d2)
+    brewerjson.getdata(data,'output.txt')
+This function accepts two input parameters: //'data'// and //'file'//.
+  * //'data'// is a list of [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#data_structures|dictionaries]].
+  * //'file'// output file.
+=== readjson() ===
+This function read a file containing a list of [[http://eubrewnet.aemet.es/dokuwiki/doku.php?id=devel:brewerpythonmodule#data_structures|dictionaries]].
+**Example**
+    import brewerjson
+    import datetime
+    brewerjson.getdata('input.txt')