master: setting up tests, readme

Author: megabotan

.github/workflows/code_checks.yaml

@@ -0,0 +1,20 @@
+name: Code checks
+
+on: push
+
+jobs:
+  code_checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Init
+        run: make init
+      - name: Lint
+        run: make lint
+      - name: Tests
+        run: make test

.gitignore

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

Makefile

@@ -1,11 +1,9 @@
 init:
-	poetry update
+	pip3 install -e .[dev]
+
 test:
-	poetry run pytest -p no:cacheprovider
+	pytest -p no:cacheprovider
 
-flake8:
-	poetry run flake8 --max-line-length=120 scrapingant_client_python tests
+lint:
+	flake8 --max-line-length=120 scrapingant_client tests
 
-publish:
-	poetry build
-	poetry publish

README.md

@@ -1 +1,109 @@
 # ScrapingAnt API client for Python
+`scrapingant-client` is the official library to access [ScrapingAnt API](https://docs.scrapingant.com) from your
+Python applications. It  provides useful features like parameters encoding to improve the ScrapingAnt usage experience.
+
+<!-- toc -->
+
+- [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
+
+client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
+# Scrape the example.com site.
+result = client.general_request('https://example.com')
+print(result.content)
+```
+
+## API key
+In order to get API key you'll need to register at [ScrapingAnt Service](https://app.scrapingant.com)
+
+## API Reference
+All public classes, methods and their parameters can be inspected in this API reference.
+
+<a name="ScrapingAntClient"></a>
+
+#### [](#ScrapingAntClient) `ScrapingAntClient(token)`
+
+
+| Param | Type | Default |
+| --- | --- | --- |
+| [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)
+
+https://docs.scrapingant.com/request-response-format#available-parameters
+
+| Param | Type | Default |
+| --- | --- | --- |
+| url | <code>string</code> |  |
+| cookies | <code>string</code> | None |
+| js_snippet | <code>string</code> | None |
+| proxy_country | <code>string</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>
+
+### [](#ScrapingantClientException) ScrapingantClientException
+
+`ScrapingantClientException` is base Exception class, used for all errors
+
+* * *
+
+## Examples
+
+### Sending custom cookies
+
+```python3
+from scrapingant_client.client import ScrapingAntClient
+from scrapingant_client.cookie import Cookie
+
+client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
+
+result = client.general_request(
+    'https://httpbin.org/cookies', 
+    cookies=[
+        Cookie(name='cookieName1', value='cookieVal1'),
+        Cookie(name='cookieName2', value='cookieVal2'),
+    ]
+)
+print(result.content)
+# Response cookies is a list of Cookie objects
+# They can be used in next requests
+response_cookies = result.cookies 
+```
+
+### Executing custom JS snippet
+
+```python
+from scrapingant_client.client import ScrapingAntClient
+client = ScrapingAntClient(token='<YOUR-SCRAPINGANT-API-TOKEN>')
+
+customJsSnippet = """
+var str = 'Hello, world!';
+var htmlElement = document.getElementsByTagName('html')[0];
+htmlElement.innerHTML = str;
+"""
+result = client.general_request(
+    'https://example.com', 
+    js_snippet=customJsSnippet,
+)
+print(result.content)
+```

scrapingant_client_python/__init__.py renamed to scrapingant_client/__init__.py

@@ -4,10 +4,10 @@
 
 import requests
 
-from src.constants import ProxyCountry
-from src.cookie import Cookie, cookies_list_to_string, cookies_list_from_string
-from src.response import Response
-from src.utils import base64_encode_string
+from scrapingant_client.constants import ProxyCountry
+from scrapingant_client.cookie import Cookie, cookies_list_to_string, cookies_list_from_string
+from scrapingant_client.response import Response
+from scrapingant_client.utils import base64_encode_string
 
 
 class ScrapingAntClient:

scrapingant_client_python/client.py renamed to scrapingant_client/client.py

@@ -1,6 +1,6 @@
 from typing import List
 
-from src.cookie import Cookie
+from scrapingant_client.cookie import Cookie
 
 
 class Response: