We are currently indexing your data, so search results may be incomplete until we finish.
Move license into its own file and use readme for long description, as it containss essentially the same content.
Changeset 7f5aed0f6a65…
Parent 0c4b4841211c…
by
Changes to 2 files · Browse files at 7f5aed0f6a65 Showing diff from parent 0c4b4841211c Diff from another changeset...
|
|
@@ -1,0 +1,22 @@ + Copyright (c) 2011, Fog Creek Software, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer. Redistributions in binary form must
+reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the
+distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
@@ -1,95 +1,23 @@ + import io
+
try:
from setuptools import setup
except ImportError:
from distutils.core import setup
-from textwrap import dedent
+with io.open('README.txt', encoding='utf-8') as readme:
+ long_description = readme.read()
+
+with io.open('LICENSE', encoding='utf-8') as readme:
+ license = readme.read()
+
setup(name='fogbugz_bis',
version='1.0',
py_modules=['fogbugz'],
- license=dedent("""\
- Copyright (c) 2011, Fog Creek Software, Inc.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without modification,
- are permitted provided that the following conditions are met:
-
- Redistributions of source code must retain the above copyright notice, this list
- of conditions and the following disclaimer. Redistributions in binary form must
- reproduce the above copyright notice, this list of conditions and the following
- disclaimer in the documentation and/or other materials provided with the
- distribution.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- """),
+ license=license,
description='Python library for interacting with the FogBugz API',
- long_description=dedent("""\
- 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, 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>
- >>> # To upload files, just pass a `Files` parameter that is a dictionary of filename and file handle. New in 0.9.2.
- >>> resp = fb.edit(ixbug=2, sEvent="Add a file from the API", Files={'filename': open('filename', 'r')}) # Note the named parameters
- >>> resp
- <response><case ixbug="2" 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')
-
- For more info on the API:
- http://our.fogbugz.com/help/topics/advanced/API.html
- """),
+ long_description=long_description,
author='Fog Creek Software',
author_email='customer-service@fogcreek.com',
maintainer='YouGov, Plc.',
|
||
Add a tag
Loading...