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
docs(sdk): Enhance README with improved clarity and developer-friendly examples (#3667)
Added more approachable language and technical examples to help developers understand how to install, configure, and use the Sentry SDK for Python. Clarified instructions around integrations, migration, and contributing. Included additional resources for further learning and support.
The previous README was more formal, and this update makes it more engaging while keeping all necessary technical information intact. This change improves the developer experience by making the documentation more accessible.
Copy file name to clipboardExpand all lines: README.md
+47-42
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
<imgsrc="https://sentry-brand.storage.googleapis.com/github-banners/github-sdk-python.png"alt="Sentry for Python">
3
3
</a>
4
4
5
+
5
6
_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us, [<kbd>**check out our open positions**</kbd>](https://sentry.io/careers/)_.
6
7
7
8
# Official Sentry SDK for Python
@@ -10,102 +11,106 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he
10
11
[](https://pypi.python.org/pypi/sentry-sdk)
With this configuration, Sentry will monitor for exceptions and performance issues.
43
+
44
+
### Quick Usage Example
45
+
46
+
To generate some events that will show up in Sentry, you can log messages or capture errors:
38
47
39
48
```python
40
49
from sentry_sdk import capture_message
41
-
capture_message("Hello World") #Will create an event in Sentry.
50
+
capture_message("Hello Sentry!") #You'll see this in your Sentry dashboard.
42
51
43
-
raiseValueError() #Will also create an event in Sentry.
52
+
raiseValueError("Oops, something went wrong!") #This will create an error event in Sentry.
44
53
```
45
54
46
-
- To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/python/).
47
-
- Are you coming from `raven-python`? [Use this migration guide](https://docs.sentry.io/platforms/python/migration/).
48
-
- To learn about internals use the [API Reference](https://getsentry.github.io/sentry-python/).
55
+
#### Explore the Docs
49
56
50
-
## Integrations
57
+
For more details on advanced usage, integrations, and customization, check out the full documentation:
51
58
52
-
(If you want to create a new integration, have a look at the [Adding a new integration checklist](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md#adding-a-new-integration).)
See [the documentation](https://docs.sentry.io/platforms/python/integrations/) for an up-to-date list of libraries and frameworks we support. Here are some examples:
62
+
## Integrations
63
+
64
+
Sentry integrates with many popular Python libraries and frameworks, including:
Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/).
73
+
74
+
### Rolling Your Own Integration?
74
75
75
-
## Migrating
76
+
If you want to create a new integration or improve an existing one, we’d welcome your contributions! Please read our [contributing guide](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md) before starting.
76
77
77
-
###Migrating From `1.x` to `2.x`
78
+
## Migrating Between Versions?
78
79
79
-
If you're on SDK version 1.x, we highly recommend updating to the 2.x major. To make the process easier we've prepared a [migration guide](https://docs.sentry.io/platforms/python/migration/1.x-to-2.x) with the most common changes as well as a [detailed changelog](MIGRATION_GUIDE.md).
80
+
### From `1.x`to `2.x`
80
81
81
-
### Migrating From `raven-python`
82
+
If you're using the older `1.x` version of the SDK, now's the time to upgrade to `2.x`. It includes significant upgrades and new features. Check our [migration guide](https://docs.sentry.io/platforms/python/migration/1.x-to-2.x) for assistance.
82
83
83
-
The old`raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).
84
+
### From`raven-python`
84
85
85
-
If you're using`raven-python`, we recommend you to migrate to this new SDK. You can find the benefits of migrating and how to do it in our [migration guide](https://docs.sentry.io/platforms/python/migration/raven-to-sentry-sdk/).
86
+
Using the legacy`raven-python` client? It's now in maintenance mode, and we recommend migrating to the new SDK for an improved experience. Get all the details in our [migration guide](https://docs.sentry.io/platforms/python/migration/raven-to-sentry-sdk/).
86
87
87
-
## Contributing to the SDK
88
+
## Want to Contribute?
88
89
89
-
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
90
+
We’d love your help in improving the Sentry SDK! Whether it’s fixing bugs, adding features, or enhancing documentation, every contribution is valuable.
90
91
91
-
## Getting Help/Support
92
+
For details on how to contribute, please check out [CONTRIBUTING.md](CONTRIBUTING.md) and explore the [open issues](https://github.com/getsentry/sentry-python/issues).
92
93
93
-
If you need help setting up or configuring the Python SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
94
+
## Need Help?
95
+
96
+
If you encounter issues or need help setting up or configuring the SDK, don’t hesitate to reach out to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people there ready to help!
Here are additional resources to help you make the most of Sentry:
101
+
102
+
-[](https://docs.sentry.io/quickstart/) – Official documentation to get started.
-[](https://twitter.com/intent/follow?screen_name=getsentry) – Follow us on X (Twitter) for updates.
105
+
-[](http://stackoverflow.com/questions/tagged/sentry) – Questions and answers related to Sentry.
102
106
103
107
## License
104
108
105
-
Licensed under the MIT license, see [`LICENSE`](LICENSE)
109
+
The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information.
106
110
111
+
---
107
112
108
-
### Thanks to all the people who contributed!
113
+
Thanks to everyone who has helped improve the SDK!
0 commit comments