rent-scraper 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -37
- package/dist/bin/run-rent-scraper.d.mts +1 -0
- package/dist/bin/run-rent-scraper.mjs +2 -0
- package/dist/index.d.mts +5 -0
- package/dist/index.mjs +1 -0
- package/package.json +38 -34
package/README.md
CHANGED
|
@@ -1,39 +1,3 @@
|
|
|
1
1
|
# rent-scraper
|
|
2
2
|
|
|
3
|
-
Scrape data from rental listings
|
|
4
|
-
|
|
5
|
-
### Prerequisites
|
|
6
|
-
|
|
7
|
-
- Node.js >= 22
|
|
8
|
-
- pnpm package manager
|
|
9
|
-
- Google Chrome or Brave browser installed
|
|
10
|
-
|
|
11
|
-
### Setup Steps
|
|
12
|
-
|
|
13
|
-
1. Install pnpm globally (if not already installed):
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm install -g pnpm
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
2. Clone the repository and install dependencies:
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
git clone [repository-url]
|
|
23
|
-
cd rent-scraper
|
|
24
|
-
pnpm install
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
3. Build the project:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
pnpm run build
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Usage
|
|
34
|
-
|
|
35
|
-
### Running the Scraper
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
pnpm run rent-scraper
|
|
39
|
-
```
|
|
3
|
+
Scrape data from rental listings from the command line
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import e from"minimist";import{log as s}from"@clack/prompts";import{parseError as t}from"@rent-scraper/utils";import{runRentScraper as i}from"../index.mjs";import"@rent-scraper/utils/config";import"@rent-scraper/create-config";import"@rent-scraper/scrape-listings";const m=e(process.argv.slice(2)),p=m.source??"zillow";i(p).then(()=>process.exit(0)).catch(r=>{const{message:o}=t(r);s.error(o),process.exit(1)});
|
package/dist/index.d.mts
ADDED
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{checkForConfigFile as a}from"@rent-scraper/utils/config";import{runCreateConfig as n,runCheckConfig as i,runGenerateRegionIds as t}from"@rent-scraper/create-config";import{runScrapeListings as e}from"@rent-scraper/scrape-listings";async function o(r){await a(r)||await n(),await i(r),await t(r),await e()}export{o as runRentScraper};
|
package/package.json
CHANGED
|
@@ -1,48 +1,52 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rent-scraper",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"exports": {
|
|
6
|
+
".": {
|
|
7
|
+
"types": "./dist/index.d.mts",
|
|
8
|
+
"default": "./dist/index.mjs"
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
"author": "Max Stein <maxwell.stein@gmail.com> (https://maxstein.net)",
|
|
4
12
|
"license": "MIT",
|
|
5
|
-
"description": "
|
|
13
|
+
"description": "Scrape data from rental listings from the command line",
|
|
14
|
+
"bin": "./dist/bin/run-rent-scraper.mjs",
|
|
6
15
|
"files": [
|
|
7
16
|
"dist"
|
|
8
17
|
],
|
|
9
|
-
"
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/rent-brigade/rent-scraper.git",
|
|
21
|
+
"directory": "packages/cli"
|
|
22
|
+
},
|
|
23
|
+
"dependencies": {
|
|
24
|
+
"@clack/prompts": "alpha",
|
|
25
|
+
"axios": "^1.10.0",
|
|
26
|
+
"bumpp": "^10.2.3",
|
|
27
|
+
"dayjs": "^1.11.13",
|
|
28
|
+
"minimist": "^1.2.8",
|
|
29
|
+
"picocolors": "^1.1.1",
|
|
30
|
+
"@rent-scraper/api": "1.0.8",
|
|
31
|
+
"@rent-scraper/browser-server": "1.0.8",
|
|
32
|
+
"@rent-scraper/create-config": "1.0.8",
|
|
33
|
+
"@rent-scraper/scrape-listings": "1.0.8",
|
|
34
|
+
"@rent-scraper/utils": "1.0.8"
|
|
35
|
+
},
|
|
10
36
|
"devDependencies": {
|
|
11
|
-
"@
|
|
12
|
-
"
|
|
13
|
-
"
|
|
14
|
-
"globals": "^16.3.0",
|
|
15
|
-
"husky": "^9.1.7",
|
|
16
|
-
"lint-staged": "^16.1.2",
|
|
17
|
-
"prettier": "^3.6.2",
|
|
18
|
-
"typescript-eslint": "^8.35.1"
|
|
37
|
+
"@types/minimist": "^1.2.5",
|
|
38
|
+
"tsx": "^4.20.3",
|
|
39
|
+
"unbuild": "^3.5.0"
|
|
19
40
|
},
|
|
20
41
|
"engines": {
|
|
21
42
|
"node": "22.x"
|
|
22
43
|
},
|
|
23
|
-
"lint-staged": {
|
|
24
|
-
"*.{ts,js}": [
|
|
25
|
-
"eslint"
|
|
26
|
-
],
|
|
27
|
-
"*.{json,md}": [
|
|
28
|
-
"prettier --write"
|
|
29
|
-
]
|
|
30
|
-
},
|
|
31
44
|
"scripts": {
|
|
32
|
-
"build": "
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
-
"scrape-listings": "pnpm run --silent --filter scrape-listings start",
|
|
39
|
-
"create-config:dev": "pnpm run --filter create-config dev",
|
|
40
|
-
"create-config": "pnpm run --silent --filter create-config start",
|
|
41
|
-
"rent-scraper:dev": "pnpm run --filter rent-scraper dev",
|
|
42
|
-
"rent-scraper": "pnpm run --silent --filter rent-scraper start",
|
|
43
|
-
"typecheck": "pnpm run --parallel typecheck",
|
|
44
|
-
"lint": "pnpm run --parallel lint",
|
|
45
|
-
"lint:fix": "pnpm run --parallel lint:fix",
|
|
46
|
-
"release": "pnpm --parallel prepublish && bumpp -r && pnpm publish -r --no-git-checks --access=public"
|
|
45
|
+
"build": "unbuild",
|
|
46
|
+
"start": "node --env-file-if-exists=.env dist/bin/run-rent-scraper.mjs",
|
|
47
|
+
"dev": "tsx --env-file-if-exists=.env src/bin/run-rent-scraper.ts",
|
|
48
|
+
"typecheck": "tsc --noEmit",
|
|
49
|
+
"lint": "eslint .",
|
|
50
|
+
"lint:fix": "eslint --fix ."
|
|
47
51
|
}
|
|
48
52
|
}
|