Merge pull request #8 from aahnik/aahnik-patch-1

Packaging, code quality, testing, CI, contrib guide

Author: chavarera

.github/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing Guide
+
+Its great to see your here!
+
+- You need to first fork and clone the project to start working on it.
+Always work on a new branch, and open a PR to the `main` branch.
+Keep the `main` branch of your fork in sync with the origin.
+If you are a GitHub beginner, and wondering how to do the above stuff,
+then please read [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+- This project uses `poetry` for package management.
+It is very simple and intuitive to use.
+This guide will show you how to setup your project environment.
+If you dont have poetry [install it](https://python-poetry.org/docs/#installation).
+
+- Move into your cloned project directory and run the following commands.
+
+    ```shell
+    poetry config virtualenvs.in-project true
+    poetry install
+    ```
+
+- The virtual environment will be created in a `.venv` folder
+inside your project directory.
+In your code editor set the python interpretor path to `./.venv/bin/python`
+
+- Activate `poetry` shell.
+
+    ```shell
+    poetry shell
+    ```
+
+- Setup pre-commit hooks.
+
+    ```shell
+    pre-commit install
+    ```
+
+- Common commands that you will be running.
+
+    ```shell
+    make fmt # format your code, and sort your imports
+    make clean # delete python cache and other such stuff
+    pre-commit run -a # run pre-commit hooks for all files
+    pre-commit run # run pre-commit hooks only for staged changes
+    poetry show --tree # see the dependency graph for the project
+    pytest # run tests and see the code coverage
+    # after running pytest open htmlcov/index.html to see coverage report
+    ```
+
+To work on this project you must have some knowledge of Selenium.
+An idea about different tools such as pre-commit, tox, black etc will be helpful.
+To know more about something, just google search and go through the official docs.

.github/workflows/quality.yml

@@ -0,0 +1,16 @@
+name: Code Quality
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install poetry && poetry install
+      - uses: pre-commit/action@v2.0.0

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.8','3.9']
+        
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install poetry && poetry install
+      - name: Build python package
+        run: poetry build
+      - name: Run tests
+        run: poetry run pytest
+      - uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          env_vars: OS, PYTHON
+          fail_ci_if_error: false

.gitignore

@@ -1,3 +1,9 @@
+# Configuration for code editors
+.vscode
+
+# All files like t.py, t.ipynb, t.md etc
+t.*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  
+  - repo: https://github.com/pycqa/isort
+    rev: 5.8.0
+    hooks:
+      - id: isort
+        name: isort (python)
+      - id: isort
+        name: isort (cython)
+        types: [cython]
+      - id: isort
+        name: isort (pyi)
+        types: [pyi]
+      
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        language_version: python3 
+        entry: black . --check
+  
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.812
+    hooks:
+      - id: mypy
+    
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.27.1
+    hooks:
+      - id: markdownlint
+        entry: markdownlint --ignore .github

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Python World
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,28 @@
+# lists all available targets
+list:
+	@sh -c "$(MAKE) -p no_targets__ | \
+		awk -F':' '/^[a-zA-Z0-9][^\$$#\/\\t=]*:([^=]|$$)/ {\
+			split(\$$1,A,/ /);for(i in A)print A[i]\
+		}' | grep -v '__\$$' | grep -v 'make\[1\]' | grep -v 'Makefile' | sort"
+
+# required for list
+no_targets__:
+
+
+clean:
+	@rm -rf build dist .eggs *.egg-info
+	@rm -rf .benchmarks .coverage coverage.xml htmlcov report.xml .tox
+	@find . -type d -name '.mypy_cache' -exec rm -rf {} +
+	@find . -type d -name '__pycache__' -exec rm -rf {} +
+	@find . -type d -name '*pytest_cache*' -exec rm -rf {} +
+	@find . -type f -name "*.py[co]" -exec rm -rf {} +
+
+fmt: clean
+	@poetry run isort .
+	@poetry run black .
+
+hard-clean: clean
+	@rm -rf .venv
+
+pypi:
+	@poetry build && poetry publish

README.md

@@ -1,19 +1,19 @@
-# Stool
-
-stool is an wrapper over selenium to perform various task.
+# s-tool
 
+Selenium wrapper to make your life easy.
 
 ## Features
+
 - [X] Manage multiple webdrivers.
 - [X] Click any type of element.
 - [X] Extract Page source.
-- [X] Select different type of elements. 
+- [X] Select different type of elements.
 - [X] Retrive cookies.
 - [X] take fullpage and elementwise screenshots.
 - [X] display and hide elements.
-  
 
 ## TODO
+
 - [ ] Fill information(forms)
 - [ ] horizontal and vertical scrolling
 - [ ] Handeling alerts and popup