Skip to content

Commit 8e339bd

Browse files
committed
Merge branch 'master' into potel-base
2 parents 7cd4c8d + 8d48961 commit 8e339bd

File tree

1 file changed

+47
-42
lines changed

1 file changed

+47
-42
lines changed

README.md

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<img src="https://sentry-brand.storage.googleapis.com/github-banners/github-sdk-python.png" alt="Sentry for Python">
33
</a>
44

5+
56
_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/)_.
67

78
# 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
1011
[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk)
1112
[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA)
1213

13-
This is the official Python SDK for [Sentry](http://sentry.io/)
14+
Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**!
1415

1516
## Getting Started
1617

17-
### Install
18+
### Installation
19+
20+
Getting Sentry into your project is straightforward. Just run this command in your terminal:
1821

1922
```bash
2023
pip install --upgrade sentry-sdk
2124
```
2225

23-
### Configuration
26+
### Basic Configuration
27+
28+
Here’s a quick configuration example to get Sentry up and running:
2429

2530
```python
2631
import sentry_sdk
2732

2833
sentry_sdk.init(
29-
"https://[email protected]/1",
34+
"https://[email protected]/1", # Your DSN here
3035

3136
# Set traces_sample_rate to 1.0 to capture 100%
3237
# of transactions for performance monitoring.
3338
traces_sample_rate=1.0,
3439
)
3540
```
3641

37-
### Usage
42+
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:
3847

3948
```python
4049
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.
4251

43-
raise ValueError() # Will also create an event in Sentry.
52+
raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry.
4453
```
4554

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
4956

50-
## Integrations
57+
For more details on advanced usage, integrations, and customization, check out the full documentation:
5158

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).)
59+
- [Official SDK Docs](https://docs.sentry.io/platforms/python/)
60+
- [API Reference](https://getsentry.github.io/sentry-python/)
5361

54-
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:
5565

5666
- [Django](https://docs.sentry.io/platforms/python/integrations/django/)
5767
- [Flask](https://docs.sentry.io/platforms/python/integrations/flask/)
5868
- [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/)
59-
- [AIOHTTP](https://docs.sentry.io/platforms/python/integrations/aiohttp/)
60-
- [SQLAlchemy](https://docs.sentry.io/platforms/python/integrations/sqlalchemy/)
61-
- [asyncpg](https://docs.sentry.io/platforms/python/integrations/asyncpg/)
62-
- [Redis](https://docs.sentry.io/platforms/python/integrations/redis/)
6369
- [Celery](https://docs.sentry.io/platforms/python/integrations/celery/)
64-
- [Apache Airflow](https://docs.sentry.io/platforms/python/integrations/airflow/)
65-
- [Apache Spark](https://docs.sentry.io/platforms/python/integrations/pyspark/)
66-
- [asyncio](https://docs.sentry.io/platforms/python/integrations/asyncio/)
67-
- [Graphene](https://docs.sentry.io/platforms/python/integrations/graphene/)
68-
- [Logging](https://docs.sentry.io/platforms/python/integrations/logging/)
69-
- [Loguru](https://docs.sentry.io/platforms/python/integrations/loguru/)
70-
- [HTTPX](https://docs.sentry.io/platforms/python/integrations/httpx/)
7170
- [AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/)
72-
- [Google Cloud Functions](https://docs.sentry.io/platforms/python/integrations/gcp-functions/)
7371

72+
Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/).
73+
74+
### Rolling Your Own Integration?
7475

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.
7677

77-
### Migrating From `1.x` to `2.x`
78+
## Migrating Between Versions?
7879

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`
8081

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.
8283

83-
The old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).
84+
### From `raven-python`
8485

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/).
8687

87-
## Contributing to the SDK
88+
## Want to Contribute?
8889

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.
9091

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).
9293

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!
9497

9598
## Resources
9699

97-
- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/)
98-
- [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
99-
- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)
100-
- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)
101-
- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)
100+
Here are additional resources to help you make the most of Sentry:
101+
102+
- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/) – Official documentation to get started.
103+
- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr) – Join our Discord community.
104+
- [![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.
105+
- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry) – Questions and answers related to Sentry.
102106

103107
## License
104108

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.
106110

111+
---
107112

108-
### Thanks to all the people who contributed!
113+
Thanks to everyone who has helped improve the SDK!
109114

110115
<a href="https://github.com/getsentry/sentry-python/graphs/contributors">
111116
<img src="https://contributors-img.web.app/image?repo=getsentry/sentry-python" />

0 commit comments

Comments
 (0)