Merge pull request #11 from ForceFledgling/dev

add: workflow for automated tests

.github/workflows/autotests.yml

@@ -0,0 +1,66 @@
+name: Run Tests
+
+on: [push, pull_request]
+
+jobs:
+  test-linux:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install poetry
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+
+    - name: Install dependencies
+      run: |
+        poetry install
+
+    - name: Run tests
+      run: |
+        poetry run pytest tests/
+
+  test-windows:
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+        architecture: x64
+
+    - name: Install poetry
+      run: |
+        python -m pip install --upgrade pip
+        pip install poetry
+
+    - name: Install dependencies
+      run: |
+        poetry env use python ${matrix.python-version}
+        poetry install
+
+    - name: Run tests
+      run: |
+        poetry run pytest tests/

README.md

@@ -4,7 +4,7 @@
 ProxyHub
 ===========
 
-![logo](docs/img/logo_transparent.png)
+![logo](https://github.com/ForceFledgling/proxyhub/blob/main/docs/img/logo_transparent.png)
 
 ProxyHub is an open source tool that asynchronously finds public proxies from multiple sources and concurrently checks them.
 
@@ -95,8 +95,6 @@ Find and show 10 HTTP(S) proxies from United States with the high level of anony
 $ proxyhub find --types HTTP HTTPS --lvl High --countries US --strict -l 10
 ```
 
-![image](https://raw.githubusercontent.com/constverum/proxyhub/master/docs/source/_static/cli_find_example.gif)
-
 #### Grab
 
 Find and save to a file 10 US proxies (without a check):
@@ -105,8 +103,6 @@ Find and save to a file 10 US proxies (without a check):
 $ proxyhub grab --countries US --limit 10 --outfile ./proxies.txt
 ```
 
-![image](https://raw.githubusercontent.com/constverum/proxyhub/master/docs/source/_static/cli_grab_example.gif)
-
 #### Serve
 
 Run a local proxy server that distributes incoming requests to a pool of found HTTP(S) proxies with the high level of anonymity:
@@ -115,8 +111,6 @@ Run a local proxy server that distributes incoming requests to a pool of found H
 $ proxyhub serve --host 127.0.0.1 --port 8888 --types HTTP HTTPS --lvl High --min-queue 5
 ```
 
-![image](https://raw.githubusercontent.com/constverum/proxyhub/master/docs/source/_static/cli_serve_example.gif)
-
 Run `proxyhub --help` for more information on the options available.
 Run `proxyhub <command> --help` for more information on a command.
 

proxyhub/__init__.py

@@ -16,7 +16,7 @@
 
 __title__ = 'proxyhub'
 __package__ = 'proxyhub'
-__version__ = '0.0.1a2'
+__version__ = '0.0.1a5'
 __short_description__ = 'An advanced [Finder | Checker | Server] tool for proxy servers, supporting both HTTP(S) and SOCKS protocols.'
 __author__ = 'ForceFledgling'
 __author_email__ = 'pvenv@icloud.com'

pyproject.toml

@@ -1,7 +1,7 @@
 
 [tool.poetry]
 name = "proxyhub"
-version = "0.0.1-alpha2"
+version = "0.0.1-alpha5"
 description = "An advanced [Finder | Checker | Server] tool for proxy servers, supporting both HTTP(S) and SOCKS protocols."
 authors = ["ForceFledgling - Din Grogu <pvenv@icloud.com>"]
 repository = "https://github.com/ForceFledgling/proxyhub"

setup.py

@@ -8,9 +8,9 @@
 with codecs.open('proxyhub/__init__.py', mode='r', encoding='utf-8') as f:
     INFO = dict(re.findall(r"__(\w+)__ = '([^']+)'", f.read(), re.MULTILINE))
 
-# with codecs.open('README.md', mode='r', encoding='utf-8') as f:
-#     INFO['long_description'] = f.read()
-INFO['long_description'] = 'ProxyHub is an open source tool that asynchronously finds public proxies from multiple sources and concurrently checks them.'
+with codecs.open('README.md', mode='r', encoding='utf-8') as f:
+    INFO['long_description'] = f.read()
+# INFO['long_description'] = 'ProxyHub is an open source tool that asynchronously finds public proxies from multiple sources and concurrently checks them.'
 
 REQUIRES = [
     'aiohttp>=3.5.4',
@@ -39,6 +39,7 @@
     version=INFO['version'],
     description=INFO['short_description'],
     long_description=INFO['long_description'],
+    long_description_content_type='text/markdown',
     author=INFO['author'],
     author_email=INFO['author_email'],
     license=INFO['license'],