Skip to content

Commit e233b98

Browse files
committed
Improving stuff
1 parent b9f5f0e commit e233b98

File tree

1 file changed

+48
-34
lines changed

1 file changed

+48
-34
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 48 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,35 @@
11
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
22
<img src="https://sentry-brand.storage.googleapis.com/github-banners/github-sdk-python.png" alt="Sentry for Python">
33
</a>
4-
_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/)_.
54

6-
# Official Sentry SDK for Python
5+
<div align="center">
76

8-
[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
7+
<br/>
8+
9+
[![Discord](https://img.shields.io/discord/621778831602221064?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87)
10+
[![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=@getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)
911
[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk)
10-
[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA)
12+
<img src="https://img.shields.io/badge/python-3.7 | 3.8 | 3.9 | 3.10 | 3.11 | 3.12 | 3.13-blue.svg" alt="python">
13+
[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
14+
15+
_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
16+
[<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_.
17+
18+
<br/>
19+
20+
</div>
21+
22+
23+
# Official Sentry SDK for Python
24+
25+
Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**.
26+
27+
<a name="getting-started"></a>
28+
## πŸ“¦ Getting Started
1129

12-
Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**!
30+
### Prerequisites
1331

14-
## πŸš€ Getting Started
32+
You need a Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects/).
1533

1634
### Installation
1735

@@ -32,7 +50,7 @@ sentry_sdk.init(
3250
"https://[email protected]/1", # Your DSN here
3351

3452
# Set traces_sample_rate to 1.0 to capture 100%
35-
# of transactions for performance monitoring.
53+
# of traces for performance monitoring.
3654
traces_sample_rate=1.0,
3755
)
3856
```
@@ -44,35 +62,26 @@ With this configuration, Sentry will monitor for exceptions and performance issu
4462
To generate some events that will show up in Sentry, you can log messages or capture errors:
4563

4664
```python
47-
from sentry_sdk import capture_message
48-
capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard.
65+
import sentry_sdk
66+
sentry_sdk.init(...) # same as above
67+
68+
sentry_sdk.capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard.
4969

5070
raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry.
5171
```
5272

53-
#### Explore the Docs
73+
<a name="documentation"></a>
74+
## πŸ“š Documentation
5475

55-
For more details on advanced usage, integrations, and customization, check out the full documentation:
56-
57-
- [Official SDK Docs](https://docs.sentry.io/platforms/python/)
58-
- [API Reference](https://getsentry.github.io/sentry-python/)
76+
For more details on advanced usage, integrations, and customization, check out the full documentation on [https://docs.sentry.io](https://docs.sentry.io/).
5977

78+
<a name="integrations"></a>
6079
## 🧩 Integrations
6180

62-
Sentry integrates with many popular Python libraries and frameworks, including:
63-
64-
- [Django](https://docs.sentry.io/platforms/python/integrations/django/)
65-
- [Flask](https://docs.sentry.io/platforms/python/integrations/flask/)
66-
- [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/)
67-
- [Celery](https://docs.sentry.io/platforms/python/integrations/celery/)
68-
- [AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/)
69-
70-
Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/).
71-
72-
### Rolling Your Own Integration?
81+
Sentry integrates with a ton of popular Python libraries and frameworks, including [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/), [Django](https://docs.sentry.io/platforms/python/integrations/django/), [Celery](https://docs.sentry.io/platforms/python/integrations/celery/), [OpenAI](https://docs.sentry.io/platforms/python/integrations/openai/) and many, many more. Check out the [full list of integrations](https://docs.sentry.io/platforms/python/integrations/) to get the full picture.
7382

74-
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.
7583

84+
<a name="migrating"></a>
7685
## 🚧 Migrating Between Versions?
7786

7887
### From `1.x` to `2.x`
@@ -83,29 +92,34 @@ If you're using the older `1.x` version of the SDK, now's the time to upgrade to
8392

8493
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/).
8594

95+
<a name="contributing"></a>
8696
## πŸ™Œ Want to Contribute?
8797

88-
We'd love your help in improving the Sentry SDK! Whether it's fixing bugs, adding features, or enhancing documentation, every contribution is valuable.
98+
We'd love your help in improving the Sentry SDK! Whether it's fixing bugs, adding features, writing new integrations, or enhancing documentation, every contribution is valuable.
8999

90-
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).
100+
For details on how to contribute, please read our [contribution guide](CONTRIBUTING.md) and explore the [open issues](https://github.com/getsentry/sentry-python/issues).
91101

102+
<a name="help"></a>
92103
## πŸ›Ÿ Need Help?
93104

94105
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!
95106

96-
## πŸ“š Resources
107+
<a name="resources"></a>
108+
## πŸ”— Resources
97109

98-
Here are additional resources to help you make the most of Sentry:
110+
Here are all resources to help you make the most of Sentry:
99111

100-
- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/) – Official documentation to get started.
101-
- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr) – Join our Discord community.
102-
- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry) – Follow us on X (Twitter) for updates.
103-
- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry) – Questions and answers related to Sentry.
112+
- [Documentation](https://docs.sentry.io/platforms/python/) - Official documentation to get started.
113+
- [Discord](https://img.shields.io/discord/621778831602221064) - Join our Discord community.
114+
- [X/Twitter](https://twitter.com/intent/follow?screen_name=getsentry) - Follow us on X (Twitter) for updates.
115+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry) - Questions and answers related to Sentry.
104116

117+
<a name="license"></a>
105118
## πŸ“ƒ License
106119

107120
The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information.
108121

122+
<a name="contributors"></a>
109123
## 😘 Contributors
110124

111125
Thanks to everyone who has helped improve the SDK!

0 commit comments

Comments
Β (0)