From d869ef4459b3049bf42dbe080ebe30a548a1fa10 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 14 Mar 2025 10:15:08 +0100 Subject: [PATCH 1/5] testing emojis --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 29501064f3..6a2d3d376b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**! -## Getting Started +## :rocket: Getting Started ### Installation @@ -25,7 +25,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 @@ -59,7 +59,7 @@ For more details on advanced usage, integrations, and customization, check out t - [Official SDK Docs](https://docs.sentry.io/platforms/python/) - [API Reference](https://getsentry.github.io/sentry-python/) -## Integrations +## :electric_plug: Integrations Sentry integrates with many popular Python libraries and frameworks, including: @@ -73,9 +73,9 @@ Want more? [Check out the full list of integrations](https://docs.sentry.io/plat ### Rolling Your Own Integration? -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. +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? +## :arrows_counterclockwise: Migrating Between Versions? ### From `1.x` to `2.x` @@ -85,17 +85,17 @@ 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? +## :raised_hands: 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. +We'd love your help in improving the Sentry SDK! Whether it's fixing bugs, adding features, or enhancing documentation, every contribution is valuable. 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). -## Need Help? +## :lifering: 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! +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 +## :books: Resources Here are additional resources to help you make the most of Sentry: @@ -104,12 +104,14 @@ Here are additional resources to help you make the most of Sentry: - [![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 +## :page_with_curl: License The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information. --- +## :kissing_heart: Contributors + Thanks to everyone who has helped improve the SDK! From b9f5f0ef1e82f93dcd6118ada063cec84fc04d6f Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 14 Mar 2025 10:26:08 +0100 Subject: [PATCH 2/5] new emoji --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6a2d3d376b..c1c2beee9c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ 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/)_. # Official Sentry SDK for Python @@ -13,7 +11,7 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**! -## :rocket: Getting Started +## 🚀 Getting Started ### Installation @@ -59,7 +57,7 @@ For more details on advanced usage, integrations, and customization, check out t - [Official SDK Docs](https://docs.sentry.io/platforms/python/) - [API Reference](https://getsentry.github.io/sentry-python/) -## :electric_plug: Integrations +## 🧩 Integrations Sentry integrates with many popular Python libraries and frameworks, including: @@ -75,7 +73,7 @@ Want more? [Check out the full list of integrations](https://docs.sentry.io/plat 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. -## :arrows_counterclockwise: Migrating Between Versions? +## 🚧 Migrating Between Versions? ### From `1.x` to `2.x` @@ -85,17 +83,17 @@ 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/). -## :raised_hands: Want to Contribute? +## 🙌 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. 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). -## :lifering: Need Help? +## 🛟 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! -## :books: Resources +## 📚 Resources Here are additional resources to help you make the most of Sentry: @@ -104,13 +102,11 @@ Here are additional resources to help you make the most of Sentry: - [![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. -## :page_with_curl: License +## 📃 License The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information. ---- - -## :kissing_heart: Contributors +## 😘 Contributors Thanks to everyone who has helped improve the SDK! From e233b98be080da4daa05306e4b9c5b58a1a5980d Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 14 Mar 2025 11:41:00 +0100 Subject: [PATCH 3/5] Improving stuff --- README.md | 82 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 48 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index c1c2beee9c..0eb9e34b8a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,35 @@ 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/)_. -# 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) +
+ +[![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) -[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA) +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 + +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 @@ -32,7 +50,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, ) ``` @@ -44,35 +62,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 + +## 📚 Documentation -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/) +For more details on advanced usage, integrations, and customization, check out the full documentation on [https://docs.sentry.io](https://docs.sentry.io/). + ## 🧩 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/) -- [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/). - -### 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? ### 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 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. +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. -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). +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). + ## 🛟 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 + +## 🔗 Resources -Here are additional resources to help you make the most of Sentry: +Here are all resources to help you make the most of Sentry: -- [![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. +- [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! From c49a6beaff7a8952619c0e44abc1a22ac6bc2a02 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 14 Mar 2025 11:42:57 +0100 Subject: [PATCH 4/5] Remove stuff --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0eb9e34b8a..ad0c702be1 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@
-
- [![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) @@ -24,7 +22,7 @@ _Bad software is everywhere, and we're tired of it. Sentry is on a mission to he Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**. - + ## 📦 Getting Started ### Prerequisites @@ -70,18 +68,17 @@ sentry_sdk.capture_message("Hello Sentry!") # You'll see this in your Sentry da raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry. ``` - + ## 📚 Documentation For more details on advanced usage, integrations, and customization, check out the full documentation on [https://docs.sentry.io](https://docs.sentry.io/). - + ## 🧩 Integrations 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. - ## 🚧 Migrating Between Versions? ### From `1.x` to `2.x` @@ -92,19 +89,19 @@ 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, writing new integrations, or enhancing documentation, every contribution is valuable. 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). - + ## 🛟 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 Here are all resources to help you make the most of Sentry: @@ -119,7 +116,7 @@ Here are all resources to help you make the most of Sentry: 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! From 14037780c4479aa96bb9aadd8c9e2c1d0e687ba6 Mon Sep 17 00:00:00 2001 From: Anton Pirker Date: Fri, 14 Mar 2025 11:44:26 +0100 Subject: [PATCH 5/5] stuff --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad0c702be1..10bc8eb2ed 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ 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/)_. -