@crawlee/playwright 3.0.0-alpha.0
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/LICENSE.md +201 -0
- package/README.md +214 -0
- package/package.json +65 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2018 Apify Technologies s.r.o.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# Crawlee: The scalable web crawling and scraping library for JavaScript
|
|
2
|
+
|
|
3
|
+
<!-- Mirror this part to src/index.js -->
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/apify)
|
|
6
|
+
[](https://www.npmjs.com/package/apify)
|
|
7
|
+
[](https://discord.gg/jyEM2PRvMU)
|
|
8
|
+
[](https://github.com/apify/apify-js/actions/workflows/test-and-release.yml)
|
|
9
|
+
|
|
10
|
+
Apify SDK simplifies the development of web crawlers, scrapers, data extractors and web automation jobs.
|
|
11
|
+
It provides tools to manage and automatically scale a pool of headless browsers,
|
|
12
|
+
to maintain queues of URLs to crawl, store crawling results to a local filesystem or into the cloud,
|
|
13
|
+
rotate proxies and much more.
|
|
14
|
+
The SDK is available as the [`apify`](https://www.npmjs.com/package/apify) NPM package.
|
|
15
|
+
It can be used either stand-alone in your own applications
|
|
16
|
+
or in [actors](https://docs.apify.com/actor)
|
|
17
|
+
running on the [Apify Cloud](https://apify.com/).
|
|
18
|
+
|
|
19
|
+
**View full documentation, guides and examples on the [Apify SDK project website](https://sdk.apify.com)**
|
|
20
|
+
|
|
21
|
+
## Motivation
|
|
22
|
+
|
|
23
|
+
Thanks to tools like [Playwright](https://github.com/microsoft/playwright), [Puppeteer](https://github.com/puppeteer/puppeteer) or
|
|
24
|
+
[Cheerio](https://www.npmjs.com/package/cheerio), it is easy to write Node.js code to extract data from web pages. But
|
|
25
|
+
eventually things will get complicated. For example, when you try to:
|
|
26
|
+
|
|
27
|
+
- Perform a deep crawl of an entire website using a persistent queue of URLs.
|
|
28
|
+
- Run your scraping code on a list of 100k URLs in a CSV file, without losing any data when your code crashes.
|
|
29
|
+
- Rotate proxies to hide your browser origin and keep user-like sessions.
|
|
30
|
+
- Disable browser fingerprinting protections used by websites.
|
|
31
|
+
|
|
32
|
+
Python has [Scrapy](https://scrapy.org/) for these tasks, but there was no such library for **JavaScript, the language of
|
|
33
|
+
the web**. The use of JavaScript is natural, since the same language is used to write the scripts as well as the data extraction code running in a
|
|
34
|
+
browser.
|
|
35
|
+
|
|
36
|
+
The goal of the Apify SDK is to fill this gap and provide a toolbox for generic web scraping, crawling and automation tasks in JavaScript. So don't
|
|
37
|
+
reinvent the wheel every time you need data from the web, and focus on writing code specific to the target website, rather than developing
|
|
38
|
+
commonalities.
|
|
39
|
+
|
|
40
|
+
## Overview
|
|
41
|
+
|
|
42
|
+
The Apify SDK is available as the [`apify`](https://www.npmjs.com/package/apify) NPM package and it provides the following tools:
|
|
43
|
+
|
|
44
|
+
- [`CheerioCrawler`](https://sdk.apify.com/docs/api/cheerio-crawler) - Enables the parallel crawling of a large
|
|
45
|
+
number of web pages using the [cheerio](https://www.npmjs.com/package/cheerio) HTML parser. This is the most
|
|
46
|
+
efficient web crawler, but it does not work on websites that require JavaScript.
|
|
47
|
+
|
|
48
|
+
- [`PuppeteerCrawler`](https://sdk.apify.com/docs/api/puppeteer-crawler) - Enables the parallel crawling of
|
|
49
|
+
a large number of web pages using the headless Chrome browser and [Puppeteer](https://github.com/puppeteer/puppeteer).
|
|
50
|
+
The pool of Chrome browsers is automatically scaled up and down based on available system resources.
|
|
51
|
+
|
|
52
|
+
- [`PlaywrightCrawler`](https://sdk.apify.com/docs/api/playwright-crawler) - Unlike `PuppeteerCrawler`
|
|
53
|
+
you can use [Playwright](https://github.com/microsoft/playwright) to manage almost any headless browser.
|
|
54
|
+
It also provides a cleaner and more mature interface while keeping the ease of use and advanced features.
|
|
55
|
+
|
|
56
|
+
- [`BasicCrawler`](https://sdk.apify.com/docs/api/basic-crawler) - Provides a simple framework for the parallel
|
|
57
|
+
crawling of web pages whose URLs are fed either from a static list or from a dynamic queue of URLs. This class
|
|
58
|
+
serves as a base for the more specialized crawlers above.
|
|
59
|
+
|
|
60
|
+
- [`RequestList`](https://sdk.apify.com/docs/api/request-list) - Represents a list of URLs to crawl.
|
|
61
|
+
The URLs can be passed in code or in a text file hosted on the web. The list persists its state so that crawling
|
|
62
|
+
can resume when the Node.js process restarts.
|
|
63
|
+
|
|
64
|
+
- [`RequestQueue`](https://sdk.apify.com/docs/api/request-queue) - Represents a queue of URLs to crawl,
|
|
65
|
+
which is stored either on a local filesystem or in the [Apify Cloud](https://apify.com). The queue is used
|
|
66
|
+
for deep crawling of websites, where you start with several URLs and then recursively follow links to other pages.
|
|
67
|
+
The data structure supports both breadth-first and depth-first crawling orders.
|
|
68
|
+
|
|
69
|
+
- [`Dataset`](https://sdk.apify.com/docs/api/dataset) - Provides a store for structured data and enables their export
|
|
70
|
+
to formats like JSON, JSONL, CSV, XML, Excel or HTML. The data is stored on a local filesystem or in the Apify Cloud.
|
|
71
|
+
Datasets are useful for storing and sharing large tabular crawling results, such as a list of products or real estate offers.
|
|
72
|
+
|
|
73
|
+
- [`KeyValueStore`](https://sdk.apify.com/docs/api/key-value-store) - A simple key-value store for arbitrary data
|
|
74
|
+
records or files, along with their MIME content type. It is ideal for saving screenshots of web pages, PDFs
|
|
75
|
+
or to persist the state of your crawlers. The data is stored on a local filesystem or in the Apify Cloud.
|
|
76
|
+
|
|
77
|
+
- [`AutoscaledPool`](https://sdk.apify.com/docs/api/autoscaled-pool) - Runs asynchronous background tasks,
|
|
78
|
+
while automatically adjusting the concurrency based on free system memory and CPU usage. This is useful for running
|
|
79
|
+
web scraping tasks at the maximum capacity of the system.
|
|
80
|
+
|
|
81
|
+
- [`Browser Utils`](https://sdk.apify.com/docs/api/puppeteer) - Provides several helper functions useful
|
|
82
|
+
for web scraping. For example, to inject jQuery into web pages or to hide browser origin.
|
|
83
|
+
|
|
84
|
+
Additionally, the package provides various helper functions to simplify running your code on the Apify Cloud and thus
|
|
85
|
+
take advantage of its pool of proxies, job scheduler, data storage, etc.
|
|
86
|
+
For more information, see the [Apify SDK Programmer's Reference](https://sdk.apify.com).
|
|
87
|
+
|
|
88
|
+
## Quick Start
|
|
89
|
+
|
|
90
|
+
This short tutorial will set you up to start using Apify SDK in a minute or two.
|
|
91
|
+
If you want to learn more, proceed to the [Getting Started](https://sdk.apify.com/docs/guides/getting-started)
|
|
92
|
+
tutorial that will take you step by step through creating your first scraper.
|
|
93
|
+
|
|
94
|
+
### Local stand-alone usage
|
|
95
|
+
|
|
96
|
+
Apify SDK requires [Node.js](https://nodejs.org/en/) 15.10 or later.
|
|
97
|
+
Add Apify SDK to any Node.js project by running:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
npm install apify playwright
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
> Neither `playwright` nor `puppeteer` are bundled with the SDK to reduce install size and allow greater
|
|
104
|
+
> flexibility. That's why we install it with NPM. You can choose one, both, or neither.
|
|
105
|
+
|
|
106
|
+
Run the following example to perform a recursive crawl of a website using Playwright. For more examples showcasing various features of the Apify SDK,
|
|
107
|
+
[see the Examples section of the documentation](https://sdk.apify.com/docs/examples/crawl-multiple-urls).
|
|
108
|
+
|
|
109
|
+
```javascript
|
|
110
|
+
const Apify = require('apify');
|
|
111
|
+
|
|
112
|
+
// Apify.main is a helper function, you don't need to use it.
|
|
113
|
+
Apify.main(async () => {
|
|
114
|
+
const requestQueue = await Apify.openRequestQueue();
|
|
115
|
+
// Choose the first URL to open.
|
|
116
|
+
await requestQueue.addRequest({ url: 'https://www.iana.org/' });
|
|
117
|
+
|
|
118
|
+
const crawler = new Apify.PlaywrightCrawler({
|
|
119
|
+
requestQueue,
|
|
120
|
+
handlePageFunction: async ({ request, page }) => {
|
|
121
|
+
// Extract HTML title of the page.
|
|
122
|
+
const title = await page.title();
|
|
123
|
+
console.log(`Title of ${request.url}: ${title}`);
|
|
124
|
+
|
|
125
|
+
// Add URLs that match the provided pattern.
|
|
126
|
+
await Apify.utils.enqueueLinks({
|
|
127
|
+
page,
|
|
128
|
+
requestQueue,
|
|
129
|
+
pseudoUrls: ['https://www.iana.org/[.*]'],
|
|
130
|
+
});
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
await crawler.run();
|
|
135
|
+
});
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
When you run the example, you should see Apify SDK automating a Chrome browser.
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
By default, Apify SDK stores data to `./apify_storage` in the current working directory. You can override this behavior by setting either the
|
|
143
|
+
`APIFY_LOCAL_STORAGE_DIR` or `APIFY_TOKEN` environment variable. For details, see [Environment variables](https://sdk.apify.com/docs/guides/environment-variables), [Request storage](https://sdk.apify.com/docs/guides/request-storage) and [Result storage](https://sdk.apify.com/docs/guides/result-storage).
|
|
144
|
+
|
|
145
|
+
### Local usage with Apify command-line interface (CLI)
|
|
146
|
+
|
|
147
|
+
To avoid the need to set the environment variables manually, to create a boilerplate of your project, and to enable pushing and running your code on
|
|
148
|
+
the [Apify platform](https://sdk.apify.com/docs/guides/apify-platform), you can use the [Apify command-line interface (CLI)](https://github.com/apify/apify-cli) tool.
|
|
149
|
+
|
|
150
|
+
Install the CLI by running:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
npm -g install apify-cli
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Now create a boilerplate of your new web crawling project by running:
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
apify create my-hello-world
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
The CLI will prompt you to select a project boilerplate template - just pick "Hello world". The tool will create a directory called `my-hello-world`
|
|
163
|
+
with a Node.js project files. You can run the project as follows:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
cd my-hello-world
|
|
167
|
+
apify run
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
By default, the crawling data will be stored in a local directory at `./apify_storage`. For example, the input JSON file for the actor is expected to
|
|
171
|
+
be in the default key-value store in `./apify_storage/key_value_stores/default/INPUT.json`.
|
|
172
|
+
|
|
173
|
+
Now you can easily deploy your code to the Apify platform by running:
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
apify login
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
apify push
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
Your script will be uploaded to the Apify platform and built there so that it can be run. For more information, view the
|
|
184
|
+
[Apify Actor](https://docs.apify.com/cli) documentation.
|
|
185
|
+
|
|
186
|
+
### Usage on the Apify platform
|
|
187
|
+
|
|
188
|
+
You can also develop your web scraping project in an online code editor directly on the [Apify platform](https://sdk.apify.com/docs/guides/apify-platform).
|
|
189
|
+
You'll need to have an Apify Account. Go to [Actors](https://console.apify.com/actors), page in the Apify Console, click <i>Create new</i>
|
|
190
|
+
and then go to the <i>Source</i> tab and start writing your code or paste one of the examples from the Examples section.
|
|
191
|
+
|
|
192
|
+
For more information, view the [Apify actors quick start guide](https://docs.apify.com/actor/quick-start).
|
|
193
|
+
|
|
194
|
+
## Support
|
|
195
|
+
|
|
196
|
+
If you find any bug or issue with the Apify SDK, please [submit an issue on GitHub](https://github.com/apify/apify-js/issues).
|
|
197
|
+
For questions, you can ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/apify) or contact support@apify.com
|
|
198
|
+
|
|
199
|
+
## Contributing
|
|
200
|
+
|
|
201
|
+
Your code contributions are welcome and you'll be praised to eternity!
|
|
202
|
+
If you have any ideas for improvements, either submit an issue or create a pull request.
|
|
203
|
+
For contribution guidelines and the code of conduct,
|
|
204
|
+
see [CONTRIBUTING.md](https://github.com/apify/apify-js/blob/master/CONTRIBUTING.md).
|
|
205
|
+
|
|
206
|
+
## License
|
|
207
|
+
|
|
208
|
+
This project is licensed under the Apache License 2.0 -
|
|
209
|
+
see the [LICENSE.md](https://github.com/apify/apify-js/blob/master/LICENSE.md) file for details.
|
|
210
|
+
|
|
211
|
+
## Acknowledgments
|
|
212
|
+
|
|
213
|
+
Many thanks to [Chema Balsas](https://www.npmjs.com/~jbalsas) for giving up the `apify` package name
|
|
214
|
+
on NPM and renaming his project to [jsdocify](https://www.npmjs.com/package/jsdocify).
|
package/package.json
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@crawlee/playwright",
|
|
3
|
+
"version": "3.0.0-alpha.0",
|
|
4
|
+
"description": "The scalable web crawling and scraping library for JavaScript/Node.js. Enables development of data extraction and web automation jobs (not only) with headless Chrome and Puppeteer.",
|
|
5
|
+
"engines": {
|
|
6
|
+
"node": ">=16.0.0"
|
|
7
|
+
},
|
|
8
|
+
"types": "index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": "./index.mjs",
|
|
12
|
+
"require": "./index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"apify",
|
|
17
|
+
"headless",
|
|
18
|
+
"chrome",
|
|
19
|
+
"puppeteer",
|
|
20
|
+
"crawler",
|
|
21
|
+
"scraper"
|
|
22
|
+
],
|
|
23
|
+
"author": {
|
|
24
|
+
"name": "Apify",
|
|
25
|
+
"email": "support@apify.com",
|
|
26
|
+
"url": "https://apify.com"
|
|
27
|
+
},
|
|
28
|
+
"contributors": [
|
|
29
|
+
"Jan Curn <jan@apify.com>",
|
|
30
|
+
"Marek Trunkat <marek@apify.com>",
|
|
31
|
+
"Ondra Urban <ondra@apify.com>"
|
|
32
|
+
],
|
|
33
|
+
"license": "Apache-2.0",
|
|
34
|
+
"repository": {
|
|
35
|
+
"type": "git",
|
|
36
|
+
"url": "git+https://github.com/apify/apify-js"
|
|
37
|
+
},
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/apify/apify-js/issues"
|
|
40
|
+
},
|
|
41
|
+
"homepage": "https://sdk.apify.com/",
|
|
42
|
+
"files": [
|
|
43
|
+
"dist"
|
|
44
|
+
],
|
|
45
|
+
"scripts": {
|
|
46
|
+
"build": "npm run clean && npm run compile && npm run copy",
|
|
47
|
+
"clean": "rimraf ./dist",
|
|
48
|
+
"compile": "tsc -p tsconfig.build.json && gen-esm-wrapper ./index.js ./index.mjs",
|
|
49
|
+
"copy": "ts-node -T ../../scripts/copy.ts"
|
|
50
|
+
},
|
|
51
|
+
"publishConfig": {
|
|
52
|
+
"access": "public"
|
|
53
|
+
},
|
|
54
|
+
"dependencies": {
|
|
55
|
+
"@crawlee/browser": "^3.0.0-alpha.0"
|
|
56
|
+
},
|
|
57
|
+
"peerDependencies": {
|
|
58
|
+
"playwright": "^1.11.0"
|
|
59
|
+
},
|
|
60
|
+
"peerDependenciesMeta": {
|
|
61
|
+
"playwright": {
|
|
62
|
+
"optional": true
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|