Skip to content

Commit e4f1c2f

Browse files
committed
Add requirements.txt
1 parent 9f85a9b commit e4f1c2f

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

Diff for: README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,15 @@ This sample app is meant to provide working example of how to make API calls to
99
- Creating a QB customer that are added from Excel file using Customer API.
1010
- Gets company data using CompanyInfo API
1111

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.
1713

1814
## Requirements
1915
1. Python 3.6
2016
2. A [developer.intuit.com](https://developer.intuit.com/) account
2117
3. An app on [developer.intuit.com](https://developer.intuit.com/) and the associated app keys:
2218
- 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
2319
- 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
2521

2622
## First Time Instructions
2723
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
3026

3127
## Running the code
3228
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```
3532

3633
## High Level Project Overview
3734

3835
1. [app.py](app.py) module contains all routes for the Flask web app
3936
2. [QBOService.py](QBOService.py) class creates a Customer in QBO and gets QBO company info
4037

41-
##### Utility modules
38+
### Utility modules
4239
3. [excel.py](utils/excel.py) module deals with importing data from [Leads.xlsx](Leads.xlsx) and editing it
4340
4. [context.py](utils/context.py) class for request context object which has all tokens and realm required to make an API call
4441
5. [APICallService.py](utils/APICallService.py) module has POST and GET methods for QBO API
4542
6. [OAuth2Helper.py](utils/OAuth2Helper.py) module has the methos required for OAuth2 flow
4643

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
4845

4946
[ss1]: https://help.developer.intuit.com/s/samplefeedback?cid=9010&repoName=SampleApp-QuickBooksV3API-Python

Diff for: requirements.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
requests==2.13.0
2+
Flask==0.12
3+
Flask_OAuth==0.13
4+
Werkzeug==0.11.15
5+
openpyxl==2.4.4
6+
requests_oauthlib==0.8.0

0 commit comments

Comments
 (0)