66
77<!-- [](https://xero-python.readthedocs.io/en/latest/?badge=latest) -->
88
9- Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
10-
11- * Free software: MIT license
129<!-- * Documentation: <https://xero-python.readthedocs.io>. -->
1310
11+ Official python SDK for Xero API generated by OpenAPI spec for oAuth 2
12+
1413## Features
1514
1615* XERO API Client with oauth2 token integration.
17- * Automatic oauth2 token refresh before token expiration.
16+ * Automatic OAuth 2 token refresh before token expiration.
1817* Class based interface for Xero API endpoints.
1918* Model classes used to represent API data.
2019* Currently Supported API sets:
2120 * [ Accounting API] ( https://developer.xero.com/documentation/api/api-overview )
21+ * [ Assets API] ( https://developer.xero.com/documentation/assets-api/overview )
22+ * [ Projects API] ( https://developer.xero.com/documentation/projects/overview-projects )
2223* Error handling for ease of use.
2324
25+ ## Starter Project
26+ We've created a [ xero-python-outh2-starter] ( https://github.com/XeroAPI/xero-python-oauth2-starter ) project to demonstrate how to use this SDK.
27+
28+ * oauth 2 flow to obtain a token
29+ * token refresh
30+ * identity to obtain tenant_id
31+ * organisation endpoint
32+ * create contact
33+ * create multiple contacts
34+ * get invoices using where clause
35+
36+ We've created a [ 15 min video walkthrough] ( https://www.youtube.com/watch?v=i8JWtbMo90M ) on using the starter project.
37+
38+
2439## Credits
2540
2641* This package was created with
@@ -32,3 +47,30 @@ project template.
3247## Contribution
3348
3449Please read [ contribution] ( https://github.com/xero-github/xero-python/blob/master/CONTRIBUTING.md ) guidelines.
50+
51+ ## License
52+
53+ This software is published under the [ MIT License] ( http://en.wikipedia.org/wiki/MIT_License ) .
54+
55+ Copyright (c) 2020 Xero Limited
56+
57+ Permission is hereby granted, free of charge, to any person
58+ obtaining a copy of this software and associated documentation
59+ files (the "Software"), to deal in the Software without
60+ restriction, including without limitation the rights to use,
61+ copy, modify, merge, publish, distribute, sublicense, and/or sell
62+ copies of the Software, and to permit persons to whom the
63+ Software is furnished to do so, subject to the following
64+ conditions:
65+
66+ The above copyright notice and this permission notice shall be
67+ included in all copies or substantial portions of the Software.
68+
69+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
70+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
71+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
72+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
73+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
74+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
75+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
76+ OTHER DEALINGS IN THE SOFTWARE.
0 commit comments