blob: 7f56c809a1f24b378c5a39edd8fd63b189db0508 [file] [log] [blame] [view]
## Installation
**SkyWalking Python agent requires SkyWalking 8.0+ and Python 3.6+**
You can install the SkyWalking Python agent via various ways.
> If you want to try out the latest features that are not released yet, please refer to this [guide](faq/How-to-build-from-sources.md) to build from sources.
### From PyPI
The Python agent module is published to [PyPI](https://pypi.org/project/apache-skywalking/), from where you can use `pip` to install:
```shell
# Install the latest version, using the default gRPC protocol to report data to OAP
pip install "apache-skywalking"
# Install the latest version, using the http protocol to report data to OAP
pip install "apache-skywalking[http]"
# Install the latest version, using the kafka protocol to report data to OAP
pip install "apache-skywalking[kafka]"
# Install a specific version x.y.z
# pip install apache-skywalking==x.y.z
pip install apache-skywalking==0.1.0 # For example, install version 0.1.0 no matter what the latest version is
```
### From Docker Hub
SkyWalking Python agent starts to provide convenient dockerfile
and images for easy integration utilizing its [auto-bootstrap](CLI.md) capability.
Simply pull SkyWalking Python image from [Docker Hub](https://hub.docker.com/r/apache/skywalking-python)
based on desired agent version, protocol and Python version.
```dockerfile
FROM apache/skywalking-python:0.7.0-grpc-py3.9
# ... build your Python application
```
Then, You can build your Python application image based on our agent-enabled Python images and start
your applications with SkyWalking agent enabled for you. Please refer to our
[Containerization Guide](Container.md) for further instructions on integration and configuring.
### From Source Code
Please refer to the [How-to-build-from-sources FAQ](faq/How-to-build-from-sources.md).