semvec/pypi-packages huggingface dataset:
scrapy-sentry-errors 1.0.0
Scrapy extension that logs errors to Sentry
License: BSD
Requires Python: >=3.8

# 🐞 scrapy-sentry-errors

A simple Scrapy extension that logs spider errors to your Sentry account, helping you monitor and fix issues with your Scrapy spiders efficiently. 🚀

> **Note**: While this extension captures errors from Scrapy spiders, it does not capture errors elsewhere in Scrapy's operation (e.g., the Scrapy pipeline).

## 📋 Requirements 

- Python 3.8 or higher
- A [Sentry](http://www.getsentry.com/) account.
- The [DSN](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/) for your Sentry project.

## 🛠️ Installation 

```bash
pip install city-scrapers-sentry
```

## 🏗️ Setup

Add `SENTRY_DSN` and `scrapy_sentry_errors.extensions.Errors` extension to your Scrapy project's `settings.py` file:

Example:

```
# sentry dsn
SENTRY_DSN = 'http://public:secret@example.com/1'
EXTENSIONS = {
    "scrapy_sentry_errors.extensions.Errors": 10,
}
```

Sentry spider errors will be logged to your Sentry account.

## 💻 Development 

1. Clone this repository.
   
2. Run the dev setup script and follow the prompts. This will create a virtual environment and a `.env` file with your Sentry DSN:
```
bash ./scripts/dev_setup.sh
```

3. Simulate a failed spider run using the example Scrapy project in this repo:
```
pipenv run example
```

## 🧪 Testing

Run the tests with:
```
pipenv run test
```

## 📦 Publishing

1. Bump the version number in `pyproject.toml`
   
2. Create a new build with:
```
pipenv run build
```

3. Publish the build to PyPI with:
```
pipenv run publish
```

## 🤝 Contributing

We welcome contributions of all kinds from anyone. Here are some ways you can contribute:

- **Reporting Bugs**: If you find a bug, please report it by opening an issue. Be sure to provide a detailed description of the bug and, if possible, steps to reproduce it.
- **Suggesting Enhancements**: Have an idea for a new feature or think something could be improved? Let us know by opening an issue.
- **Code Contributions**: Feel free to fork the repository and submit pull requests. Whether it's fixing a bug, adding a feature, or improving documentation, your help is welcome.


## 🙏 Acknowledgements 

This project began as a fork of [scrapy-sentry](https://github.com/llonchj/scrapy-sentry), which was developed by Jordi Llonch. We are grateful for his work and those of other contributors.