master: first release

Author: megabotan

.github/workflows/publish.yaml

@@ -30,5 +30,4 @@ jobs:
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@master
         with:
-          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-          repository_url: https://test.pypi.org/legacy/
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -3,4 +3,4 @@ dist
 .DS_Store
 poetry.lock
 */__pycache__/
-*.egg-info/
+*.egg-info/

README.md

@@ -6,15 +6,14 @@ Python applications. It  provides useful features like parameters encoding to im
 
 - [Quick Start](#quick-start)
 - [API key](#api-key)
-- [Retries with exponential backoff](#retries-with-exponential-backoff)
 - [API Reference](#api-reference)
 - [Examples](#examples)
 
 <!-- tocstop -->
 
 ## Quick Start
 ```python3
-from scrapingant_client.client import ScrapingAntClient
+from scrapingant_client import ScrapingAntClient
 
 client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
 # Scrape the example.com site.
@@ -35,35 +34,58 @@ All public classes, methods and their parameters can be inspected in this API re
 
 | Param | Type | Default |
 | --- | --- | --- |
-| [token] | <code>string</code> |  |
-
+| token | <code>string</code> |  |
 
 
 * * *
 
 <a name="ScrapingAntClient+scrape"></a>
 
-#### [](#ScrapingAntClient+scrape) `ScrapingAntClient.general_request(url, cookies, js_snippet, proxy_country, return_text)` ⇒ [<code>ScrapingAnt API response</code>](https://docs.scrapingant.com/request-response-format#response-structure)
+### [](#ScrapingAntClient+scrape) `ScrapingAntClient.general_request(url, cookies, js_snippet, proxy_country, return_text)` ⇒ Response
 
 https://docs.scrapingant.com/request-response-format#available-parameters
 
 | Param | Type | Default |
 | --- | --- | --- |
 | url | <code>string</code> |  |
-| cookies | <code>string</code> | None |
+| cookies | <code>List[Cookie]</code> | None |
 | js_snippet | <code>string</code> | None |
-| proxy_country | <code>string</code> | None | 
+| proxy_country | <code>ProxyCountry</code> | None | 
 | return_text | <code>boolean</code> | False |
 
 **IMPORTANT NOTE:** <code>js_snippet</code> will be encoded to Base64 automatically by the ScrapingAnt client library.
 
 * * *
 
-<a name="ScrapingAntApiError"></a>
+### [](#Cookie) Cookie
+Class defining cookie. Curently supports only name and value
+
+| Param | Type | 
+| --- | --- |
+| name | <code>string</code> | 
+| value | <code>string</code> |
+
+* * *
+
+### [](#ProxyCountry) ProxyCountry
+
+Enum containing all available proxy countries
+
+* * *
+
+### [](#Response) Response
+Class defining cookie. Curently supports only name and value
+
+| Param | Type |
+| --- | --- |
+| content | <code>string</code> |
+| cookies | <code>List[Cookie]</code> |
+
+* * *
 
 ### [](#ScrapingantClientException) ScrapingantClientException
 
-`ScrapingantClientException` is base Exception class, used for all errors
+`ScrapingantClientException` is base Exception class, used for all errors.
 
 * * *
 
@@ -72,8 +94,8 @@ https://docs.scrapingant.com/request-response-format#available-parameters
 ### Sending custom cookies
 
 ```python3
-from scrapingant_client.client import ScrapingAntClient
-from scrapingant_client.cookie import Cookie
+from scrapingant_client import ScrapingAntClient
+from scrapingant_client import Cookie
 
 client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
 
@@ -93,7 +115,7 @@ response_cookies = result.cookies
 ### Executing custom JS snippet
 
 ```python
-from scrapingant_client.client import ScrapingAntClient
+from scrapingant_client import ScrapingAntClient
 client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
 
 customJsSnippet = """

scrapingant_client/__init__.py

@@ -1 +1,5 @@
-__version__ = '0.1.0'
+from client import ScrapingAntClient
+from constants import ProxyCountry
+from cookie import Cookie
+from errors import ScrapingantClientException
+from response import Response

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="scrapingant-client",
-    version="0.1.1",
+    version="0.1.0",
     author="andrii.kovalenko",
     author_email="[email protected]",
     license='Apache-2.0',