Merge pull request #253 from InjectiveLabs/feat/release_v09

Feat/release v09

Author: aarmoa

.github/workflows/pre-commit.yml

@@ -0,0 +1,32 @@
+name: pre-commit
+on:
+  pull_request:
+  push:
+    branches: [master, dev]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Python
+        uses: actions/setup-python@v4
+
+      - name: Install poetry
+        run: python -m pip install poetry
+      - name: Cache the virtualenv
+        id: cache-venv
+        uses: actions/cache@v3
+        with:
+          path: ./.venv
+          key: ${{ runner.os }}-venv-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cache-venv.outputs.cache-hit != 'true'
+        run: python -m poetry install
+
+      - name: Run pre-commit
+        run: |
+          python -m poetry run pre-commit run --show-diff-on-failure --color=always --all-files
+        shell: bash

.github/workflows/release.yml

@@ -2,26 +2,22 @@ name: Publish Python 🐍 distribution 📦 to PyPI
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@master
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload --skip-existing dist/*
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Python
+        uses: actions/setup-python@v3
+      - name: Install poetry
+        run: python -m pip install poetry
+      - name: Publish package
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish --build

.github/workflows/run-tests.yml

@@ -0,0 +1,45 @@
+name: run-tests
+on:
+  pull_request:
+  push:
+    branches: [master, dev]
+
+jobs:
+  run-tests:
+    strategy:
+      matrix:
+        python: ["3.9", "3.10", "3.11"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install poetry
+        run: python -m pip install poetry
+      - name: Cache the virtualenv
+        id: cache-venv
+        uses: actions/cache@v3
+        with:
+          path: ./.venv
+          key: ${{ runner.os }}-${{ matrix.python }}-venv-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cache-venv.outputs.cache-hit != 'true'
+        run: python -m poetry install
+
+      - name: Run tests and Generate coverage
+        run: |
+          poetry run pytest --cov --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          env_vars: OS,PYTHON

.gitignore

@@ -143,3 +143,5 @@ cython_debug/
 
 .chain_cookie
 .exchange_cookie
+
+.flakeheaven_cache

.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+exclude: '^pyinjective/proto/.*'
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+-   repo: https://github.com/flakeheaven/flakeheaven
+    rev: 3.3.0
+    hooks:
+    -   id: flakeheaven
+        name: flakeheaven
+        description: '`flakeheaven` is a `flake8` wrapper.'
+        entry: flakeheaven lint
+        language: python
+        types_or: [ python, jupyter, markdown, rst, yaml ]
+        require_serial: true
+        minimum_pre_commit_version: 2.9.0
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        name: isort (python)
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.9.1
+    hooks:
+      - id: black

LICENSE.md

@@ -200,4 +200,4 @@ Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

Makefile

@@ -35,6 +35,6 @@ copy-proto:
   done
 
 tests:
-	pytest -v
+	poetry run pytest -v
 
 .PHONY: all gen gen-client copy-proto tests

NOTICE.md

@@ -5,4 +5,4 @@ Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
 Originally released by Injective Labs Inc. under: <br />
 Apache License <br />
 Version 2.0, January 2004 <br />
-http://www.apache.org/licenses/ 
+http://www.apache.org/licenses/

README.md

@@ -1,5 +1,7 @@
 ## Injective Python SDK
 
+[![codecov](https://codecov.io/gh/InjectiveLabs/sdk-python/graph/badge.svg?token=RBGK98G6F1)](https://codecov.io/gh/InjectiveLabs/sdk-python)
+
 ### Dependencies
 
 **Ubuntu**
@@ -24,20 +26,20 @@ pip install injective-py
 ```
 
 ### Usage
-Requires Python 3.7+
+Requires Python 3.9+
+Please install `poetry` following the steps described in the [documentation](https://python-poetry.org/docs/#installation)
 
 [Examples](https://github.com/InjectiveLabs/sdk-python/tree/master/examples)
 ```bash
-$ pipenv shell
-$ pipenv install
+$ poetry install
 
 # connecting to Injective Exchange API
 # and listening for new orders from a specific spot market
-$ python examples/exchange_client/spot_exchange_rpc/8_StreamOrders.py
+$ poetry run python examples/exchange_client/spot_exchange_rpc/8_StreamOrders.py
 
 # sending a msg with bank transfer
 # signs and posts a transaction to the Injective Chain
-$ python examples/chain_client/1_MsgSend.py
+$ poetry run python examples/chain_client/1_MsgSend.py
 ```
 Upgrade `pip` to the latest version, if you see these warnings:
   ```
@@ -49,16 +51,10 @@ Upgrade `pip` to the latest version, if you see these warnings:
 1. Generate proto binding & build
   ```
   make gen
-  python -m build
+  poetry build
   ```
 
-2. Enable dev env
-  ```
-  pipenv shell
-  pipenv install --dev
-  ```
-
-3. Install pkg
+2. Install pkg
   ```
   # from local build
   pip uninstall injective-py
@@ -69,24 +65,25 @@ Upgrade `pip` to the latest version, if you see these warnings:
   pip install injective-py
   ```
 
-4. Fetch latest denom config
+3. Fetch latest denom config
 ```
-python pyinjective/fetch_metadata.py
+poetry run python pyinjective/fetch_metadata.py
 ```
 
 Note that the [sync client](https://github.com/InjectiveLabs/sdk-python/blob/master/pyinjective/client.py) has been deprecated as of April 18, 2022. If you are using the sync client please make sure to transition to the [async client](https://github.com/InjectiveLabs/sdk-python/blob/master/pyinjective/async_client.py), for more information read [here](https://github.com/InjectiveLabs/sdk-python/issues/101)
 
-5. Install the development environment (requires `pipenv`)
+4. Run all unit tests in a development environment
 ```
-pipenv install -d
-```
-
-6. Run all unit tests in a development environment
-```
-make tests
+poetry run pytest -v
 ```
 
 ### Changelogs
+**0.9.0**
+* Improvement in broadcaster to initialize the account sequence number and the timeout height only when required
+* Replace Pipenv with Poetry
+* Add pre-commit validations to the project
+* Add a GitHub workflow to run all tests and calculate coverage for each PR
+
 **0.8.5**
 * Added NEOK/USDT and ORAI/USDT spot markets to the mainnet .ini file
 
@@ -264,5 +261,4 @@ Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
 Originally released by Injective Labs Inc. under: <br />
 Apache License <br />
 Version 2.0, January 2004 <br />
-http://www.apache.org/licenses/ 
-
+http://www.apache.org/licenses/