turtlebasket
/
JobSpy
mirror of https://github.com/Bunsly/JobSpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

pull/22/head
Cullen Watson 2023-08-27 16:52:27 -05:00 committed by GitHub
parent c94b874065
commit 98e226eefc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@ -12,64 +12,56 @@
POST `/api/v1/jobs/` POST `/api/v1/jobs/`
### Request Schema ### Request Schema
```plaintext ```plaintex
{ Required
Required ├── site_type (List[enum]): linkedin, zip_recruiter, indeed
├── site_type (List[enum]): linkedin, zip_recruiter, indeed └── search_term (str)
└── search_term (str) Optional
Optional ├── location (int)
├── location (int) ├── distance (int)
├── distance (int) ├── job_type (enum): fulltime, parttime, internship, contract
├── job_type (enum): fulltime, parttime, internship, contract ├── is_remote (bool)
├── is_remote (bool) ├── results_wanted (int): per site_type
├── results_wanted (int): per site_type ├── easy_apply (bool): only for linkedin
├── easy_apply (bool): only for linkedin └── output_format (enum): json, csv
└── output_format (enum): json, csv
}
``` ```
### Request Example ### Request Example
```json ```json
{ "site_type": ["indeed", "linkedin"],
"site_type": ["indeed", "linkedin"], "search_term": "software engineer",
"search_term": "software engineer", "location": "austin, tx",
"location": "austin, tx", "distance": 10,
"distance": 10, "job_type": "fulltime",
"job_type": "fulltime", "results_wanted": 15
"results_wanted": 15
}
``` ```
### Response Schema ### Response Schema
```plaintext ```plaintext
{ site_type (enum):
site_type (enum): { JobResponse
JobResponse ├── success (bool)
├── success (bool) ├── error (str)
├── error (str) ├── jobs (List[JobPost])
├── jobs (List[JobPost]) │ └── JobPost
│ └── JobPost │ ├── title (str)
│ ├── title (str) │ ├── company_name (str)
│ ├── company_name (str) │ ├── job_url (str)
│ ├── job_url (str) │ ├── location (object)
│ ├── location (object) │ │ ├── country (str)
│ │ ├── country (str) │ │ ├── city (str)
│ │ ├── city (str) │ │ ├── state (str)
│ │ ├── state (str) │ ├── description (str)
│ ├── description (str) │ ├── job_type (enum)
│ ├── job_type (enum) │ ├── compensation (object)
│ ├── compensation (object) │ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly
│ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly │ │ ├── min_amount (float)
│ │ ├── min_amount (float) │ │ ├── max_amount (float)
│ │ ├── max_amount (float) │ │ └── currency (str)
│ │ └── currency (str): default is "US" │ └── date_posted (datetime)
│ └── date_posted (datetime) │
│ ├── total_results (int)
├── total_results (int) └── returned_results (int)
└── returned_results (int)
}, ...
}
``` ```
### Response Example (JSON) ### Response Example (JSON)
@ -134,7 +126,7 @@ linkedin, Software Engineer 1, Public Partnerships | PPL, https://www.linkedin.c
``` ```
## Installation ## Installation
_Python >= 3.10 required_ _Python version >= [3.10](https://www.python.org/downloads/release/python-3100/) required_
1. Clone this repository `git clone https://github.com/cullenwatson/jobspy` 1. Clone this repository `git clone https://github.com/cullenwatson/jobspy`
2. Install the dependencies with `pip install -r requirements.txt` 2. Install the dependencies with `pip install -r requirements.txt`
4. Run the server with `uvicorn main:app --reload` 4. Run the server with `uvicorn main:app --reload`
@ -153,8 +145,10 @@ To use Postman:
### I'm having issues with my queries. What should I do? ### I'm having issues with my queries. What should I do?
Broadening your filters can often help. Additionally, try reducing the number of `results_wanted`. Try reducing the number of `results_wanted` and/or broadening the filters. If issues still persist, feel free to submit an issue.
If issues still persist, feel free to submit an issue.
### I'm getting response code 429. What should I do?
You have been blocked by the job board site for sending too many requests. Wait a couple seconds or use a VPN.
### How to enable auth? ### How to enable auth?