An open API service indexing awesome lists of open source software.

https://github.com/jemaf/stackoverflow-jobs

A wrapper for crawling data at Stack Overflow Jobs portal
https://github.com/jemaf/stackoverflow-jobs

crawler jobs python stack-overflow

Last synced: 17 days ago
JSON representation

A wrapper for crawling data at Stack Overflow Jobs portal

Awesome Lists containing this project

README

          

**This project is archived since Stack Overflow Jobs no longer exists.**

# stackoverflow-jobs

Simple wrapper for crawling jobs data at Stack Overflow Jobs portal.

## Basic usage

Creating a query is pretty straightforward:

```python
from stackoverflow_jobs.query import Query

q = Query()
```

All query filters are available inside `filters` module. In case you want to
add new filters, all you need to do is to append them to the `Query` object:

```python
from stackoverflow_jobs.query import Query
from stackoverflow_jobs.filters import Role, Remote, Description

q = Query() \
+ Description("Android Developer") \
+ Remote() \
+ Role([Role.Type.MOBILE])
```

After you build your query, call `execute()` to fetch the data:

```python
data = q.execute()
```

By default, queries requests are timed out after 60 seconds. You can change the
timeout value in two different ways:

1. `Query(timeout)`: Every query will end up after the specified `timeout`.
1. `execute(timeout)`: Set up timeout for a specific query execution.

```python
q1 = Query() # Timeout default value: 60 seconds
q2 = Query(25) # Timeout custom value: 25 seconds

q1.execute() # timeout: 60 seconds
q2.execute() # timeout: 25 seconds

q1.execute(5) # timeout: 5 seconds
q2.execute(5) # timeout: 5 seconds
```

**Important note:** The library queries Stack Overflow Jobs RSS feed. This
means that you need to parse the XML afterwards.

You can also retrieve the query URL using `build_query()` method, in case you
need to:

```python
q.build_query()
>>> 'https://stackoverflow.com/jobs/feed?q=Android+Developer&r=true&dr=MobileDeveloper'
```

## Installing

`stackoverflow-jobs` is available in pypi repository:

```bash
pip install stackoverflow-jobs
```