docs: merge overview pages by TC-MO · Pull Request #732 · apify/apify-sdk-python

TC-MO · 2026-01-08T16:42:01Z

No description provided.

fix capitalization of Actor changes to formatting streamlining prose

codecov · 2026-01-08T16:43:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.90%. Comparing base (ed35b6d) to head (fcac824).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #732      +/-   ##
==========================================
- Coverage   81.98%   81.90%   -0.08%     
==========================================
  Files          46       46              
  Lines        2681     2681              
==========================================
- Hits         2198     2196       -2     
- Misses        483      485       +2

Flag	Coverage Δ
integration	`56.13% <ø> (ø)`
unit	`67.84% <ø> (-0.08%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

marcel-rbro · 2026-01-09T10:38:11Z

docs/01_overview/index.mdx

@@ -0,0 +1,163 @@
+---


General note:
Is it possible to move the overview page one level up, so that it is not in the Overview section? It's kinda weird UX-wise.

Yeah I was afraid that might happen. I think if we rename it to index.md it should not be separate openable section

marcel-rbro · 2026-01-09T10:39:40Z

docs/01_overview/index.mdx

+<Tabs>
+    <TabItem value="main.py" label="main.py" default>
+        <CodeBlock language="python">{
+`from apify import Actor
+${''}
+async def main():
+    async with Actor:
+        Actor.log.info('Actor input:', await Actor.get_input())
+        await Actor.set_value('OUTPUT', 'Hello, world!')`
+        }</CodeBlock>
+    </TabItem>
+    <TabItem value="__main__.py" label="__main.py__">
+        <CodeBlock language="python">{
+`import asyncio
+import logging
+${''}
+from apify.log import ActorLogFormatter
+${''}
+from .main import main
+${''}
+handler = logging.StreamHandler()
+handler.setFormatter(ActorLogFormatter())
+${''}
+apify_logger = logging.getLogger('apify')
+apify_logger.setLevel(logging.DEBUG)
+apify_logger.addHandler(handler)
+${''}
+asyncio.run(main())`
+        }</CodeBlock>
+    </TabItem>
+</Tabs>


Consider adding some code comments?

docs/01_overview/index.mdx

marcel-rbro · 2026-01-09T10:47:33Z

docs/01_overview/index.mdx

+
+## Requirements
+
+The Apify SDK requires Python version 3.8 or above to run Python Actors locally.


The docs previously said that the required version is 3.10 or above. Is this updated version correct?

Good point, I'll reach out and confirm the required version as client & sdk diverge here

based on uv.lock seems like 3.10 or above is required @vdusek can you confirm so we can update accordingly?

we test only on python 3.10+, afaik we dropped python 3.9 with the current v3 line

Thank you , I'll update accordingly that 3.10 or above is required

docs/01_overview/index.mdx

vdusek

When running it locally, clicking "Docs" or "Get Started" redirects to
http://localhost:3000/sdk/python/docs/overview/introduction, which results in a 404.

TC-MO · 2026-01-12T10:53:52Z

Thanks @vdusek the landing pages will removed shortly (That is why we are doing this consolidation) but I changed the links so they work properly just in case. Secondary nav has been fixed as well

rename consolidated page to index.mdx fix left side sidebar so it doesn't have 1 item in overview category, rather that overview is clickable page itself fix top side nav so Docs send to the new page fix link on landing page

Co-authored-by: Marcel Rebro <marcel.rebro@apify.com>

patrikbraborec · 2026-01-13T09:06:55Z

docs/01_overview/index.mdx

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


Does it have make sense to have the code example as the first thing in the overview?

patrikbraborec · 2026-01-13T09:07:36Z

docs/01_overview/index.mdx

+
+### Creating Actors
+
+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).


I think we should refer to the platform docs, not academy imho

patrikbraborec · 2026-01-13T09:14:17Z

docs/01_overview/index.mdx

+
+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.
+
+### Running the Actor


I think we could show example of the result (i.e. terminal output)

patrikbraborec · 2026-01-13T09:15:01Z

docs/01_overview/index.mdx

+
+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.
+
+The Actor input, for example, will be in `storage/key_value_stores/default/INPUT.json`.


This is quite important information, and we should enhance it as many people struggle with this (they do not know where they should define INPUT.json locally)

perhaps an admonition, let me try few different versions

Admonition wouldn't work after all since I would have to. do it for whole paragraph. I opted to use bullet list (even though I hate them :D) to better flow with the whole doc, while making the content in question more scannable and accentuated. Let me know if you think any further changes are needed

change links shorten language declaration in codeblock restructure prose about apify run command

add gif with terminal run of apify create command fix mdlint issue around blank space near codeblock

TC-MO · 2026-01-13T12:05:19Z

@vdusek should we be worried about tests failing or do they have no bearing on docs change that we want to do?

vdusek · 2026-01-13T12:11:10Z

@vdusek should we be worried about tests failing or do they have no bearing on docs change that we want to do?

I'll restart it, but there's no need to worry - the (integration) tests rely only on the codebase, not the docs.

marcel-rbro

LGTM 👍

TC-MO added 2 commits January 8, 2026 17:17

docs: merge overview pages

4737621

further changes

aaf5b50

fix capitalization of Actor changes to formatting streamlining prose

TC-MO self-assigned this Jan 8, 2026

TC-MO added documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team. labels Jan 8, 2026

TC-MO requested review from marcel-rbro and patrikbraborec January 9, 2026 09:09

Merge branch 'master' into consolidate-overview

190ca50

TC-MO marked this pull request as ready for review January 9, 2026 09:12

marcel-rbro requested changes Jan 9, 2026

View reviewed changes

vdusek requested changes Jan 9, 2026

View reviewed changes

TC-MO and others added 2 commits January 12, 2026 12:05

fix issues with navigation

43e38c2

rename consolidated page to index.mdx fix left side sidebar so it doesn't have 1 item in overview category, rather that overview is clickable page itself fix top side nav so Docs send to the new page fix link on landing page

Apply suggestions from code review

a079e40

Co-authored-by: Marcel Rebro <marcel.rebro@apify.com>

TC-MO requested review from marcel-rbro and vdusek January 12, 2026 12:32

patrikbraborec reviewed Jan 13, 2026

View reviewed changes

TC-MO added 3 commits January 13, 2026 11:22

update required python version

5891222

further changes

1874de2

change links shorten language declaration in codeblock restructure prose about apify run command

fix mdlint issues & add gif

fcac824

add gif with terminal run of apify create command fix mdlint issue around blank space near codeblock

vdusek approved these changes Jan 13, 2026

View reviewed changes

marcel-rbro approved these changes Jan 13, 2026

View reviewed changes

patrikbraborec approved these changes Jan 13, 2026

View reviewed changes

TC-MO merged commit 1467083 into master Jan 13, 2026
54 of 55 checks passed

TC-MO deleted the consolidate-overview branch January 13, 2026 15:22


		## Requirements

		The Apify SDK requires Python version 3.8 or above to run Python Actors locally.


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

		```python


		### Creating Actors

		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).


		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.

		### Running the Actor


		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.

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

Conversation

TC-MO commented Jan 8, 2026

Uh oh!

codecov bot commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vdusek left a comment

Choose a reason for hiding this comment

Uh oh!

TC-MO commented Jan 12, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TC-MO commented Jan 13, 2026

Uh oh!

vdusek commented Jan 13, 2026

Uh oh!

marcel-rbro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented Jan 8, 2026 •

edited

Loading