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
Ah, it looks like I missed the **Resources** section in the enhanced version. I'll make sure it's properly included now. Here's the corrected version with the **Resources** section added:
<imgsrc="https://sentry-brand.storage.googleapis.com/github-banners/github-sdk-python.png"alt="Sentry for Python">
7
3
</a>
8
4
9
-
_Bad software is everywhere, and we're all tired of it. Let's be real – as devs, we've all dealt with that one bug that crashes everything at the worst possible moment. Enter **Sentry**, where the mission is simple: help developers write better software faster, so we can get back to actually enjoying building stuff!_
5
+
Bad software is everywhere, and developers often deal with bugs that crash systems at the worst possible moments. Enter **Sentry**: our mission is to help developers write better software faster, so you can focus on building.
Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**! If you care about tracking down every error and performance bottleneck in your app, you're in the right place. 💻🐍
13
+
Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**! If you care about tracking down every error and performance bottleneck in your app, you're in the right place.
18
14
19
15
## Getting Started
20
16
21
-
### Installation ⚡
17
+
### Installation
22
18
23
-
Getting Sentry into your project is super straightforward. Just drop this in your terminal:
19
+
Getting Sentry into your project is straightforward. Just run this command in your terminal:
24
20
25
21
```bash
26
22
pip install --upgrade sentry-sdk
27
23
```
28
24
29
-
Boom, you're done. 🎉
25
+
### Basic Configuration
30
26
31
-
### Basic Configuration 🛠️
32
-
33
-
A quick config example to get Sentry rolling with the essentials:
27
+
Here’s a quick configuration example to get Sentry up and running:
34
28
35
29
```python
36
30
import sentry_sdk
@@ -40,95 +34,95 @@ sentry_sdk.init(
40
34
41
35
# Set traces_sample_rate to 1.0 to capture 100%
42
36
# of transactions for performance monitoring.
43
-
traces_sample_rate=1.0, #Fine-tune this based on your performance needs
37
+
traces_sample_rate=1.0, #Adjust this based on your performance needs
44
38
)
45
39
```
46
40
47
-
You’re all set! With that, Sentry starts monitoring for exceptions and performance issues in the background while you keep coding 🚀. Adjust the `traces_sample_rate`for better performance monitoring granularity.
41
+
With this configuration, Sentry will monitor for exceptions and performance issues in the background while you continue coding. Adjust the `traces_sample_rate`to fine-tune performance monitoring.
48
42
49
-
### Quick Usage Example 🧑💻
43
+
### Quick Usage Example
50
44
51
-
Now, let's generate some events that’ll show up in Sentry. You can log simple messages or capture errors:
45
+
To generate some events that will show up in Sentry, you can log messages or capture errors:
52
46
53
47
```python
54
48
from sentry_sdk import capture_message
55
-
capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard!
49
+
capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard.
56
50
57
51
raiseValueError("Oops, something went wrong!") # This will create an error event in Sentry.
58
52
```
59
53
60
54
#### Explore the Docs
61
55
62
-
If you’re hungry for more details on advanced usage, integrations, and customization, don’t forget to check out the full docs:
56
+
For more details on advanced usage, integrations, and customization, check out the full documentation:
If you’re still using `raven-python`, we’ve made the migration to the new Sentry SDK super smooth. [Check out this guide](https://docs.sentry.io/platforms/python/migration/) to switch things over seamlessly.
69
60
70
-
## Integrations 💥
61
+
### Migrating from `raven-python`?
62
+
If you’re still using `raven-python`, migrating to the new Sentry SDK is smooth. [Check out this guide](https://docs.sentry.io/platforms/python/migration/) for details.
63
+
64
+
## Integrations
71
65
72
-
Sentry plays nice with a lot of popular Python libraries and frameworks. Here are a few of them:
66
+
Sentry integrates with several popular Python libraries and frameworks, including:
73
67
74
-
-[Django](https://docs.sentry.io/platforms/python/integrations/django/) – Full Django support for error and performance tracking.
68
+
-[Django](https://docs.sentry.io/platforms/python/integrations/django/) – Full support for error and performance tracking.
75
69
-[Flask](https://docs.sentry.io/platforms/python/integrations/flask/) – Flask-specific error handling.
-[AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/) – Support for serverless applications.
73
+
74
+
Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/).
81
75
82
-
### Rolling Your Own Integration? 🛠️
76
+
### Rolling Your Own Integration?
83
77
84
-
If you’re feeling brave and want to create a new integration or improve an existing one, we’d love to see your contribution! Make sure to read our [contributing guide](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md) before diving in.
78
+
If youwant 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.
85
79
86
-
## Migrating Between Versions? 🧳
80
+
## Migrating Between Versions?
87
81
88
82
### From `1.x` to `2.x`
89
83
90
-
If you're on the older `1.x` version of the SDK, now's the perfect time to jump to `2.x`. It comes with **major upgrades** and tons of new features. Don't worry, we've got your back with a handy [migration guide](https://docs.sentry.io/platforms/python/migration/1.x-to-2.x).
84
+
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.
91
85
92
86
### From `raven-python`
93
87
94
-
Using the legacy `raven-python` client? It's now in maintenance mode, but we strongly recommend migrating to this new SDK for an improved experience. Get all the details on how to migrate with our [migration guide](https://docs.sentry.io/platforms/python/migration/raven-to-sentry-sdk/).
88
+
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/).
95
89
96
-
## Want to Contribute? 🎉
90
+
## Want to Contribute?
97
91
98
-
We’d love to have your help in making the Sentry SDK even better! Whether it's squashing bugs, adding new features, or simply improving the docs – every contribution counts.
92
+
We’d love your help in improving the Sentry SDK! Whether it’s fixing bugs, adding features, or enhancing documentation, every contribution is valuable.
99
93
100
-
For details on how to contribute, please check out [CONTRIBUTING.md](CONTRIBUTING.md). Also, check the [open issues](https://github.com/getsentry/sentry-python/issues) and dive in!
94
+
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).
101
95
102
-
## Need Help? 🤔
96
+
## Need Help?
103
97
104
-
Sometimes things don’t go as planned (debugging is life, after all). If you need help, jump into our awesome community:
98
+
If you encounter issues, don’t hesitate to reach out to our community for support:
105
99
106
-
-**[Sentry Discord Community](https://discord.com/invite/Ww9hbqr)** – Tons of people ready to help!
107
-
-**[Stack Overflow](http://stackoverflow.com/questions/tagged/sentry)** – Stack Overflow’s always a great place to ask for help.
108
-
-**[Sentry Forum](https://forum.sentry.io/c/sdks)** – Share ideas, get advice, and learn from the community.
100
+
-**[Sentry Discord Community](https://discord.com/invite/Ww9hbqr)** – A helpful community is ready to assist.
101
+
-**[Stack Overflow](http://stackoverflow.com/questions/tagged/sentry)** – A great place for asking questions.
102
+
-**[Sentry Forum](https://forum.sentry.io/c/sdks)** – Share ideasand get advice.
109
103
110
-
## Resources 📚
104
+
## Resources
111
105
112
-
Here are some additional resources to help you make the most of Sentry:
106
+
Here are additional resources to help you make the most of Sentry:
113
107
114
-
-[](https://docs.sentry.io/quickstart/) – Official documentation to get you up and running.
115
-
-[](https://forum.sentry.io/c/sdks) – Sentry forums for more in-depth discussions.
116
-
-[](http://stackoverflow.com/questions/tagged/sentry) – Ask your questions here!
117
-
-[](https://discord.gg/Ww9hbqr) – Join the community on Discord.
118
-
-[](https://twitter.com/intent/follow?screen_name=getsentry) – Follow Sentry on Twitter for updates and tips.
108
+
-[](https://docs.sentry.io/quickstart/) – Official documentation to get started.
109
+
-[](https://forum.sentry.io/c/sdks) – Forums for in-depth discussions.
-[](https://twitter.com/intent/follow?screen_name=getsentry) – Follow us on Twitter for updates.
119
113
120
-
## License 📜
114
+
## License
121
115
122
-
The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more info.
116
+
The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information.
123
117
124
118
---
125
119
126
-
Thanks to all the contributors who have made the Sentry Python SDK awesome! 🥳💪
120
+
Thanks to all the contributors who have made the Sentry Python SDK great!
0 commit comments