You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-10
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,15 @@ This sample app is meant to provide working example of how to make API calls to
9
9
- Creating a QB customer that are added from Excel file using Customer API.
10
10
- Gets company data using CompanyInfo API
11
11
12
-
Please note that while these examples work, features not called out above are not intended to be taken and used in production business applications. In other words, this is not a seed project to be taken cart blanche and deployed to your production environment.
13
-
14
-
For example, certain concerns are not addressed at all in our samples (e.g. security, privacy, scalability). In our sample apps, we strive to strike a balance between clarity, maintainability, and performance where we can. However, clarity is ultimately the most important quality in a sample app.
15
-
16
-
Therefore there are certain instances where we might forgo a more complicated implementation (e.g. caching a frequently used value, robust error handling, more generic domain model structure) in favor of code that is easier to read. In that light, we welcome any feedback that makes our samples apps easier to learn from.
12
+
Please note that while these examples work, features not called out above are not intended to be taken and used in production business applications. In other words, this is not a seed project to be taken cart blanche and deployed to your production environment. For example, certain concerns are not addressed at all in our samples (e.g. security, privacy, scalability). In our sample apps, we strive to strike a balance between clarity, maintainability, and performance where we can. However, clarity is ultimately the most important quality in a sample app.
17
13
18
14
## Requirements
19
15
1. Python 3.6
20
16
2. A [developer.intuit.com](https://developer.intuit.com/) account
21
17
3. An app on [developer.intuit.com](https://developer.intuit.com/) and the associated app keys:
22
18
- Client Id and Client Secret for OAuth2 apps; Configure the RedirectUri[http://localhost:5000/callback] in your app's Keys tab on the Intuit developer account, only Accounting scope needed
23
19
- Consumer key and Consumer secret for OAuth1 apps
24
-
4. This sample app uses several libraries which need to be installed including flask, flask_oauth, ConfigParser, openpyxl, requests_oauthlib
20
+
4. This sample app uses several libraries listed in [requirements.txt](requirements.txt)which need to be installed including flask, flask_oauth, openpyxl, requests_oauthlib
25
21
26
22
## First Time Instructions
27
23
1. Clone the GitHub repo to your computer
@@ -30,20 +26,21 @@ Therefore there are certain instances where we might forgo a more complicated im
30
26
31
27
## Running the code
32
28
1. cd to the project directory
33
-
2. Run the command: ```python app.py``` for MacOS/Linux
34
-
3. open a browser and enter ```http://localhost:5000```
29
+
2.```pip install -r requirements.txt```
30
+
3. Run the command: ```python app.py``` for MacOS/Linux
31
+
4. open a browser and enter ```http://localhost:5000```
35
32
36
33
## High Level Project Overview
37
34
38
35
1.[app.py](app.py) module contains all routes for the Flask web app
39
36
2.[QBOService.py](QBOService.py) class creates a Customer in QBO and gets QBO company info
40
37
41
-
#####Utility modules
38
+
### Utility modules
42
39
3.[excel.py](utils/excel.py) module deals with importing data from [Leads.xlsx](Leads.xlsx) and editing it
43
40
4.[context.py](utils/context.py) class for request context object which has all tokens and realm required to make an API call
44
41
5.[APICallService.py](utils/APICallService.py) module has POST and GET methods for QBO API
45
42
6.[OAuth2Helper.py](utils/OAuth2Helper.py) module has the methos required for OAuth2 flow
46
43
47
-
### Note: For other OAuth2 services like Refresh token, Revoke token, etc, refer to [this](https://github.com/IntuitDeveloper/OAuth2PythonSampleApp) app
44
+
####Note: For other OAuth2 services like Refresh token, Revoke token, etc, refer to [this](https://github.com/IntuitDeveloper/OAuth2PythonSampleApp) app
0 commit comments