feat: poetry (#182)

* poetry checkpoint

* use .env file

* tox example

* adding coverage and pytest qol

* chore: update pyproject.toml

* chore: bump ez-a-sync to needed version

* adding asyncio

* updating lockfile

* release workflow setup with poetry

* updating mypy actions

* updating pytest.yaml w/ poetry

* docs workflow updated with poetry

* dev comment

* chore: use matrix for mypy action

* local load env check

* brownie should be accessed correctly now

---------

Co-authored-by: BobTheBuidler <[email protected]>

.env.sample

@@ -0,0 +1,4 @@
+# Fill this out when developing locally
+PYTEST_NETWORK=
+ETHERSCAN_TOKEN=
+WEB3_INFURA_PROJECT_ID=

.github/workflows/deploy-docs.yaml

@@ -20,28 +20,34 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4.1.4
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Install Dependencies
+        run: |
+          poetry install --no-interaction
+
       - name: Install dependencies
+        # pip will install despite the conflicts, poetry will prevent it
         run: |
-          pip install wheel
-          pip install --no-build-isolation "Cython<3" "pyyaml==5.4.1"
-          pip install -r requirements.txt -r requirements-dev.txt
-          pip install sphinx sphinx-rtd-theme
+          poetry run pip install wheel
+          poetry run pip install --no-build-isolation "Cython<3" "pyyaml==5.4.1"
+          poetry run pip install sphinx sphinx-rtd-theme
 
       - name: Setup brownie networks
         run: |
-          brownie networks modify mainnet host=${{ secrets.ALCHEMY_PROVIDER }}
+          poetry run brownie networks modify mainnet host=${{ secrets.ALCHEMY_PROVIDER }}
         continue-on-error: true
 
       - name: Build documentation config
         run: |
-          pip install .
           make docs
 
       - name: Build documentation

.github/workflows/mypy.yaml

@@ -8,17 +8,23 @@ concurrency:
 
 jobs:
   mypy:
-    runs-on: ubuntu-20.04
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        pyversion: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
 
     steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
 
     - name: Setup Python (faster than using Python container)
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.9"
+        python-version: ${{ matrix.pyversion }}
 
     - name: Install MyPy
       run: |

.github/workflows/pytest.yaml

@@ -36,25 +36,28 @@ jobs:
 
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4.1.4
 
       - name: Setup Python (faster than using Python container)
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.pyversion }}
 
-      - name: Install dependencies
-        run: |
-          pip install -r requirements.txt -r requirements-dev.txt
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Install Dependencies
+        run: poetry install --no-interaction
 
       - name: Setup brownie networks
         run: |
-          brownie networks modify mainnet host=${{ secrets[matrix.provider] }}
+          poetry run brownie networks modify mainnet host=${{ secrets[matrix.provider] }}
         continue-on-error: true
 
       - name: Run test suite
         env:
           PYTEST_NETWORK: mainnet
           ETHERSCAN_TOKEN: ${{ secrets.ETHERSCAN_TOKEN  }}
-        run: pytest --asyncio-task-timeout=3600
+        run: |
+          poetry run pytest --asyncio-task-timeout=3600
       

.github/workflows/release.yaml

@@ -14,18 +14,27 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/[email protected]
       with:
         fetch-depth: 0
-    - uses: actions/setup-python@v2
-    - 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_PASSWORD }}
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.9"
+
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+
+    - name: Install Dependencies
+      run: poetry install --no-interaction
+
+    - name: Run Tests
+      run: poetry run pytest
+
+    - name: Build and Publish
       run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        poetry config pypi-token.pypi ${{ secrets.PYPI_PASSWORD }}
+        poetry publish --build --no-interaction
+

.gitignore

@@ -6,4 +6,7 @@ dank_mids.egg-info
 .pytest_cache
 .eggs
 .mypy_cache
-__pycache__
+__pycache__
+.env
+.tox/
+.python-version

Makefile

@@ -7,4 +7,4 @@ docs:
 	rm -r ./docs/source -f
 	rm -r ./docs/_templates -f
 	rm -r ./docs/_build -f
-	sphinx-apidoc -o ./docs/source ./dank_mids
+	poetry run sphinx-apidoc -o ./docs/source ./dank_mids