apify 1.0.0b3__tar.gz → 1.0.0b5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of apify might be problematic. Click here for more details.

Files changed (44) hide show
  1. apify-1.0.0b5/PKG-INFO +89 -0
  2. apify-1.0.0b5/README.md +62 -0
  3. apify-1.0.0b5/src/apify/_version.py +1 -0
  4. apify-1.0.0b5/src/apify.egg-info/PKG-INFO +89 -0
  5. apify-1.0.0b3/PKG-INFO +0 -108
  6. apify-1.0.0b3/README.md +0 -81
  7. apify-1.0.0b3/src/apify/_version.py +0 -1
  8. apify-1.0.0b3/src/apify.egg-info/PKG-INFO +0 -108
  9. {apify-1.0.0b3 → apify-1.0.0b5}/LICENSE +0 -0
  10. {apify-1.0.0b3 → apify-1.0.0b5}/setup.cfg +0 -0
  11. {apify-1.0.0b3 → apify-1.0.0b5}/setup.py +0 -0
  12. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/__init__.py +0 -0
  13. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_crypto.py +0 -0
  14. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/__init__.py +0 -0
  15. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/file_storage_utils.py +0 -0
  16. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/memory_storage_client.py +0 -0
  17. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/__init__.py +0 -0
  18. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/base_resource_client.py +0 -0
  19. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/base_resource_collection_client.py +0 -0
  20. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/dataset.py +0 -0
  21. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/dataset_collection.py +0 -0
  22. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/key_value_store.py +0 -0
  23. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/key_value_store_collection.py +0 -0
  24. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/request_queue.py +0 -0
  25. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_memory_storage/resource_clients/request_queue_collection.py +0 -0
  26. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_types.py +0 -0
  27. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/_utils.py +0 -0
  28. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/actor.py +0 -0
  29. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/config.py +0 -0
  30. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/consts.py +0 -0
  31. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/event_manager.py +0 -0
  32. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/log.py +0 -0
  33. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/proxy_configuration.py +0 -0
  34. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/py.typed +0 -0
  35. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/__init__.py +0 -0
  36. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/base_storage.py +0 -0
  37. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/dataset.py +0 -0
  38. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/key_value_store.py +0 -0
  39. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/request_queue.py +0 -0
  40. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify/storages/storage_client_manager.py +0 -0
  41. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify.egg-info/SOURCES.txt +0 -0
  42. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify.egg-info/dependency_links.txt +0 -0
  43. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify.egg-info/requires.txt +0 -0
  44. {apify-1.0.0b3 → apify-1.0.0b5}/src/apify.egg-info/top_level.txt +0 -0
