Merge pull request #6 from ScrapingAnt/feature/issue4-remove-proxy-country-list

feature/issue4-remove-proxy-country-list

Author: megabotan

.github/workflows/code_checks.yaml

@@ -7,7 +7,6 @@ jobs:
     strategy:
       matrix:
         pyver: [ 3.6, 3.7, 3.8, 3.9 ]
-        no-extensions: [ '', 'Y' ]
         os: [ ubuntu, macos, windows ]
       fail-fast: true
     runs-on: ${{ matrix.os }}-latest

README.md

@@ -1,6 +1,9 @@
 # ScrapingAnt API client for Python
+[![PyPI version](https://badge.fury.io/py/scrapingant-client.svg)](https://badge.fury.io/py/scrapingant-client)
+
 `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.
+Python applications. It  provides useful features like parameters encoding to improve the ScrapingAnt usage experience. 
+Requires python 3.6+.
 
 <!-- toc -->
 
@@ -9,6 +12,7 @@ Python applications. It  provides useful features like parameters encoding to im
 - [API Reference](#api-reference)
 - [Exceptions](#exceptions)
 - [Examples](#examples)
+- [Useful links](#useful-links)
 
 <!-- tocstop -->
 
@@ -28,9 +32,7 @@ In order to get API token you'll need to register at [ScrapingAnt Service](https
 ## API Reference
 All public classes, methods and their parameters can be inspected in this API reference.
 
-<a name="ScrapingAntClient"></a>
-
-#### [](#ScrapingAntClient) ScrapingAntClient(token)
+#### ScrapingAntClient(token)
 
 Main class of this library. 
 
@@ -40,7 +42,7 @@ Main class of this library.
 
 * * *
 
-#### [](#ScrapingAntClient+general_request) `ScrapingAntClient.general_request(url, cookies, js_snippet, proxy_country, return_text)` ⇒ Response
+#### ScrapingAntClient.general_request
 
 https://docs.scrapingant.com/request-response-format#available-parameters
 
@@ -49,14 +51,14 @@ https://docs.scrapingant.com/request-response-format#available-parameters
 | url | <code>string</code> |  |
 | cookies | <code>List[Cookie]</code> | None |
 | js_snippet | <code>string</code> | None |
-| proxy_country | <code>ProxyCountry</code> | None | 
+| proxy_country | <code>str</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.
 
 * * *
 
-#### [](#Cookie) Cookie
+#### Cookie
 Class defining cookie. Curently supports only name and value
 
 | Param | Type | 
@@ -66,21 +68,15 @@ Class defining cookie. Curently supports only name and value
 
 * * *
 
-#### [](#ProxyCountry) ProxyCountry
-
-Enum containing all available proxy countries
-
-* * *
-
-#### [](#Response) Response
-Class defining cookie. Curently supports only name and value
+#### Response
+Class defining response from API. 
 
 | Param | Type |
 | --- | --- |
 | content | <code>string</code> |
 | cookies | <code>List[Cookie]</code> |
 
-## [](#exceptions) Exceptions
+## Exceptions
 
 `ScrapingantClientException` is base Exception class, used for all errors. 
 
@@ -131,4 +127,8 @@ result = client.general_request(
     js_snippet=customJsSnippet,
 )
 print(result.content)
-```
+```
+
+## Useful links
+- [Scrapingant Api doumentation](https://docs.scrapingant.com)
+- [Scrapingant Js Client](https://github.com/scrapingant/scrapingant-client-js)

scrapingant_client/__init__.py

@@ -1,5 +1,4 @@
 from scrapingant_client.client import ScrapingAntClient
-from scrapingant_client.constants import ProxyCountry
 from scrapingant_client.cookie import Cookie
 from scrapingant_client.errors import (
     ScrapingantClientException,
@@ -11,7 +10,6 @@
 
 __all__ = [
     'ScrapingAntClient',
-    'ProxyCountry',
     'Cookie',
     'ScrapingantClientException',
     'ScrapingantInvalidTokenException',

scrapingant_client/client.py

@@ -4,7 +4,7 @@
 
 import requests
 
-from scrapingant_client.constants import ProxyCountry, SCRAPINGANT_API_BASE_URL
+from scrapingant_client.constants import SCRAPINGANT_API_BASE_URL
 from scrapingant_client.cookie import Cookie, cookies_list_to_string, cookies_list_from_string
 from scrapingant_client.errors import (
     ScrapingantInvalidTokenException,
@@ -30,7 +30,7 @@ def general_request(
             url: str,
             cookies: Optional[List[Cookie]] = None,
             js_snippet: Optional[str] = None,
-            proxy_country: Optional[ProxyCountry] = None,
+            proxy_country: Optional[str] = None,
             return_text: bool = False,
     ) -> Response:
         request_data = {'url': url}
@@ -39,7 +39,7 @@ def general_request(
         if js_snippet is not None:
             encoded_js_snippet = base64_encode_string(js_snippet)
             request_data['js_snippet'] = encoded_js_snippet
-        if proxy_country:
+        if proxy_country is not None:
             request_data['proxy_country'] = proxy_country.lower()
         if return_text:
             request_data['return_text'] = True

scrapingant_client/constants.py

@@ -1,22 +1 @@
-from enum import Enum
-
 SCRAPINGANT_API_BASE_URL = 'https://api.scrapingant.com/v1'
-
-
-class ProxyCountry(str, Enum):
-    brasilia = 'br'
-    china = 'cn'
-    germany = 'de'
-    spain = 'es'
-    france = 'fr'
-    the_united_kingdom = 'gb'
-    hong_kong = 'hk'
-    india = 'in'
-    italy = 'it'
-    israel = 'il'
-    japan = 'jp'
-    the_netherlands = 'nl'
-    russia = 'ru'
-    saudi_arabia = 'sa'
-    the_united_arab_emirates = 'ae'
-    usa = 'us'

setup.py

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