You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -51,78 +72,50 @@ Type checking is handled by [ty](https://docs.astral.sh/ty/), verifying code aga
51
72
To run type checking:
52
73
53
74
```sh
54
-
make type-check
75
+
uv run poe type-check
55
76
```
56
77
57
78
### Unit tests
58
79
59
-
We employ pytest as our testing framework, equipped with various plugins. Check pyproject.toml for configuration details and installed plugins.
60
-
61
80
We use [pytest](https://docs.pytest.org/) as a testing framework with many plugins. Check `pyproject.toml` for configuration details and installed plugins.
62
81
63
82
To run unit tests:
64
83
65
84
```sh
66
-
make unit-tests
85
+
uv run poe unit-tests
67
86
```
68
87
69
-
To run unit tests with HTML coverage report:
88
+
To run unit tests with XML coverage report:
70
89
71
90
```sh
72
-
make unit-tests-cov
91
+
uv run poe unit-tests-cov
73
92
```
74
93
75
94
## Integration tests
76
95
77
-
We have integration tests which build and run Actors using the Python SDK on the Apify Platform. To run these tests,
78
-
you need to set the `APIFY_TEST_USER_API_TOKEN` environment variable to the API token of the Apify user you want to
79
-
use for the tests, and then start them with `make integration-tests`.
80
-
81
-
If you want to run the integration tests on a different environment than the main Apify Platform, you need to set
82
-
the `APIFY_INTEGRATION_TESTS_API_URL` environment variable to the right URL to the Apify API you want to use.
83
-
84
-
## Documentation
85
-
86
-
We adhere to the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting our codebase. Every user-facing class or method is documented. Documentation standards are enforced using [Ruff](https://docs.astral.sh/ruff/).
87
-
88
-
Our API documentation is generated from these docstrings using [pydoc-markdown](https://pypi.org/project/pydoc-markdown/) with additional post-processing. Markdown files in the `docs/` folder complement the autogenerated content. Final documentation is rendered using [Docusaurus](https://docusaurus.io/) and published to GitHub Pages.
89
-
90
-
To run the documentation locally, you need to have Node.js version 20 or higher installed. Once you have the correct version of Node.js, follow these steps:
91
-
92
-
Navigate to the `website/` directory:
93
-
94
-
```sh
95
-
cd website/
96
-
```
96
+
We have integration tests which build and run Actors using the Python SDK on the Apify platform.
97
97
98
-
Enable Corepack, which installs Yarn automatically:
98
+
Prerequisites:
99
99
100
-
```sh
101
-
corepack enable
102
-
```
100
+
- Set `APIFY_TEST_USER_API_TOKEN` to your Apify API token
101
+
- Optionally set `APIFY_INTEGRATION_TESTS_API_URL` to use a different Apify API environment
103
102
104
-
Build the API reference:
103
+
To run integration tests:
105
104
106
105
```sh
107
-
./build_api_reference.sh
106
+
uv run poe integration-tests
108
107
```
109
108
110
-
Install the necessary dependencies:
111
-
112
-
```sh
113
-
yarn
114
-
```
109
+
## Documentation
115
110
116
-
Start the project in development mode with Hot Module Replacement (HMR):
111
+
We adhere to the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting our codebase. Every user-facing class or method is documented. Documentation standards are enforced using [Ruff](https://docs.astral.sh/ruff/).
117
112
118
-
```sh
119
-
yarn start
120
-
```
113
+
Our API documentation is generated from these docstrings using [pydoc-markdown](https://pypi.org/project/pydoc-markdown/) with additional post-processing. Markdown files in the `docs/` folder complement the autogenerated content. Final documentation is rendered using [Docusaurus](https://docusaurus.io/) and published to GitHub Pages.
121
114
122
-
Or using `make`:
115
+
To run the documentation locally (requires Node.js):
123
116
124
117
```sh
125
-
make run-doc
118
+
uv run poe run-docs
126
119
```
127
120
128
121
## Release process
@@ -147,14 +140,14 @@ name = "apify"
147
140
version = "x.z.y"
148
141
```
149
142
150
-
4.Generate the distribution archives for the package:
143
+
4.Build the package:
151
144
152
-
```shell
153
-
uv build
145
+
```sh
146
+
uv run poe build
154
147
```
155
148
156
-
5.Set up the PyPI API token for authentication and upload the package to PyPI:
0 commit comments