Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cullenwatson authored Jun 2, 2024
1 parent d03c9a0 commit f7c22f4
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Features

- Scrapes staff from a company on **LinkedIn**
- Obtain skills, experiences, certifications & more
- Obtains skills, experiences, certifications & more
- Aggregates the employees in a Pandas DataFrame

### Installation
Expand All @@ -21,28 +21,41 @@ _Python version >= [3.10](https://www.python.org/downloads/release/python-3100/)
from staffspy import scrape_jobs

staff = scrape_staff(
company="openai"
company="openai",
results_wanted=20,

# optional filters
# search_term="software engineer",
# location="Dallas, TX",
# results_wanted=20,
# num_threads=10
)
print(f"Found {len(staff)} staff")
print(staff.head())
staff.to_csv("jobs.csv", index=False)
staff.to_csv("staff.csv", index=False)
```
A browser will open to sign in to LinkedIn. Press enter after signing in to begin scraping. Ctrl-c to stop scraping.

### Staff Schema

```plaintext
Staff
├── id
├── name
├── username
├── about
├── skills
├── position
├── profile_id
├── first_name
├── last_name
├── company
├── school
├── location
├── followers
├── connections
├── premium
├── creator
├── influencer
├── skills
├── profile_link
├── profile_photo
├── experiences
│ ├── position
│ ├── company
Expand Down

0 comments on commit f7c22f4

Please sign in to comment.