Update README.md

pull/40/head
Cullen Watson 2023-09-05 13:03:32 -05:00 committed by GitHub
parent 5191658562
commit d6947ecdd7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 76 deletions

111
README.md
View File

@ -10,7 +10,9 @@
![jobspy](https://github.com/cullenwatson/JobSpy/assets/78247585/ec7ef355-05f6-4fd3-8161-a817e31c5c57) ![jobspy](https://github.com/cullenwatson/JobSpy/assets/78247585/ec7ef355-05f6-4fd3-8161-a817e31c5c57)
### Installation ### Installation
`pip install python-jobspy` ```
pip install python-jobspy
```
_Python version >= [3.10](https://www.python.org/downloads/release/python-3100/) required_ _Python version >= [3.10](https://www.python.org/downloads/release/python-3100/) required_
@ -26,18 +28,18 @@ jobs: pd.DataFrame = scrape_jobs(
location="Dallas, TX", location="Dallas, TX",
results_wanted=10, results_wanted=10,
# country: only needed for indeed country='USA' # only needed for indeed
country='USA'
) )
if jobs.empty: if jobs.empty:
print("No jobs found.") print("No jobs found.")
else: else:
#1 print
pd.set_option('display.max_columns', None) pd.set_option('display.max_columns', None)
pd.set_option('display.max_rows', None) pd.set_option('display.max_rows', None)
pd.set_option('display.width', None) pd.set_option('display.width', None)
pd.set_option('display.max_colwidth', 50) # set to 0 to see full job url / desc pd.set_option('display.max_colwidth', 50) # set to 0 to see full job url / desc
#1 output
print(jobs) print(jobs)
#2 display in Jupyter Notebook #2 display in Jupyter Notebook
@ -68,8 +70,8 @@ Optional
├── job_type (enum): fulltime, parttime, internship, contract ├── job_type (enum): fulltime, parttime, internship, contract
├── is_remote (bool) ├── is_remote (bool)
├── results_wanted (int): number of job results to retrieve for each site specified in 'site_type' ├── results_wanted (int): number of job results to retrieve for each site specified in 'site_type'
├── easy_apply (bool): filters for jobs on LinkedIn that have the 'Easy Apply' option ├── easy_apply (bool): filters for jobs that are hosted on LinkedIn
├── country (enum): uses the corresponding subdomain on Indeed (e.g. Canada on Indeed is ca.indeed.com ├── country (enum): filters the country on Indeed
``` ```
@ -77,20 +79,20 @@ Optional
```plaintext ```plaintext
JobPost JobPost
├── title (str) ├── title (str)
├── company_name (str) ├── company (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): fulltime, parttime, internship, contract
├── compensation (object) ├── compensation (object)
│ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly │ ├── interval (enum): yearly, monthly, weekly, daily, hourly
│ ├── min_amount (int) │ ├── min_amount (int)
│ ├── max_amount (int) │ ├── max_amount (int)
│ └── currency (str) │ └── currency (enum)
└── date_posted (datetime) └── date_posted (date)
``` ```
## Supported Countries for Job Searching ## Supported Countries for Job Searching
@ -98,80 +100,37 @@ JobPost
### **LinkedIn** ### **LinkedIn**
LinkedIn searches globally. Use the `location` parameter LinkedIn searches globally & uses only the `location` parameter
### **ZipRecruiter** ### **ZipRecruiter**
ZipRecruiter searches for jobs in US/Canada. Use the `location` parameter ZipRecruiter searches for jobs in US/Canada & uses only the `location` parameter
### **Indeed** ### **Indeed**
For Indeed, use `location` along with `country` param For Indeed, the `country` parameter is required. Additionally, use the `location` parameter and include the city or state if necessary.
You can specify the following countries when searching on Indeed (use the exact name): You can specify the following countries when searching on Indeed (use the exact name):
- Argentina
- Australia | | | | |
- Austria |------|------|------|------|
- Bahrain | Argentina | Australia | Austria | Bahrain |
- Belgium | Belgium | Brazil | Canada | Chile |
- Brazil | China | Colombia | Costa Rica | Czech Republic |
- Canada | Denmark | Ecuador | Egypt | Finland |
- Chile | France | Germany | Greece | Hong Kong |
- China | Hungary | India | Indonesia | Ireland |
- Colombia | Israel | Italy | Japan | Kuwait |
- Costa Rica | Luxembourg | Malaysia | Mexico | Morocco |
- Czech Republic | Netherlands | New Zealand | Nigeria | Norway |
- Denmark | Oman | Pakistan | Panama | Peru |
- Ecuador | Philippines | Poland | Portugal | Qatar |
- Egypt | Romania | Saudi Arabia | Singapore | South Africa |
- Finland | South Korea | Spain | Sweden | Switzerland |
- France | Taiwan | Thailand | Turkey | Ukraine |
- Germany | United Arab Emirates | UK | USA | Uruguay |
- Greece | Venezuela | Vietnam | | |
- Hong Kong
- Hungary
- India
- Indonesia
- Ireland
- Israel
- Italy
- Japan
- Kuwait
- Luxembourg
- Malaysia
- Mexico
- Morocco
- Netherlands
- New Zealand
- Nigeria
- Norway
- Oman
- Pakistan
- Panama
- Peru
- Philippines
- Poland
- Portugal
- Qatar
- Romania
- Saudi Arabia
- Singapore
- South Africa
- South Korea
- Spain
- Sweden
- Switzerland
- Taiwan
- Thailand
- Turkey
- Ukraine
- United Arab Emirates
- UK
- USA
- Uruguay
- Venezuela
- Vietnam
## Frequently Asked Questions ## Frequently Asked Questions