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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28-11Lines changed: 28 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,23 @@ We use [uv](https://docs.astral.sh/uv/) for project management. Install it and s
11
11
We use [Poe the Poet](https://poethepoet.natn.io/) as a task runner, similar to npm scripts in `package.json`.
12
12
All tasks are defined in `pyproject.toml` under `[tool.poe.tasks]` and can be run with `uv run poe <task>`.
13
13
14
+
### Available tasks
15
+
16
+
| Task | Description |
17
+
| ---- | ----------- |
18
+
|`install-dev`| Install dependencies and pre-commit hooks |
19
+
|`check-code`| Run lint, type-check, and unit-tests |
20
+
|`lint`| Run linter |
21
+
|`format`| Fix lint issues and format code |
22
+
|`type-check`| Run type checker |
23
+
|`unit-tests`| Run unit tests |
24
+
|`unit-tests-cov`| Run unit tests with coverage |
25
+
|`e2e-templates-tests`| Run end-to-end template tests |
26
+
|`build-docs`| Build documentation website |
27
+
|`run-docs`| Run documentation locally |
28
+
|`build`| Build package |
29
+
|`clean`| Remove build artifacts |
30
+
14
31
## Dependencies
15
32
16
33
To install this package and its development dependencies, run:
@@ -51,7 +68,7 @@ uv run poe format
51
68
52
69
Type checking is handled by [ty](https://docs.astral.sh/ty/), verifying code against type annotations. Configuration settings can be found in `pyproject.toml`.
-`apify-cli`available in `PATH` environment variable
81
-
- Your [apify token](https://docs.apify.com/platform/integrations/api#api-token) is available in `APIFY_TEST_USER_API_TOKEN` environment variable
95
+
Prerequisites:
96
+
97
+
-[apify-cli](https://docs.apify.com/cli/docs/installation) installed and available in `PATH`
98
+
- Set `APIFY_TEST_USER_API_TOKEN` to your [Apify API token](https://docs.apify.com/platform/integrations/api#api-token)
82
99
83
100
To run end-to-end tests:
84
101
@@ -90,7 +107,7 @@ uv run poe e2e-templates-tests
90
107
91
108
We follow the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for code documentation. All user-facing classes and functions must be documented. Documentation standards are enforced using [Ruff](https://docs.astral.sh/ruff/).
92
109
93
-
Our API documentation is generated from these docstrings using [pydoc-markdown](https://pypi.org/project/pydoc-markdown/) with custom post-processing. Additional content is provided through markdown files in the `docs/` directory. The final documentation is rendered using [Docusaurus](https://docusaurus.io/) and published to GitHub pages.
110
+
Our API documentation is generated from these docstrings using [pydoc-markdown](https://pypi.org/project/pydoc-markdown/) with custom post-processing. Additional content is provided through markdown files in the `docs/` directory. The final documentation is rendered using [Docusaurus](https://docusaurus.io/) and published to GitHub Pages.
94
111
95
112
To run the documentation locally, ensure you have `Node.js` 20+ installed, then run:
96
113
@@ -120,14 +137,14 @@ name = "crawlee"
120
137
version = "x.z.y"
121
138
```
122
139
123
-
4.Generate the distribution archives for the package:
140
+
4.Build the package:
124
141
125
-
```shell
126
-
uv build
142
+
```sh
143
+
uv run poe build
127
144
```
128
145
129
-
5.Set up the PyPI API token for authentication and upload the package to PyPI:
0 commit comments