@@ -2,15 +2,16 @@ How To Use This Module
22======================
33* More documentation can be found [ On PyPI] ( http://pythonhosted.org/restfulengine/ ) *
44
5- 1 . Import the module:
5+ ### 1. Import the module:
66```
77import restfulengine
88```
99* OR*
1010```
1111from restfulengine import *
1212```
13- 2 . Create a [ Report] ( http://pythonhosted.org/restfulengine/#restfulengine.Report )
13+ ### 2. Create a Report
14+ Create a [ Report] ( http://pythonhosted.org/restfulengine/#restfulengine.Report )
1415either by using its constructor or calling
1516[ create_report()] ( http://pythonhosted.org/restfulengine/#restfulengine.create_report ) .
1617You must specify a service URL, an output format
@@ -25,7 +26,8 @@ report = restfulengine.create_report(
2526 template
2627)
2728```
28- 3 . Set up [ DataSource] ( http://pythonhosted.org/restfulengine/#restfulengine.DataSource )
29+ ### 3. Set up DataSources
30+ Set up [ DataSource] ( http://pythonhosted.org/restfulengine/#restfulengine.DataSource )
2931objects and add them to a list.
3032[ XmlDataSource] ( http://pythonhosted.org/restfulengine/#restfulengine.XmlDataSource )
3133objects or [ AdoDataSource] ( http://pythonhosted.org/restfulengine/#restfulengine.AdoDataSource ) objects:
@@ -39,12 +41,14 @@ data_sources = [
3941 "User=demo;Password=demo")
4042]
4143```
42- 4 . Call [ Report.process()] ( http://pythonhosted.org/restfulengine/#restfulengine.Report.process )
44+ ### 4. Process the report
45+ Call [ Report.process()] ( http://pythonhosted.org/restfulengine/#restfulengine.Report.process )
4346with your data sources to send the request:
4447```
4548report.process(data_sources)
4649```
47- 5 . (for async reports) call
50+ ###5 . Retrieve the report
51+ (for async reports) call
4852[ Report.get_status()] ( http://pythonhosted.org/restfulengine/#restfulengine.Report.get_status )
4953to poll the server so you know when the report is done. Then call
5054[ Report.get_report()] ( http://pythonhosted.org/restfulengine/#restfulengine.Report.get_report )
0 commit comments