mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 06:26:51 +00:00
CP-1977 Addressed some suggestions received from OSPO (#21)
* CP-1977 Addressed some suggestions received from OSPO * Update README.md Co-authored-by: João Malés <85952626+joaomper-TE@users.noreply.github.com> --------- Co-authored-by: João Malés <85952626+joaomper-TE@users.noreply.github.com>
This commit is contained in:
parent
b65d59526c
commit
4ce7179e16
38
README.md
38
README.md
@ -4,9 +4,45 @@
|
|||||||
|
|
||||||
`thousandeyes-sdk-python` is a set of Python client libraries for the [Thousandeyes v7 API](https://developer.cisco.com/docs/thousandeyes/v7/).
|
`thousandeyes-sdk-python` is a set of Python client libraries for the [Thousandeyes v7 API](https://developer.cisco.com/docs/thousandeyes/v7/).
|
||||||
|
|
||||||
|
This project is maintained by the ThousandEyes team at Cisco.
|
||||||
|
|
||||||
## Installation and usage
|
## Installation and usage
|
||||||
|
|
||||||
Each of the APIs being published include a README file with instruction on how to install and use the API.
|
Each of the APIs being published includes a README file with instructions on how to install and use the API.
|
||||||
|
* [administrative](/thousandeyes-sdk-administrative/README.md)
|
||||||
|
* [agents](/thousandeyes-sdk-agents/README.md)
|
||||||
|
* [alerts](/thousandeyes-sdk-alerts/README.md)
|
||||||
|
* [bgp-monitors](/thousandeyes-sdk-bgp-monitors/README.md)
|
||||||
|
* [credentials](/thousandeyes-sdk-credentials/README.md)
|
||||||
|
* [dashboards](/thousandeyes-sdk-dashboards/README.md)
|
||||||
|
* [endpoint-agents](/thousandeyes-sdk-endpoint-agents/README.md)
|
||||||
|
* [endpoint-instant-tests](/thousandeyes-sdk-endpoint-instant-tests/README.md)
|
||||||
|
* [endpoint-labels](/thousandeyes-sdk-endpoint-labels/README.md)
|
||||||
|
* [endpoint-test-results](/thousandeyes-sdk-endpoint-test-results/README.md)
|
||||||
|
* [endpoint-tests](/thousandeyes-sdk-endpoint-tests/README.md)
|
||||||
|
* [instant-tests](/thousandeyes-sdk-instant-tests/README.md)
|
||||||
|
* [internet-insights](/thousandeyes-sdk-internet-insights/README.md)
|
||||||
|
* [labels](/thousandeyes-sdk-labels/README.md)
|
||||||
|
* [snapshots](/thousandeyes-sdk-snapshots/README.md)
|
||||||
|
* [streaming](/thousandeyes-sdk-streaming/README.md)
|
||||||
|
* [tags](/thousandeyes-sdk-tags/README.md)
|
||||||
|
* [test-results](/thousandeyes-sdk-test-results/README.md)
|
||||||
|
* [tests](/thousandeyes-sdk-tests/README.md)
|
||||||
|
* [usage](/thousandeyes-sdk-usage/README.md)
|
||||||
|
|
||||||
|
Use the ThousandEyes Community to get general best practices, help, tips, or examples using ThousandEyes APIs or the respective SDKs. Free to any ThousandEyes community member, simply log in and post your questions in the [ThousandEyes forum](https://community.cisco.com/t5/thousandeyes/bd-p/disc-thousandeyes).
|
||||||
|
|
||||||
|
Additionally, these are good places to start to see if your question is already answered.
|
||||||
|
* [ThousandEyes Documentation](https://docs.thousandeyes.com/)
|
||||||
|
* [Internet and Cloud Intelligence Blog](https://www.thousandeyes.com/blog/)
|
||||||
|
* [Cisco ThousandEyes](https://blogs.cisco.com/tag/cisco-thousandeyes?dtid=osscdc000283)
|
||||||
|
|
||||||
|
For more info regarding the API, please check the [Developer support](https://developer.cisco.com/docs/thousandeyes/v7/developer-support/#developer-support) page.
|
||||||
|
|
||||||
|
## Roadmap and maintenance
|
||||||
|
|
||||||
|
This library will be continuously updated alongside the [Thousandeyes v7 API](https://developer.cisco.com/docs/thousandeyes/v7/).
|
||||||
|
If you have any questions about the roadmap or future plans, feel free to post them in the [issues](https://github.com/thousandeyes/thousandeyes-sdk-python/issues) panel.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
from . import exceptions
|
from . import exceptions
|
||||||
from .api_client import ApiClient
|
from .api_client import ApiClient
|
||||||
from .api_response import ApiResponse
|
from .api_response import ApiResponse
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
import datetime
|
import datetime
|
||||||
import json
|
import json
|
||||||
import mimetypes
|
import mimetypes
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
"""API response object."""
|
"""API response object."""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
import http.client as httplib
|
import http.client as httplib
|
||||||
import logging
|
import logging
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
from typing import Any, Optional
|
from typing import Any, Optional
|
||||||
|
|
||||||
from typing_extensions import Self
|
from typing_extensions import Self
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
import io
|
import io
|
||||||
import json
|
import json
|
||||||
import re
|
import re
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
import re
|
import re
|
||||||
import time
|
import time
|
||||||
from typing import Collection, Optional, Union
|
from typing import Collection, Optional, Union
|
||||||
|
|||||||
@ -1,3 +1,19 @@
|
|||||||
|
# Copyright 2024 Cisco Systems, Inc. and its affiliates
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
import thousandeyes_sdk.core
|
import thousandeyes_sdk.core
|
||||||
|
|
||||||
class Version:
|
class Version:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user