Skip to content

Commit

Permalink
Added read me file
Browse files Browse the repository at this point in the history
  • Loading branch information
sangeet-joy_xero committed Oct 8, 2024
1 parent a05d150 commit 2810f3f
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 10 deletions.
11 changes: 3 additions & 8 deletions .github/workflows/build-test-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,14 @@ jobs:

- name: Run audit on requirements.txt
run: |
echo "running audit on requirements.txt...."
pip-audit -r requirements.txt
echo "running audit on dev.txt...."
pip-audit -r requirements/dev.txt
working-directory: xero-python
# - name: Run audit on dev.txt
# run: |
# pip install pip-audit
# pip install -r requirements/dev.txt
# echo "running audit...."
# pip-audit -r requirements/dev.txt
# working-directory: xero-python
working-directory: xero-python

- name: Run Flake8
run: flake8 xero_python
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ The xero-python SDK makes it easy for developers to access Xero's APIs in their
- [Helper Methods](#helper-methods)
- [Usage Examples](#usage-examples)
- [SDK conventions](#sdk-conventions)
- [Running Test(s) in Local](#running-tests-in-local)
- [Participating in Xero’s developer community](#participating-in-xeros-developer-community)
- [Contributing](#contributing)

Expand Down Expand Up @@ -540,6 +541,18 @@ created_invoice_attachments_by_file_name = accounting_api.create_invoice_attachm
---
## SDK conventions


---
## Running Test(s) in Local
For Running Test cases PRISM Mock Server needs to be started in the local machine.
Steps to Run Test(s)
* Install PRISM from npm using the command: **npm install -g @stoplight/prism-cli**
* Verify Installation: **prism --version**
* Navigate to **tests--> utils--> ** folder in the terminal
* Execute the script **./start-prism.sh**
* This will start the PRISM Server in Local
* Run **pytest** to run the dotnet test cases.

### Querying & Filtering

Describe the support for query options and filtering
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ python-dateutil>=2.7
urllib3>=2.2.3
certifi
setuptools>=75.1.0
django==2.2.9
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ def read_file(filename):
keywords="xero python sdk API oAuth",
name="xero_python",
packages=find_packages(include=["xero_python", "xero_python.*"]),
version="6.3.0-alpha.5",
version="6.3.0",
)

0 comments on commit 2810f3f

Please sign in to comment.