diff --git a/README.md b/README.md index 29501064f3..10bc8eb2ed 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ Sentry for Python +
+_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/)_. + +[![Discord](https://img.shields.io/discord/621778831602221064?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb)](https://discord.gg/wdNEHETs87) +[![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=@getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry) +[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk) +python +[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml) + +
+ +
-_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 -[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml) -[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk) -[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA) +Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**. + + +## πŸ“¦ Getting Started -Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**! +### Prerequisites -## Getting Started +You need a Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects/). ### Installation @@ -25,7 +38,7 @@ pip install --upgrade sentry-sdk ### Basic Configuration -Here’s a quick configuration example to get Sentry up and running: +Here's a quick configuration example to get Sentry up and running: ```python import sentry_sdk @@ -34,7 +47,7 @@ sentry_sdk.init( "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. + # of traces for performance monitoring. traces_sample_rate=1.0, ) ``` @@ -46,36 +59,26 @@ With this configuration, Sentry will monitor for exceptions and performance issu 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 Sentry!") # You'll see this in your Sentry dashboard. +import sentry_sdk +sentry_sdk.init(...) # same as above + +sentry_sdk.capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard. raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry. ``` -#### Explore the Docs - -For more details on advanced usage, integrations, and customization, check out the full documentation: - -- [Official SDK Docs](https://docs.sentry.io/platforms/python/) -- [API Reference](https://getsentry.github.io/sentry-python/) -## Integrations +## πŸ“š Documentation -Sentry integrates with many popular Python libraries and frameworks, including: +For more details on advanced usage, integrations, and customization, check out the full documentation on [https://docs.sentry.io](https://docs.sentry.io/). -- [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/) -- [Celery](https://docs.sentry.io/platforms/python/integrations/celery/) -- [AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/) -Want more? [Check out the full list of integrations](https://docs.sentry.io/platforms/python/integrations/). +## 🧩 Integrations -### Rolling Your Own Integration? +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. -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 Between Versions? +## 🚧 Migrating Between Versions? ### From `1.x` to `2.x` @@ -85,30 +88,35 @@ If you're using the older `1.x` version of the SDK, now's the time to upgrade to 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/). -## Want to Contribute? -We’d love your help in improving the Sentry SDK! Whether it’s fixing bugs, adding features, or enhancing documentation, every contribution is valuable. +## πŸ™Œ Want to Contribute? -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). +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. -## Need Help? +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). -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 +## πŸ›Ÿ Need Help? -Here are additional resources to help you make the most of Sentry: +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! -- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/) – Official documentation to get started. -- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr) – Join our Discord community. -- [![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. -- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry) – Questions and answers related to Sentry. -## License +## πŸ”— Resources + +Here are all resources to help you make the most of Sentry: + +- [Documentation](https://docs.sentry.io/platforms/python/) - Official documentation to get started. +- [Discord](https://img.shields.io/discord/621778831602221064) - Join our Discord community. +- [X/Twitter](https://twitter.com/intent/follow?screen_name=getsentry) - Follow us on X (Twitter) for updates. +- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry) - Questions and answers related to Sentry. + + +## πŸ“ƒ License The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information. ---- + +## 😘 Contributors Thanks to everyone who has helped improve the SDK!