Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/01_overview/01_introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: introduction
title: Introduction
sidebar_label: Introduction
---

import CodeBlock from '@theme/CodeBlock';
Expand All @@ -21,34 +21,34 @@ Actors can be executed locally or on the [Apify platform](https://docs.apify.com

If you're new to Apify, refer to the Apify platform documentation to learn [what Apify is](https://docs.apify.com/platform/about).

## Quick Start
## Quick start

This section provides a quick start guide for creating and running Actors.

### Creating Actors

To create and run Actors using the Apify Console, see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
To create and run Actors using the Apify Console, see the [Console documentation](https://docs.apify.com/platform/console).

For creating and running Python Actors locally, refer to the documentation for [creating and running Python Actors locally](./running_locally).
For creating and running Python Actors locally, refer to the documentation for [creating and running Python Actors locally](./running-actors-locally).

### Guides

Integrate the Apify SDK with popular web scraping libraries by following these guides:
- [Requests or HTTPX](../guides/requests_and_httpx)
- [Beautiful Soup](../guides/beautiful_soup)
- [BeautifulSoup with HTTPX](../guides/beautifulsoup-httpx)
- [Crawlee](../guides/crawlee)
- [Playwright](../guides/playwright)
- [Selenium](../guides/selenium)
- [Scrapy](../guides/scrapy)

### Usage Concepts
### Usage concepts

For a deeper understanding of the Apify SDK's features, refer to the **Usage concepts** section in the sidebar. Key topics include:
- [Actor lifecycle](../concepts/actor-lifecycle)
- [Working with storages](../concepts/storages)
- [Handling Actor events](../concepts/actor-events)
- [Using proxies](../concepts/proxy-management)

## Installing the Apify SDK Separately
## Installing the Apify SDK separately

When creating an Actor using the Apify CLI, the Apify SDK for Python is installed automatically. If you want to install it independently, use the following command:

Expand Down
4 changes: 2 additions & 2 deletions docs/01_overview/02_running_actors_locally.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Running Actor locally
sidebar_label: Running Actors locally
id: running-actors-locally
title: Running Actors locally
---

import Tabs from '@theme/Tabs';
Expand Down
4 changes: 2 additions & 2 deletions docs/01_overview/03_actor_structure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: actor-structure
title: Actor structure
sidebar_label: Actor structure
---

import CodeBlock from '@theme/CodeBlock';
Expand All @@ -17,7 +17,7 @@ The `.actor/` directory contains the [Actor configuration](https://docs.apify.co
The Actor's runtime dependencies are specified in the `requirements.txt` file,
which follows the [standard requirements file format](https://pip.pypa.io/en/stable/reference/requirements-file-format/).

The Actor's source code is in the `src/` folder. This folder contains two important files: `main.py`, which contains the main function of the Actor, and `__main__.py`, which is the entrypoint of the Actor package, setting up the Actor [logger](../concepts/logging) and executing the Actor's main function via [`asyncio.run()`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
The Actor's source code is in the `src/` folder. This folder contains two important files: `main.py`, which contains the main function of the Actor, and `__main__.py`, which is the entrypoint of the Actor package, setting up the Actor [logger](../concepts/logging) and executing the Actor's main function via [`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).

<Tabs>
<TabItem value="main.py" label="main.py" default>
Expand Down
2 changes: 1 addition & 1 deletion docs/02_guides/01_beautifulsoup_httpx.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: beautifulsoup-httpx
title: Using BeautifulSoup with HTTPX
sidebar_label: Using BeautifulSoup with HTTPX
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/02_guides/02_crawlee.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: crawlee
title: Using Crawlee
sidebar_label: Using Crawlee
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/02_guides/03_playwright.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: playwright
title: Using Playwright
sidebar_label: Using Playwright
---

import Tabs from '@theme/Tabs';
Expand Down
2 changes: 1 addition & 1 deletion docs/02_guides/04_selenium.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: selenium
title: Using Selenium
sidebar_label: Using Selenium
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/02_guides/05_scrapy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: scrapy
title: Using Scrapy
sidebar_label: Using Scrapy
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/01_actor_lifecycle.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: actor-lifecycle
title: Actor lifecycle
sidebar_label: Actor lifecycle
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/02_actor_input.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: actor-input
title: Actor input
sidebar_label: Actor input
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/03_storages.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: storages
title: Working with storages
sidebar_label: Working with storages
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
4 changes: 2 additions & 2 deletions docs/03_concepts/04_actor_events.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Handling Actor events & persisting state
sidebar_label: Actor events & state persistence
id: actor-events
title: Actor events & state persistence
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/06_interacting_with_other_actors.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: interacting-with-other-actors
title: Interacting with other Actors
sidebar_label: Interacting with other Actors
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/07_webhooks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: webhooks
title: Creating webhooks
sidebar_label: Creating webhooks
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
4 changes: 2 additions & 2 deletions docs/03_concepts/08_access_apify_api.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Accessing the Apify API
sidebar_label: Accessing Apify API
id: access-apify-api
title: Accessing Apify API
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
4 changes: 2 additions & 2 deletions docs/03_concepts/09_running_webserver.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Running a webserver in your Actor
sidebar_label: Running a webserver
id: running-webserver
title: Running webserver in your Actor
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
2 changes: 1 addition & 1 deletion docs/03_concepts/10_logging.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: logging
title: Logging
sidebar_label: Logging
---

import CodeBlock from '@theme/CodeBlock';
Expand Down
6 changes: 4 additions & 2 deletions docs/03_concepts/11_configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Actor configuration and environment variables
sidebar_label: Configuration & env vars
id: actor-configuration
title: Actor configuration
---

import CodeBlock from '@theme/CodeBlock';
Expand All @@ -25,6 +25,8 @@ This will cause the Actor to persist its state every 10 seconds:

## Configuring via environment variables

All the configuration options can be set via environment variables. The environment variables are prefixed with `APIFY_`, and the configuration options are in uppercase, with underscores as separators. See the [`Configuration`](../../reference/class/Configuration) API reference for the full list of configuration options.

This Actor run will not persist its local storages to the filesystem:

```bash
Expand Down
Loading