Skip to content

Commit

Permalink
Feat: Added changes to README.md also added workflow to pypi publish
Browse files Browse the repository at this point in the history
  • Loading branch information
homewardgamer committed Oct 18, 2024
1 parent 62016ed commit 4c63266
Show file tree
Hide file tree
Showing 16 changed files with 1,028 additions and 324 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Upload Python Package

on:
release:
types: [published]

permissions:
contents: read

jobs:
deploy:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Build package
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
user: __token__
password: ${{ secrets.PYPI_API_TOKEN }}
27 changes: 0 additions & 27 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.github/workflows/python.yml
.gitignore
.gitlab-ci.yml
.openapi-generator-ignore
.travis.yml
README.md
docs/Campaign.md
Expand Down Expand Up @@ -72,30 +71,4 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_campaign.py
test/test_campaign_api.py
test/test_campaign_dashboard_data.py
test/test_campaign_request.py
test/test_contact.py
test/test_contact_api.py
test/test_contact_request.py
test/test_create_response.py
test/test_dashboard_stats.py
test/test_delete_campaign200_response.py
test/test_delete_request.py
test/test_delete_response.py
test/test_last_sent_campaign_stat.py
test/test_list_api.py
test/test_list_model.py
test/test_list_request.py
test/test_report_data.py
test/test_reports_api.py
test/test_response.py
test/test_sender.py
test/test_sender_api.py
test/test_sender_request.py
test/test_sender_response.py
test/test_tag.py
test/test_tag_request.py
test/test_tags_api.py
tox.ini
30 changes: 7 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ The SendX API is organized around REST. Our API has predictable resource-oriente
The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Expand All @@ -21,9 +15,9 @@ Python 3.7+
If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/sendx/sendx_go_sdk.git
pip install sendx
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sendx/sendx_go_sdk.git`)


Then import the package:
```python
Expand All @@ -44,9 +38,6 @@ Then import the package:
import sendx_python_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Expand All @@ -58,22 +49,15 @@ import sendx_python_sdk
from sendx_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sendx.io/api/v1/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = sendx_python_sdk.Configuration(
host = "https://api.sendx.io/api/v1/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration = sendx_python_sdk.Configuration()



# Configure API key authorization: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'



# Enter a context with an instance of the API client
Expand Down Expand Up @@ -163,6 +147,6 @@ Authentication schemes defined for the API:

## Author


SendX Dev Team


Loading

0 comments on commit 4c63266

Please sign in to comment.