FogBugz » FogBugzPy A Python wrapper for the FogBugz API Read More
Clone URL:  
Pushed to one repository · View In Graph Contained in master

Converted README from plaintext to reStructuredText so it will appear correctly on PyPi

Changeset cc4b5e2bfb1d…

Parent aa00099b8fc5…

by Profile picture of User 2722Daniel Lieberman <daniel.lieberman610@gmail.com>

Changes to one file · Browse files at cc4b5e2bfb1d Showing diff from parent aa00099b8fc5 Diff from another changeset...

Change 1 of 1 Show Entire File README.txt Stacked
 
1
 
2
3
4
5
6
7
8
9
 
 
 
 
 
 
 
 
 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
34
35
 
1
2
3
4
5
6
 
 
 
 
7
8
9
10
11
12
13
14
15
16
17
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@@ -1,35 +1,45 @@
 Python FogBugz API Wrapper +--------------------------    This Python API is simply a wrapper around the FogBugz API, with some help from Leonard Richardson's BeautifulSoup (http://www.crummy.com/software/BeautifulSoup/) and the magic of Python's __getattr__().    Getting Started: -To use the FogBugz API, just put the file fogbugz.py somewhere on your Python path. It's probably easiest to add this before the import: ->>> import sys ->>> sys.path.append("""c:\code\fbapi""") ->>> from fogbugz import FogBugz +---------------- + +To use the FogBugz API, install the package either by downloading the source and running + + $ python setup.py install + +or by using pip + + $ pip install fogbugz    A Quick Example: ->>> from fogbugz import FogBugz ->>> fb = FogBugz("http://example.fogbugz.com/") # URL is to your FogBugz install ->>> fb.logon("logon@example.com", "password") ->>> resp = fb.search(q="assignedto:tyler") # All calls take named parameters, per the API ->>> resp # Responses are BeautifulSoup objects of the response XML. -<response><cases count="2"><case ixbug="1" operations="edit,assign,resolve,email,remind"></case><case ixbug="2" operations="edit,spam,assign,resolve,reply,forward,remind"></case></cases></response> ->>> # You shouldn't need to know too much about BeautifulSoup, but the documentation can be found here: ->>> # http://www.crummy.com/software/BeautifulSoup/documentation.html ->>> for case in resp.cases.childGenerator(): # One way to access the cases -... print case['ixbug'] -... -1 -2 ->>> for case in resp.findAll('case'): # Another way to access the cases -... print case['operations'] -... -edit,assign,resolve,email,remind -edit,spam,assign,resolve,reply,forward,remind ->>> resp = fb.edit(ixbug=1, sEvent="Edit from the API") # Note the named parameters ->>> resp -<response><case ixbug="1" operations="edit,assign,resolve,email,remind"></case></response> +---------------- + +:: + + >>> from fogbugz import FogBugz + >>> fb = FogBugz("http://example.fogbugz.com/") # URL is to your FogBugz install + >>> fb.logon("logon@example.com", "password") + >>> resp = fb.search(q="assignedto:tyler") # All calls take named parameters, per the API + >>> resp # Responses are BeautifulSoup objects of the response XML. + <response><cases count="2"><case ixbug="1" operations="edit,assign,resolve,email,remind"></case><case ixbug="2" operations="edit,spam,assign,resolve,reply,forward,remind"></case></cases></response> + >>> # You shouldn't need to know too much about BeautifulSoup, but the documentation can be found here: + >>> # http://www.crummy.com/software/BeautifulSoup/documentation.html + >>> for case in resp.cases.childGenerator(): # One way to access the cases + ... print case['ixbug'] + ... + 1 + 2 + >>> for case in resp.findAll('case'): # Another way to access the cases + ... print case['operations'] + ... + edit,assign,resolve,email,remind + edit,spam,assign,resolve,reply,forward,remind + >>> resp = fb.edit(ixbug=1, sEvent="Edit from the API") # Note the named parameters + >>> resp + <response><case ixbug="1" operations="edit,assign,resolve,email,remind"></case></response>    Note that, per API v5.0, all data between tags, such as the token, is now wrapped in CDATA. BeautifulSoup's implementation of CData generally allows for it to be treated as a string, except for one important case: CData.__str__() (a.k.a. str(CData)) returns the full text, including the CDATA wrapper (e.g. "<![CDATA[foo]]>"). To avoid accidentally including the CDATA tage, use CData.encode('utf-8')