Merge pull request #223 from Davi0kProgramsThings/master

Merge branch `Davi0kProgramsThings:master` into branch `bitfinexcom:master`.

Author: vigan-abd

.github/ISSUE_TEMPLATE

@@ -0,0 +1,35 @@
+## I'm submitting a...
+
+- [ ] bug report;
+- [ ] feature request;
+- [ ] documentation change;
+
+## What is the expected behaviour?
+<!--- Describe the expected behaviour in details -->
+
+## What is the current behaviour?
+<!--- Describe the current behaviour in details -->
+
+## Possible solution (optional)
+<!-- If you have a solution proposal, please explain it here -->
+<!-- If your solution includes implementation, you should also open a PR with this as related issue -->
+<!-- You can delete this section if you don't want to suggest a possible solution -->
+
+A possible solution could be...
+
+## Steps to reproduce (for bugs)
+<!-- You can delete this section if you are not submitting a bug report -->
+
+1. &nbsp;
+2. &nbsp;
+3. &nbsp;
+
+### Python version
+<!-- Indicate your python version here -->
+<!-- You can print it using `python3 --version`-->
+Python 3.10.6 x64
+
+### Mypy version
+<!-- Indicate your mypy version here -->
+<!-- You can print it using `python3 -m mypy --version`-->
+mypy 0.991 (compiled: yes)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+# Description
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## Related Issue
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+PR fixes the following issue: 
+
+## Type of change
+<!-- Select the most suitable choice and remove the others from the checklist -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue);
+- [ ] New feature (non-breaking change which adds functionality);
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected);
+- [ ] This change requires a documentation update;
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project;
+- [ ] I have performed a self-review of my code;
+- [ ] I have commented my code, particularly in hard-to-understand areas;
+- [ ] I have made corresponding changes to the documentation;
+- [ ] My changes generate no new warnings;
+- [ ] I have added tests that prove my fix is effective or that my feature works;
+- [ ] New and existing unit tests pass locally with my changes;
+- [ ] Mypy returns no errors or warnings when run on the root package;
+- [ ] Pylint returns a score of 10.00/10.00 when run on the root package;
+- [ ] I have updated the library version and updated the CHANGELOG;

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,31 @@
+name: bitfinex-api-py-ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps: 
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+      - name: Install bitfinex-api-py's dependencies
+        run: python -m pip install -r dev-requirements.txt
+      - name: Lint the project with pylint (and fail if score is lower than 10.00/10.00)
+        run: python -m pylint bfxapi
+      - name: Run mypy to check the correctness of type hinting (and fail if any error or warning is found)
+        run: python -m mypy bfxapi
+      - name: Execute project's unit tests (unittest)
+        run: python -m unittest bfxapi.tests

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,12 @@
-__pycache__
-*.pyc
-.vscode
-*.log
-dist
-bitfinex_api_py.egg-info
+.vscode
+*.pyc
+*.log
+
+bitfinex_api_py.egg-info
+
+__pycache__
+
+dist
+venv
+!.gitkeep
+MANIFEST

.github/workflows/bitfinex-api-py-ci.yml

@@ -0,0 +1,33 @@
+[MAIN]
+py-version=3.8.0
+
+[MESSAGES CONTROL]
+disable=
+    multiple-imports,
+    missing-docstring,
+    logging-not-lazy,
+    logging-fstring-interpolation,
+    too-few-public-methods,
+    too-many-public-methods,
+    too-many-instance-attributes,
+    dangerous-default-value,
+    inconsistent-return-statements,
+
+[SIMILARITIES]
+min-similarity-lines=6
+
+[VARIABLES]
+allowed-redefined-builtins=type,dir,id,all,format,len
+
+[FORMAT]
+max-line-length=120
+expected-line-ending-format=LF
+
+[BASIC]
+good-names=id,on,pl,t,ip,tf,A,B,C,D,E,F
+
+[TYPECHECK]
+generated-members=websockets
+
+[STRING]
+check-quote-consistency=yes

.github/workflows/python-app.yml

@@ -1,8 +1,11 @@
 language: python
 python:
-  - "3.8.2"
+  - "3.8.0"
+before_install:
+  - python -m pip install --upgrade pip
 install:
-  - python3.8 -m pip install -r requirements.txt
+  - pip install -r dev-requirements.txt
 script:
-  - pylint --rcfile=pylint.rc bfxapi
-  - pytest
+  - python -m pylint bfxapi
+  - python -m mypy bfxapi
+  - python -m unittest bfxapi.tests