Skip to content

Commit 4c63266

Browse files
committed
Feat: Added changes to README.md also added workflow to pypi publish
1 parent 62016ed commit 4c63266

File tree

16 files changed

+1028
-324
lines changed

16 files changed

+1028
-324
lines changed

.github/workflows/python-publish.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Upload Python Package
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
deploy:
12+
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v3
17+
- name: Set up Python
18+
uses: actions/setup-python@v3
19+
with:
20+
python-version: '3.x'
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install build
25+
- name: Build package
26+
run: python -m build
27+
- name: Publish package
28+
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
29+
with:
30+
user: __token__
31+
password: ${{ secrets.PYPI_API_TOKEN }}

.openapi-generator/FILES

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
.github/workflows/python.yml
22
.gitignore
33
.gitlab-ci.yml
4-
.openapi-generator-ignore
54
.travis.yml
65
README.md
76
docs/Campaign.md
@@ -72,30 +71,4 @@ setup.cfg
7271
setup.py
7372
test-requirements.txt
7473
test/__init__.py
75-
test/test_campaign.py
76-
test/test_campaign_api.py
77-
test/test_campaign_dashboard_data.py
78-
test/test_campaign_request.py
79-
test/test_contact.py
80-
test/test_contact_api.py
81-
test/test_contact_request.py
82-
test/test_create_response.py
83-
test/test_dashboard_stats.py
84-
test/test_delete_campaign200_response.py
85-
test/test_delete_request.py
86-
test/test_delete_response.py
87-
test/test_last_sent_campaign_stat.py
88-
test/test_list_api.py
89-
test/test_list_model.py
90-
test/test_list_request.py
91-
test/test_report_data.py
92-
test/test_reports_api.py
93-
test/test_response.py
94-
test/test_sender.py
95-
test/test_sender_api.py
96-
test/test_sender_request.py
97-
test/test_sender_response.py
98-
test/test_tag.py
99-
test/test_tag_request.py
100-
test/test_tags_api.py
10174
tox.ini

README.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ The SendX API is organized around REST. Our API has predictable resource-oriente
44
The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
55

66

7-
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8-
9-
- API version: 1.0.0
10-
- Package version: 1.0.0
11-
- Generator version: 7.8.0
12-
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
137

148
## Requirements.
159

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

2317
```sh
24-
pip install git+https://github.com/sendx/sendx_go_sdk.git
18+
pip install sendx
2519
```
26-
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sendx/sendx_go_sdk.git`)
20+
2721

2822
Then import the package:
2923
```python
@@ -44,9 +38,6 @@ Then import the package:
4438
import sendx_python_sdk
4539
```
4640

47-
### Tests
48-
49-
Execute `pytest` to run the tests.
5041

5142
## Getting Started
5243

@@ -58,22 +49,15 @@ import sendx_python_sdk
5849
from sendx_python_sdk.rest import ApiException
5950
from pprint import pprint
6051

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

67-
# The client must configure the authentication and authorization parameters
68-
# in accordance with the API server security policy.
69-
# Examples for each auth method are provided below, use the example that
70-
# satisfies your auth use case.
53+
configuration = sendx_python_sdk.Configuration()
54+
55+
7156

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

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

7862

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

164148
## Author
165149

166-
150+
SendX Dev Team
167151

168152

0 commit comments

Comments
 (0)