devel:brewerjsonpythonmodule
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
devel:brewerjsonpythonmodule [2015/09/21 10:21] ajberjon |
devel:brewerjsonpythonmodule [2022/10/20 08:00] (current) |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| import sys | import sys | ||
| sys.path.append("/home/to/module/") | 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: | 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 23: | Line 25: | ||
| ^ Field ^ Description ^ | ^ Field ^ Description ^ | ||
| - | ^ [[devel:brewerjsonpythonmodule#getdata|getdata()]] | Retrieve raw data from RBCC-E database ^ | + | ^ [[devel:brewerjsonpythonmodule#getDataList|getDataList()]] | Retrieve a list of dictionaries with data from RBCC-E between two dates. ^ |
| - | ^ [[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. ^ | ||
| - | === getdata() === | ||
| - | This function retrieve brewer data using the interface describing in the [[codes:accessfunctions|access functions Section]]. This function accepts only an argument //params// which is a dictionary. Mandatory elements in //params// are: //user//, //password//, //berwerid// and //function//. Other elements should be provided depending on the selected //function//. The //function// element refers to the different functions described in the [[codes:accessfunctions|access functions Section]]. | + | === 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** | **Example** | ||
| Line 34: | Line 45: | ||
| import datetime | import datetime | ||
| | | ||
| - | params['user']='user' | + | d1=datetime.date(2014,10,01) |
| - | params['password']='password' | + | d2=datetime.date(2014,10,02) |
| - | params['function']='getDS' | + | data=brewerjson.getDataList(185,'user,'password','DS',d1,d2) |
| - | params['brewerid']=37 | + | |
| - | params['date']=datetime.date(2014,10,01)' | + | |
| - | data=brewerjson.getdata(params) | + | |
| - | In this example we retrieve data from the url: http://rbcce.aemet.es/eubrewnet/getdata/getDS?brewerid=037&date=2014-10-01 | ||
| - | This function returns different data structures depending on //function// parameter. | + | === 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. | |
| - | === getDataList() === | + | |
| - | + | ||
| - | This function retrieve a list of [[http://rbcce.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//. | + | |
| - | + | ||
| - | Valid values of //function// argument are only 'getDS', 'getDSS', 'getSL', 'getSLS' and 'getConfigsbyDate'. | + | |
| **Example** | **Example** | ||
| Line 58: | Line 60: | ||
| d1=datetime.date(2014,10,01) | d1=datetime.date(2014,10,01) | ||
| d2=datetime.date(2014,10,02) | d2=datetime.date(2014,10,02) | ||
| - | data=brewerjson.getDataList(37,'user,'password','getDS',d1,d2) | + | 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') | ||
devel/brewerjsonpythonmodule.1442830912.txt.gz · Last modified: 2015/09/21 10:21 by ajberjon
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
