diff --git a/README.md b/README.md
index 6dba3f06ef..29501064f3 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
+
_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, [**check out our open positions**](https://sentry.io/careers/)_.
# Official Sentry SDK for Python
@@ -10,23 +11,27 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he
[](https://pypi.python.org/pypi/sentry-sdk)
[](https://discord.gg/cWnMQeA)
-This is the official Python SDK for [Sentry](http://sentry.io/)
+Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**!
## Getting Started
-### Install
+### Installation
+
+Getting Sentry into your project is straightforward. Just run this command in your terminal:
```bash
pip install --upgrade sentry-sdk
```
-### Configuration
+### Basic Configuration
+
+Here’s a quick configuration example to get Sentry up and running:
```python
import sentry_sdk
sentry_sdk.init(
- "https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1",
+ "https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1", # Your DSN here
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
@@ -34,78 +39,78 @@ sentry_sdk.init(
)
```
-### Usage
+With this configuration, Sentry will monitor for exceptions and performance issues.
+
+### Quick Usage Example
+
+To generate some events that will show up in Sentry, you can log messages or capture errors:
```python
from sentry_sdk import capture_message
-capture_message("Hello World") # Will create an event in Sentry.
+capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard.
-raise ValueError() # Will also create an event in Sentry.
+raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry.
```
-- To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/python/).
-- Are you coming from `raven-python`? [Use this migration guide](https://docs.sentry.io/platforms/python/migration/).
-- To learn about internals use the [API Reference](https://getsentry.github.io/sentry-python/).
+#### Explore the Docs
-## Integrations
+For more details on advanced usage, integrations, and customization, check out the full documentation:
-(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).)
+- [Official SDK Docs](https://docs.sentry.io/platforms/python/)
+- [API Reference](https://getsentry.github.io/sentry-python/)
-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:
+## Integrations
+
+Sentry integrates with many popular Python libraries and frameworks, including:
- [Django](https://docs.sentry.io/platforms/python/integrations/django/)
- [Flask](https://docs.sentry.io/platforms/python/integrations/flask/)
- [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/)
-- [AIOHTTP](https://docs.sentry.io/platforms/python/integrations/aiohttp/)
-- [SQLAlchemy](https://docs.sentry.io/platforms/python/integrations/sqlalchemy/)
-- [asyncpg](https://docs.sentry.io/platforms/python/integrations/asyncpg/)
-- [Redis](https://docs.sentry.io/platforms/python/integrations/redis/)
- [Celery](https://docs.sentry.io/platforms/python/integrations/celery/)
-- [Apache Airflow](https://docs.sentry.io/platforms/python/integrations/airflow/)
-- [Apache Spark](https://docs.sentry.io/platforms/python/integrations/pyspark/)
-- [asyncio](https://docs.sentry.io/platforms/python/integrations/asyncio/)
-- [Graphene](https://docs.sentry.io/platforms/python/integrations/graphene/)
-- [Logging](https://docs.sentry.io/platforms/python/integrations/logging/)
-- [Loguru](https://docs.sentry.io/platforms/python/integrations/loguru/)
-- [HTTPX](https://docs.sentry.io/platforms/python/integrations/httpx/)
- [AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/)
-- [Google Cloud Functions](https://docs.sentry.io/platforms/python/integrations/gcp-functions/)
+Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/).
+
+### Rolling Your Own Integration?
-## Migrating
+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.
-### Migrating From `1.x` to `2.x`
+## Migrating Between Versions?
-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).
+### From `1.x` to `2.x`
-### Migrating From `raven-python`
+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.
-The old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).
+### From `raven-python`
-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/).
+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/).
-## Contributing to the SDK
+## Want to Contribute?
-Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+We’d love your help in improving the Sentry SDK! Whether it’s fixing bugs, adding features, or enhancing documentation, every contribution is valuable.
-## Getting Help/Support
+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).
-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!
+## Need Help?
+
+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!
## Resources
-- [](https://docs.sentry.io/quickstart/)
-- [](https://forum.sentry.io/c/sdks)
-- [](https://discord.gg/Ww9hbqr)
-- [](http://stackoverflow.com/questions/tagged/sentry)
-- [](https://twitter.com/intent/follow?screen_name=getsentry)
+Here are additional resources to help you make the most of Sentry:
+
+- [](https://docs.sentry.io/quickstart/) – Official documentation to get started.
+- [](https://discord.gg/Ww9hbqr) – Join our Discord community.
+- [](https://twitter.com/intent/follow?screen_name=getsentry) – Follow us on X (Twitter) for updates.
+- [](http://stackoverflow.com/questions/tagged/sentry) – Questions and answers related to Sentry.
## License
-Licensed under the MIT license, see [`LICENSE`](LICENSE)
+The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information.
+---
-### Thanks to all the people who contributed!
+Thanks to everyone who has helped improve the SDK!