apify-1.0.0b5/PKG-INFO ADDED
@@ -0,0 +1,89 @@
1
+ Metadata-Version: 2.1
2
+ Name: apify
3
+ Version: 1.0.0b5
4
+ Summary: Apify SDK for Python
5
+ Home-page: https://github.com/apify/apify-sdk-python
6
+ Author: Apify Technologies s.r.o.
7
+ Author-email: support@apify.com
8
+ License: Apache Software License
9
+ Project-URL: Documentation, https://docs.apify.com/sdk/python/
10
+ Project-URL: Source, https://github.com/apify/apify-sdk-python
11
+ Project-URL: Issue tracker, https://github.com/apify/apify-sdk-python/issues
12
+ Project-URL: Apify Homepage, https://apify.com
13
+ Keywords: apify,sdk,actor,scraping,automation
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: License :: OSI Approved :: Apache Software License
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3.8
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Topic :: Software Development :: Libraries
23
+ Requires-Python: >=3.8
24
+ Description-Content-Type: text/markdown
25
+ Provides-Extra: dev
26
+ License-File: LICENSE
27
+
28
+ # Apify SDK for Python
29
+
30
+ The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
31
+ It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
32
+
33
+ If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
34
+ check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
35
+
36
+ ## Documentation
37
+
38
+ For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/).
39
+
40
+ ## Example
41
+
42
+ ```python
43
+ from apify import Actor
44
+ from bs4 import BeautifulSoup
45
+ import requests
46
+
47
+ async def main():
48
+ async with Actor:
49
+ response = requests.get('https://apify.com')
50
+ soup = BeautifulSoup(response.content, 'html.parser')
51
+ await Actor.push_data({ 'url': url, 'title': soup.title.string })
52
+ ```
53
+
54
+ ## What are Actors?
55
+
56
+ Actors are serverless cloud programs that can do almost anything a human can do in a web browser.
57
+ They can do anything from small tasks such as filling in forms or unsubscribing from online services,
58
+ all the way up to scraping and processing vast numbers of web pages.
59
+
60
+ They can be run either locally, or on the [Apify platform](https://docs.apify.com/platform/),
61
+ where you can run them at scale, monitor them, schedule them, or publish and monetize them.
62
+
63
+ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/about) in the Apify platform documentation.
64
+
65
+ ## Creating Actors
66
+
67
+ To create and run Actors through Apify Console,
68
+ see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
69
+
70
+ To create and run Python Actors locally, check the documentation for [how to create and run Python Actors locally](https://docs.apify.com/sdk/python/docs/overview/running-locally).
71
+
72
+ ## Guides
73
+
74
+ To see how you can use the Apify SDK with other popular libraries used for web scraping,
75
+ check out our guides for using
76
+ [Requests and HTTPX](https://docs.apify.com/sdk/python/docs/guides/requests-and-httpx),
77
+ [Beautiful Soup](https://docs.apify.com/sdk/python/docs/guides/beautiful-soup),
78
+ [Playwright](https://docs.apify.com/sdk/python/docs/guides/playwright),
79
+ [Selenium](https://docs.apify.com/sdk/python/docs/guides/selenium),
80
+ or [Scrapy](https://docs.apify.com/sdk/python/docs/guides/scrapy).
81
+
82
+ ## Usage concepts
83
+
84
+ To learn more about the features of the Apify SDK and how to use them,
85
+ check out the Usage Concepts section in the sidebar,
86
+ particularly the guides for the [Actor lifecycle](https://docs.apify.com/sdk/python/docs/concepts/actor-lifecycle),
87
+ [working with storages](https://docs.apify.com/sdk/python/docs/concepts/storages),
88
+ [handling Actor events](https://docs.apify.com/sdk/python/docs/concepts/actor-events)
89
+ or [how to use proxies](https://docs.apify.com/sdk/python/docs/concepts/proxy-management).
@@ -0,0 +1,62 @@
1
+ # Apify SDK for Python
2
+
3
+ The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
4
+ It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
5
+
6
+ If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
7
+ check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
8
+
9
+ ## Documentation
10
+
11
+ For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/).
12
+
13
+ ## Example
14
+
15
+ ```python
16
+ from apify import Actor
17
+ from bs4 import BeautifulSoup
18
+ import requests
19
+
20
+ async def main():
21
+ async with Actor:
22
+ response = requests.get('https://apify.com')
23
+ soup = BeautifulSoup(response.content, 'html.parser')
24
+ await Actor.push_data({ 'url': url, 'title': soup.title.string })
25
+ ```
26
+
27
+ ## What are Actors?
28
+
29
+ Actors are serverless cloud programs that can do almost anything a human can do in a web browser.
30
+ They can do anything from small tasks such as filling in forms or unsubscribing from online services,
31
+ all the way up to scraping and processing vast numbers of web pages.
32
+
33
+ They can be run either locally, or on the [Apify platform](https://docs.apify.com/platform/),
34
+ where you can run them at scale, monitor them, schedule them, or publish and monetize them.
35
+
36
+ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/about) in the Apify platform documentation.
37
+
38
+ ## Creating Actors
39
+
40
+ To create and run Actors through Apify Console,
41
+ see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
42
+
43
+ To create and run Python Actors locally, check the documentation for [how to create and run Python Actors locally](https://docs.apify.com/sdk/python/docs/overview/running-locally).
44
+
45
+ ## Guides
46
+
47
+ To see how you can use the Apify SDK with other popular libraries used for web scraping,
48
+ check out our guides for using
49
+ [Requests and HTTPX](https://docs.apify.com/sdk/python/docs/guides/requests-and-httpx),
50
+ [Beautiful Soup](https://docs.apify.com/sdk/python/docs/guides/beautiful-soup),
51
+ [Playwright](https://docs.apify.com/sdk/python/docs/guides/playwright),
52
+ [Selenium](https://docs.apify.com/sdk/python/docs/guides/selenium),
53
+ or [Scrapy](https://docs.apify.com/sdk/python/docs/guides/scrapy).
54
+
55
+ ## Usage concepts
56
+
57
+ To learn more about the features of the Apify SDK and how to use them,
58
+ check out the Usage Concepts section in the sidebar,
59
+ particularly the guides for the [Actor lifecycle](https://docs.apify.com/sdk/python/docs/concepts/actor-lifecycle),
60
+ [working with storages](https://docs.apify.com/sdk/python/docs/concepts/storages),
61
+ [handling Actor events](https://docs.apify.com/sdk/python/docs/concepts/actor-events)
62
+ or [how to use proxies](https://docs.apify.com/sdk/python/docs/concepts/proxy-management).
@@ -0,0 +1 @@
1
+ __version__ = '1.0.0b5'
@@ -0,0 +1,89 @@
1
+ Metadata-Version: 2.1
2
+ Name: apify
3
+ Version: 1.0.0b5
4
+ Summary: Apify SDK for Python
5
+ Home-page: https://github.com/apify/apify-sdk-python
6
+ Author: Apify Technologies s.r.o.
7
+ Author-email: support@apify.com
8
+ License: Apache Software License
9
+ Project-URL: Documentation, https://docs.apify.com/sdk/python/
10
+ Project-URL: Source, https://github.com/apify/apify-sdk-python
11
+ Project-URL: Issue tracker, https://github.com/apify/apify-sdk-python/issues
12
+ Project-URL: Apify Homepage, https://apify.com
13
+ Keywords: apify,sdk,actor,scraping,automation
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: License :: OSI Approved :: Apache Software License
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3.8
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Programming Language :: Python :: 3.11
22
+ Classifier: Topic :: Software Development :: Libraries
23
+ Requires-Python: >=3.8
24
+ Description-Content-Type: text/markdown
25
+ Provides-Extra: dev
26
+ License-File: LICENSE
27
+
28
+ # Apify SDK for Python
29
+
30
+ The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
31
+ It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
32
+
33
+ If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
34
+ check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
35
+
36
+ ## Documentation
37
+
38
+ For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/).
39
+
40
+ ## Example
41
+
42
+ ```python
43
+ from apify import Actor
44
+ from bs4 import BeautifulSoup
45
+ import requests
46
+
47
+ async def main():
48
+ async with Actor:
49
+ response = requests.get('https://apify.com')
50
+ soup = BeautifulSoup(response.content, 'html.parser')
51
+ await Actor.push_data({ 'url': url, 'title': soup.title.string })
52
+ ```
53
+
54
+ ## What are Actors?
55
+
56
+ Actors are serverless cloud programs that can do almost anything a human can do in a web browser.
57
+ They can do anything from small tasks such as filling in forms or unsubscribing from online services,
58
+ all the way up to scraping and processing vast numbers of web pages.
59
+
60
+ They can be run either locally, or on the [Apify platform](https://docs.apify.com/platform/),
61
+ where you can run them at scale, monitor them, schedule them, or publish and monetize them.
62
+
63
+ If you're new to Apify, learn [what is Apify](https://docs.apify.com/platform/about) in the Apify platform documentation.
64
+
65
+ ## Creating Actors
66
+
67
+ To create and run Actors through Apify Console,
68
+ see the [Console documentation](https://docs.apify.com/academy/getting-started/creating-actors#choose-your-template).
69
+
70
+ To create and run Python Actors locally, check the documentation for [how to create and run Python Actors locally](https://docs.apify.com/sdk/python/docs/overview/running-locally).
71
+
72
+ ## Guides
73
+
74
+ To see how you can use the Apify SDK with other popular libraries used for web scraping,
75
+ check out our guides for using
76
+ [Requests and HTTPX](https://docs.apify.com/sdk/python/docs/guides/requests-and-httpx),
77
+ [Beautiful Soup](https://docs.apify.com/sdk/python/docs/guides/beautiful-soup),
78
+ [Playwright](https://docs.apify.com/sdk/python/docs/guides/playwright),
79
+ [Selenium](https://docs.apify.com/sdk/python/docs/guides/selenium),
80
+ or [Scrapy](https://docs.apify.com/sdk/python/docs/guides/scrapy).
81
+
82
+ ## Usage concepts
83
+
84
+ To learn more about the features of the Apify SDK and how to use them,
85
+ check out the Usage Concepts section in the sidebar,
86
+ particularly the guides for the [Actor lifecycle](https://docs.apify.com/sdk/python/docs/concepts/actor-lifecycle),
87
+ [working with storages](https://docs.apify.com/sdk/python/docs/concepts/storages),
88
+ [handling Actor events](https://docs.apify.com/sdk/python/docs/concepts/actor-events)
89
+ or [how to use proxies](https://docs.apify.com/sdk/python/docs/concepts/proxy-management).
apify-1.0.0b3/PKG-INFO DELETED
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: apify
3
- Version: 1.0.0b3
4
- Summary: Apify SDK for Python
5
- Home-page: https://github.com/apify/apify-sdk-python
6
- Author: Apify Technologies s.r.o.
7
- Author-email: support@apify.com
8
- License: Apache Software License
9
- Project-URL: Documentation, https://docs.apify.com/sdk/python/
10
- Project-URL: Source, https://github.com/apify/apify-sdk-python
11
- Project-URL: Issue tracker, https://github.com/apify/apify-sdk-python/issues
12
- Project-URL: Apify Homepage, https://apify.com
13
- Keywords: apify,sdk,actor,scraping,automation
14
- Classifier: Development Status :: 4 - Beta
15
- Classifier: Intended Audience :: Developers
16
- Classifier: License :: OSI Approved :: Apache Software License
17
- Classifier: Operating System :: OS Independent
18
- Classifier: Programming Language :: Python :: 3.8
19
- Classifier: Programming Language :: Python :: 3.9
20
- Classifier: Programming Language :: Python :: 3.10
21
- Classifier: Programming Language :: Python :: 3.11
22
- Classifier: Topic :: Software Development :: Libraries
23
- Requires-Python: >=3.8
24
- Description-Content-Type: text/markdown
25
- Provides-Extra: dev
26
- License-File: LICENSE
27
-
28
- # Apify SDK for Python
29
-
30
- The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
31
- It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
32
-
33
- If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
34
- check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
35
-
36
- ## Installation
37
-
38
- Requires Python 3.8+
39
-
40
- You can install the package from its [PyPI listing](https://pypi.org/project/apify).
41
- To do that, simply run `pip install apify` in your terminal.
42
-
43
- ## Usage
44
-
45
- For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/) or in [`docs/docs.md`](docs/docs.md).
46
-
47
- ## Development
48
-
49
- ### Environment
50
-
51
- For local development, it is required to have Python 3.8 installed.
52
-
53
- It is recommended to set up a virtual environment while developing this package to isolate your development environment,
54
- however, due to the many varied ways Python can be installed and virtual environments can be set up,
55
- this is left up to the developers to do themselves.
56
-
57
- One recommended way is with the built-in `venv` module:
58
-
59
- ```bash
60
- python3 -m venv .venv
61
- source .venv/bin/activate
62
- ```
63
-
64
- To improve on the experience, you can use [pyenv](https://github.com/pyenv/pyenv) to have an environment with a pinned Python version,
65
- and [direnv](https://github.com/direnv/direnv) to automatically activate/deactivate the environment when you enter/exit the project folder.
66
-
67
- ### Dependencies
68
-
69
- To install this package and its development dependencies, run `make install-dev`
70
-
71
- ### Formatting
72
-
73
- We use `autopep8` and `isort` to automatically format the code to a common format. To run the formatting, just run `make format`.
74
-
75
- ### Linting, type-checking and unit testing
76
-
77
- We use `flake8` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
78
-
79
- ### Integration tests
80
-
81
- We have integration tests which build and run actors using the Python SDK on the Apify Platform.
82
- To run these tests, you need to set the `APIFY_TEST_USER_API_TOKEN` environment variable to the API token of the Apify user you want to use for the tests,
83
- and then start them with `make integration-tests`.
84
-
85
- If you want to run the integration tests on a different environment than the main Apify Platform,
86
- you need to set the `APIFY_INTEGRATION_TESTS_API_URL` environment variable to the right URL to the Apify API you want to use.
87
-
88
- ### Documentation
89
-
90
- We use the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting the code.
91
- We document every user-facing class or method, and enforce that using the flake8-docstrings library.
92
-
93
- The documentation is then rendered from the docstrings in the code using Sphinx and some heavy post-processing and saved as `docs/docs.md`.
94
- To generate the documentation, just run `make docs`.
95
-
96
- ### Release process
97
-
98
- Publishing new versions to [PyPI](https://pypi.org/project/apify) happens automatically through GitHub Actions.
99
-
100
- On each commit to the `master` branch, a new beta release is published, taking the version number from `src/apify/_version.py`
101
- and automatically incrementing the beta version suffix by 1 from the last beta release published to PyPI.
102
-
103
- A stable version is published when a new release is created using GitHub Releases, again taking the version number from `src/apify/_version.py`. The built package assets are automatically uploaded to the GitHub release.
104
-
105
- If there is already a stable version with the same version number as in `src/apify/_version.py` published to PyPI, the publish process fails,
106
- so don't forget to update the version number before releasing a new version.
107
- The release process also fails when the released version is not described in `CHANGELOG.md`,
108
- so don't forget to describe the changes in the new version there.
apify-1.0.0b3/README.md DELETED
@@ -1,81 +0,0 @@
1
- # Apify SDK for Python
2
-
3
- The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
4
- It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
5
-
6
- If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
7
- check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
8
-
9
- ## Installation
10
-
11
- Requires Python 3.8+
12
-
13
- You can install the package from its [PyPI listing](https://pypi.org/project/apify).
14
- To do that, simply run `pip install apify` in your terminal.
15
-
16
- ## Usage
17
-
18
- For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/) or in [`docs/docs.md`](docs/docs.md).
19
-
20
- ## Development
21
-
22
- ### Environment
23
-
24
- For local development, it is required to have Python 3.8 installed.
25
-
26
- It is recommended to set up a virtual environment while developing this package to isolate your development environment,
27
- however, due to the many varied ways Python can be installed and virtual environments can be set up,
28
- this is left up to the developers to do themselves.
29
-
30
- One recommended way is with the built-in `venv` module:
31
-
32
- ```bash
33
- python3 -m venv .venv
34
- source .venv/bin/activate
35
- ```
36
-
37
- To improve on the experience, you can use [pyenv](https://github.com/pyenv/pyenv) to have an environment with a pinned Python version,
38
- and [direnv](https://github.com/direnv/direnv) to automatically activate/deactivate the environment when you enter/exit the project folder.
39
-
40
- ### Dependencies
41
-
42
- To install this package and its development dependencies, run `make install-dev`
43
-
44
- ### Formatting
45
-
46
- We use `autopep8` and `isort` to automatically format the code to a common format. To run the formatting, just run `make format`.
47
-
48
- ### Linting, type-checking and unit testing
49
-
50
- We use `flake8` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
51
-
52
- ### Integration tests
53
-
54
- We have integration tests which build and run actors using the Python SDK on the Apify Platform.
55
- To run these tests, you need to set the `APIFY_TEST_USER_API_TOKEN` environment variable to the API token of the Apify user you want to use for the tests,
56
- and then start them with `make integration-tests`.
57
-
58
- If you want to run the integration tests on a different environment than the main Apify Platform,
59
- you need to set the `APIFY_INTEGRATION_TESTS_API_URL` environment variable to the right URL to the Apify API you want to use.
60
-
61
- ### Documentation
62
-
63
- We use the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting the code.
64
- We document every user-facing class or method, and enforce that using the flake8-docstrings library.
65
-
66
- The documentation is then rendered from the docstrings in the code using Sphinx and some heavy post-processing and saved as `docs/docs.md`.
67
- To generate the documentation, just run `make docs`.
68
-
69
- ### Release process
70
-
71
- Publishing new versions to [PyPI](https://pypi.org/project/apify) happens automatically through GitHub Actions.
72
-
73
- On each commit to the `master` branch, a new beta release is published, taking the version number from `src/apify/_version.py`
74
- and automatically incrementing the beta version suffix by 1 from the last beta release published to PyPI.
75
-
76
- A stable version is published when a new release is created using GitHub Releases, again taking the version number from `src/apify/_version.py`. The built package assets are automatically uploaded to the GitHub release.
77
-
78
- If there is already a stable version with the same version number as in `src/apify/_version.py` published to PyPI, the publish process fails,
79
- so don't forget to update the version number before releasing a new version.
80
- The release process also fails when the released version is not described in `CHANGELOG.md`,
81
- so don't forget to describe the changes in the new version there.
@@ -1 +0,0 @@
1
- __version__ = '1.0.0b3'
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: apify
3
- Version: 1.0.0b3
4
- Summary: Apify SDK for Python
5
- Home-page: https://github.com/apify/apify-sdk-python
6
- Author: Apify Technologies s.r.o.
7
- Author-email: support@apify.com
8
- License: Apache Software License
9
- Project-URL: Documentation, https://docs.apify.com/sdk/python/
10
- Project-URL: Source, https://github.com/apify/apify-sdk-python
11
- Project-URL: Issue tracker, https://github.com/apify/apify-sdk-python/issues
12
- Project-URL: Apify Homepage, https://apify.com
13
- Keywords: apify,sdk,actor,scraping,automation
14
- Classifier: Development Status :: 4 - Beta
15
- Classifier: Intended Audience :: Developers
16
- Classifier: License :: OSI Approved :: Apache Software License
17
- Classifier: Operating System :: OS Independent
18
- Classifier: Programming Language :: Python :: 3.8
19
- Classifier: Programming Language :: Python :: 3.9
20
- Classifier: Programming Language :: Python :: 3.10
21
- Classifier: Programming Language :: Python :: 3.11
22
- Classifier: Topic :: Software Development :: Libraries
23
- Requires-Python: >=3.8
24
- Description-Content-Type: text/markdown
25
- Provides-Extra: dev
26
- License-File: LICENSE
27
-
28
- # Apify SDK for Python
29
-
30
- The Apify SDK for Python is the official library to create [Apify Actors](https://docs.apify.com/platform/actors) in Python.
31
- It provides useful features like actor lifecycle management, local storage emulation, and actor event handling.
32
-
33
- If you just need to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications,
34
- check out the [Apify Client for Python](https://docs.apify.com/api/client/python) instead.
35
-
36
- ## Installation
37
-
38
- Requires Python 3.8+
39
-
40
- You can install the package from its [PyPI listing](https://pypi.org/project/apify).
41
- To do that, simply run `pip install apify` in your terminal.
42
-
43
- ## Usage
44
-
45
- For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/sdk/python/) or in [`docs/docs.md`](docs/docs.md).
46
-
47
- ## Development
48
-
49
- ### Environment
50
-
51
- For local development, it is required to have Python 3.8 installed.
52
-
53
- It is recommended to set up a virtual environment while developing this package to isolate your development environment,
54
- however, due to the many varied ways Python can be installed and virtual environments can be set up,
55
- this is left up to the developers to do themselves.
56
-
57
- One recommended way is with the built-in `venv` module:
58
-
59
- ```bash
60
- python3 -m venv .venv
61
- source .venv/bin/activate
62
- ```
63
-
64
- To improve on the experience, you can use [pyenv](https://github.com/pyenv/pyenv) to have an environment with a pinned Python version,
65
- and [direnv](https://github.com/direnv/direnv) to automatically activate/deactivate the environment when you enter/exit the project folder.
66
-
67
- ### Dependencies
68
-
69
- To install this package and its development dependencies, run `make install-dev`
70
-
71
- ### Formatting
72
-
73
- We use `autopep8` and `isort` to automatically format the code to a common format. To run the formatting, just run `make format`.
74
-
75
- ### Linting, type-checking and unit testing
76
-
77
- We use `flake8` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
78
-
79
- ### Integration tests
80
-
81
- We have integration tests which build and run actors using the Python SDK on the Apify Platform.
82
- To run these tests, you need to set the `APIFY_TEST_USER_API_TOKEN` environment variable to the API token of the Apify user you want to use for the tests,
83
- and then start them with `make integration-tests`.
84
-
85
- If you want to run the integration tests on a different environment than the main Apify Platform,
86
- you need to set the `APIFY_INTEGRATION_TESTS_API_URL` environment variable to the right URL to the Apify API you want to use.
87
-
88
- ### Documentation
89
-
90
- We use the [Google docstring format](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for documenting the code.
91
- We document every user-facing class or method, and enforce that using the flake8-docstrings library.
92
-
93
- The documentation is then rendered from the docstrings in the code using Sphinx and some heavy post-processing and saved as `docs/docs.md`.
94
- To generate the documentation, just run `make docs`.
95
-
96
- ### Release process
97
-
98
- Publishing new versions to [PyPI](https://pypi.org/project/apify) happens automatically through GitHub Actions.
99
-
100
- On each commit to the `master` branch, a new beta release is published, taking the version number from `src/apify/_version.py`
101
- and automatically incrementing the beta version suffix by 1 from the last beta release published to PyPI.
102
-
103
- A stable version is published when a new release is created using GitHub Releases, again taking the version number from `src/apify/_version.py`. The built package assets are automatically uploaded to the GitHub release.
104
-
105
- If there is already a stable version with the same version number as in `src/apify/_version.py` published to PyPI, the publish process fails,
106
- so don't forget to update the version number before releasing a new version.
107
- The release process also fails when the released version is not described in `CHANGELOG.md`,
108
- so don't forget to describe the changes in the new version there.
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes