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

docs: readme

pull/16/head
Cullen Watson 2023-08-26 21:00:29 -05:00
parent 3210052177
commit 17c0f8698e
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -25,7 +25,7 @@ Request
├── 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
``` ```
#### Example #### Example
@ -47,7 +47,7 @@ site_type (enum)
└── response (SiteResponse) └── response (SiteResponse)
├── 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)
@ -64,7 +64,7 @@ site_type (enum)
│ │ ├── 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): Default is "US" │ │ └── currency (str): default is "US"
│ └── date_posted (datetime) │ └── date_posted (datetime)
├── total_results (int) ├── total_results (int)
└── returned_results (int) └── returned_results (int)
@ -279,11 +279,13 @@ _Python >= 3.10 required_
## Usage ## Usage
To see the interactive API documentation, visit [localhost:8000/docs](http://localhost:8000/docs). ### Swagger UI:
To interact with the API documentation, navigate to [localhost:8000/docs](http://localhost:8000/docs).
For Postman integration:
- Import the Postman collection and environment JSON files from the `/postman/` folder.
### Postman:
To use Postman:
1. Locate the files in the `/postman/` directory.
2. Import the Postman collection and environment JSON files.
## FAQ ## FAQ