-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5aebc8a
Showing
536 changed files
with
66,447 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# NOTE: This file is auto generated by OpenAPI Generator. | ||
# URL: https://openapi-generator.tech | ||
# | ||
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | ||
|
||
name: segment_public_api Python package | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
build: | ||
|
||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install flake8 pytest | ||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
if [ -f test-requirements.txt ]; then pip install -r test-requirements.txt; fi | ||
- name: Lint with flake8 | ||
run: | | ||
# stop the build if there are Python syntax errors or undefined names | ||
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | ||
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | ||
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | ||
- name: Test with pytest | ||
run: | | ||
pytest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
env/ | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*,cover | ||
.hypothesis/ | ||
venv/ | ||
.venv/ | ||
.python-version | ||
.pytest_cache | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
#Ipython Notebook | ||
.ipynb_checkpoints |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright © 2022 Twilio, Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Segment Public API Python SDK | ||
|
||
:warning: This SDK is currently released as [Public Beta](https://segment.com/legal/first-access-beta-preview/). Its use in critical systems is discouraged, but [feedback is welcome](#contributing). | ||
|
||
The Segment Public API helps you manage your Segment Workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. | ||
|
||
All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a Workspace. | ||
|
||
See the next sections for more information on how to use the Segment Public API. | ||
|
||
|
||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: | ||
|
||
- API version: 36.3.0 | ||
- Package version: 36.3.0 | ||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen | ||
For more information, please visit [https://docs.segmentapis.com](https://docs.segmentapis.com) | ||
|
||
## Requirements. | ||
|
||
Python 3.7+ | ||
|
||
## Installation & Usage | ||
### pip install | ||
|
||
If the python package is hosted on a repository, you can install directly using: | ||
|
||
```sh | ||
pip install git+https://github.com/segmentio/public-api-sdk-python.git | ||
``` | ||
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/segmentio/public-api-sdk-python.git`) | ||
|
||
Then import the package: | ||
```python | ||
import segment_public_api | ||
``` | ||
|
||
### Setuptools | ||
|
||
Install via [Setuptools](http://pypi.python.org/pypi/setuptools). | ||
|
||
```sh | ||
python setup.py install --user | ||
``` | ||
(or `sudo python setup.py install` to install the package for all users) | ||
|
||
Then import the package: | ||
```python | ||
import segment_public_api | ||
``` | ||
|
||
## Getting Started | ||
|
||
Please follow the [installation procedure](#installation--usage) and then run the following: | ||
|
||
```python | ||
|
||
import time | ||
import segment_public_api | ||
from segment_public_api.rest import ApiException | ||
from pprint import pprint | ||
|
||
# Configure Bearer authorization: token | ||
configuration = segment_public_api.Configuration( | ||
access_token = os.environ["BEARER_TOKEN"] | ||
) | ||
|
||
# Enter a context with an instance of the API client | ||
with segment_public_api.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = segment_public_api.WorkspacesApi(api_client) | ||
|
||
try: | ||
# Get Workspace | ||
api_response = api_instance.get_workspace() | ||
print("The response of WorkspacesApi->get_workspace:\n") | ||
pprint(api_response) | ||
except ApiException as e: | ||
print("Exception when calling WorkspacesApi->get_workspace: %s\n" % e) | ||
|
||
source_api_instance = segment_public_api.SourcesApi(api_client) | ||
next = None | ||
while True: | ||
try: | ||
# Get Sources | ||
pagination = segment_public_api.PaginationInput(count=50, cursor= next) | ||
api_response = source_api_instance.list_sources(pagination) | ||
# print("The response of SourcesApi->list_sources:\n") | ||
# pprint(api_response) | ||
next = api_response.data.pagination.next | ||
if api_response.data.pagination.next == None: | ||
break | ||
except ApiException as e: | ||
print("Exception when calling SourcesApi->list_sources: %s\n" % e) | ||
``` | ||
|
||
## Contributing | ||
|
||
The contents of this repository are automatically generated, so we can't take contributions from external developers. If you have any issues with this SDK, please raise an issue or reach out to [email protected] instead of opening a pull request. Pull requests will not be reviewed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
[tool.poetry] | ||
name = "segment_public_api" | ||
version = "36.3.0" | ||
description = "Segment Public API" | ||
authors = ["Segment <[email protected]>"] | ||
license = "NoLicense" | ||
readme = "README.md" | ||
repository = "https://github.com/segmentio/public-api-sdk-python" | ||
keywords = ["OpenAPI", "OpenAPI-Generator", "Segment Public API"] | ||
include = ["segment_public_api/py.typed"] | ||
|
||
[tool.poetry.dependencies] | ||
python = "^3.7" | ||
|
||
urllib3 = ">= 1.25.3" | ||
python-dateutil = ">=2.8.2" | ||
pydantic = "^1.10.5, <2" | ||
aenum = ">=3.1.11" | ||
|
||
[tool.poetry.dev-dependencies] | ||
pytest = ">=7.2.1" | ||
tox = ">=3.9.0" | ||
flake8 = ">=4.0.0" | ||
|
||
[build-system] | ||
requires = ["setuptools"] | ||
build-backend = "setuptools.build_meta" | ||
|
||
[tool.pylint.'MESSAGES CONTROL'] | ||
extension-pkg-whitelist = "pydantic" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
python_dateutil >= 2.5.3 | ||
setuptools >= 21.0.0 | ||
urllib3 >= 1.25.3, < 2.1.0 | ||
pydantic >= 1.10.5, < 2 | ||
aenum >= 3.1.11 |
Oops, something went wrong.