Skip to content

Commit 1874de2

Browse files
committed
further changes
change links shorten language declaration in codeblock restructure prose about apify run command
1 parent 5891222 commit 1874de2

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

docs/01_overview/index.mdx

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import CodeBlock from '@theme/CodeBlock';
99

1010
The Apify SDK for Python is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) in Python.
1111

12-
```python
12+
```py
1313
from apify import Actor
1414
from bs4 import BeautifulSoup
1515
import requests
@@ -37,42 +37,45 @@ pip install apify
3737
When you create an Actor using the Apify CLI, the Apify SDK for Python is installed for you automatically.
3838

3939
If you are not developing Apify Actors and you just need to access the Apify API from Python,
40-
consider using the [Apify API client for Python](https://docs.apify.com/api/client/python) directly.
40+
consider using the [Apify API client for Python](/api/client/python) directly.
4141

4242
## Quick start
4343

4444
### Creating Actors
4545

46-
To create and run Actors in Apify Console, refer to the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
46+
To create and run Actors in Apify Console, refer to the [Console documentation](/platform/actors/development/quick-start/web-ide).
4747

48-
To create a new Apify Actor on your computer, you can use the [Apify CLI](https://docs.apify.com/cli), and select one of the [Python Actor templates](https://apify.com/templates?category=python).
48+
To create a new Apify Actor on your computer, you can use the [Apify CLI](/cli), and select one of the [Python Actor templates](https://apify.com/templates?category=python).
4949

50-
For example, to create an Actor from the "[beta] Python SDK" template, you can use the [`apify create` command](https://docs.apify.com/cli/docs/reference#apify-create-actorname).
50+
For example, to create an Actor from the "[beta] Python SDK" template, you can use the [`apify create` command](/cli/docs/reference#apify-create-actorname).
5151

5252
```bash
5353
apify create my-first-actor --template python-start
5454
```
5555

5656
This will create a new folder called `my-first-actor`, download and extract the "Getting started with Python" Actor template there, create a virtual environment in `my-first-actor/.venv`, and install the Actor dependencies in it.
5757

58-
### Running the Actor
59-
60-
To run the Actor, you can use the [`apify run` command](https://docs.apify.com/cli/docs/reference#apify-run):
58+
#### Running the Actor
6159

60+
To run the Actor, you can use the [`apify run` command](/cli/docs/reference#apify-run):
6261
```bash
6362
cd my-first-actor
6463
apify run
6564
```
6665

67-
This will activate the virtual environment in `.venv` (if no other virtual environment is activated yet), then start the Actor, passing the right environment variables for local running, and configure it to use local storages from the `storage` folder.
66+
This command:
67+
68+
- Activates the virtual environment in `.venv` (if no other virtual environment is activated yet)
69+
- Starts the Actor with the appropriate environment variables for local running
70+
- Configures it to use local storages from the `storage` folder
6871

6972
The Actor input, for example, will be in `storage/key_value_stores/default/INPUT.json`.
7073

7174
## Actor structure
7275

7376
All Python Actor templates follow the same structure.
7477

75-
The `.actor` directory contains the [Actor configuration](https://docs.apify.com/platform/actors/development/actor-config), such as the Actor's definition and input schema, and the Dockerfile necessary to run the Actor on the Apify platform.
78+
The `.actor` directory contains the [Actor configuration](/platform/actors/development/actor-config), such as the Actor's definition and input schema, and the Dockerfile necessary to run the Actor on the Apify platform.
7679

7780
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/).
7881

0 commit comments

Comments
 (0)