You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[Application Development Guide](https://docs.temporal.io/application-development?lang=python)
13
+
*[Application Development Guide](https://docs.temporal.io/application-development?lang=python) - Once you've tried our [Quick Start](#quick-start), check out our guide on how to use Temporal in your Python applications, including information around Temporal core concepts.
-[Heartbeating and Cancellation](#heartbeating-and-cancellation)
93
+
-[Worker Shutdown](#worker-shutdown)
94
+
-[Testing](#testing-1)
95
+
-[Workflow Replay](#workflow-replay)
96
+
-[OpenTelemetry Support](#opentelemetry-support)
97
+
-[Protobuf 3.x vs 4.x](#protobuf-3x-vs-4x)
98
98
-[Development](#development)
99
-
-[Building](#building)
100
-
-[Prepare](#prepare)
101
-
-[Build](#build)
102
-
-[Use](#use)
103
-
-[Local SDK development environment](#local-sdk-development-environment)
104
-
-[Testing](#testing-2)
105
-
-[Proto Generation and Testing](#proto-generation-and-testing)
106
-
-[Style](#style)
99
+
-[Building](#building)
100
+
-[Prepare](#prepare)
101
+
-[Build](#build)
102
+
-[Use](#use)
103
+
-[Local SDK development environment](#local-sdk-development-environment)
104
+
-[Testing](#testing-2)
105
+
-[Proto Generation and Testing](#proto-generation-and-testing)
106
+
-[Style](#style)
107
107
108
108
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
109
109
110
-
## Quick Start
110
+
# Quick Start
111
+
112
+
We will guide you through the Temporal basics to create a "hello, world!" script on your machine. It is not intended as one of the ways to use Temporal, but in reality it is very simplified and decidedly not "the only way" to use Temporal. For more information, check out the docs references in "Next Steps" below the quick start.
111
113
112
-
###Installation
114
+
## Installation
113
115
114
116
Install the `temporalio` package from [PyPI](https://pypi.org/project/temporalio).
115
117
@@ -124,7 +126,7 @@ The SDK is now ready for use. To build from source, see "Building" near the end
124
126
125
127
**NOTE: This README is for the current branch and not necessarily what's released on `PyPI`.**
126
128
127
-
###Implementing a Workflow
129
+
## Implementing a Workflow
128
130
129
131
Create the following script at `run_worker.py`:
130
132
@@ -164,7 +166,7 @@ will run the worker:
164
166
165
167
python run_worker.py
166
168
167
-
###Running a Workflow
169
+
## Running a Workflow
168
170
169
171
Create the following script at `run_workflow.py`:
170
172
@@ -196,7 +198,19 @@ The output will be:
196
198
197
199
Result: Hello, my-name!
198
200
199
-
## Usage
201
+
## Next Steps
202
+
Temporal can be implemented in your code in many different ways, to suit your application's needs. The links below will give you much more information about how Temporal works with Python:
203
+
204
+
*[Code Samples](https://github.com/temporalio/samples-python) - If you want to start with some code, we have provided some pre-built samples.
205
+
*[Application Development Guide](https://docs.temporal.io/application-development?lang=python) Our Python specific Developer's Guide will give you much more information on how to build with Temporal in your Python applications than our SDK README ever could (or should).
206
+
*[API Documentation](https://python.temporal.io) - Full Temporal Python SDK package documentation
207
+
208
+
---
209
+
210
+
# Usage
211
+
212
+
From here, you will find reference documentation about specific pieces of the Temporal Python SDK that were built around Temporal concepts.
213
+
*This section is not intended as a how-to guide* -- For more how-to oriented information, check out the links in the [Next Steps](#next-steps) section above.
200
214
201
215
### Client
202
216
@@ -1066,7 +1080,7 @@ versions can cause issues with the sandbox due to global state sharing. Temporal
1066
1080
protobuf 4.x library unless you absolutely cannot at which point some proto libraries may have to be marked as
1067
1081
[Passthrough Modules](#passthrough-modules).
1068
1082
1069
-
##Development
1083
+
# Development
1070
1084
1071
1085
The Python SDK is built to work with Python 3.7 and newer. It is built using
1072
1086
[SDK Core](https://github.com/temporalio/sdk-core/) which is written in Rust.
0 commit comments