From 2810f3f588251150e249eec72fa81fd8b510b56e Mon Sep 17 00:00:00 2001 From: sangeet-joy_xero Date: Tue, 8 Oct 2024 14:07:38 +0530 Subject: [PATCH] Added read me file --- .github/workflows/build-test-lint.yml | 11 +++-------- README.md | 13 +++++++++++++ requirements.txt | 1 - setup.py | 2 +- 4 files changed, 17 insertions(+), 10 deletions(-) diff --git a/.github/workflows/build-test-lint.yml b/.github/workflows/build-test-lint.yml index f6479763..39b14097 100644 --- a/.github/workflows/build-test-lint.yml +++ b/.github/workflows/build-test-lint.yml @@ -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 diff --git a/README.md b/README.md index bc6bbf51..2bfd07da 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 diff --git a/requirements.txt b/requirements.txt index ba1a7c4f..7be89c5b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,3 @@ python-dateutil>=2.7 urllib3>=2.2.3 certifi setuptools>=75.1.0 -django==2.2.9 diff --git a/setup.py b/setup.py index 3b1330f7..c85f5e42 100644 --- a/setup.py +++ b/setup.py @@ -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", )