eth-portfolio 0.5.6__tar.gz

eth_portfolio-0.5.6/.env.sample

@@ -0,0 +1,3 @@
+PORTFOLIO_ADDRESS_0=
+PORTFOLIO_ADDRESS_1=
+PORTFOLIO_ADDRESS_2=

eth_portfolio-0.5.6/.github/workflows/compile.yaml

@@ -0,0 +1,52 @@
+name: Compile
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - '.github/workflows/**'
+      - '!.github/workflows/compile.yaml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-ubuntu:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          # Check out the PR branch
+          ref: ${{ github.head_ref }}
+        continue-on-error: true
+
+      - name: Branch no longer exists on GitHub
+        if: failure()
+        run: |
+          echo "The branch ${{ github.head_ref }} no longer exists on GitHub"
+          exit 0
+
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Mypycify
+        uses: BobTheBuidler/mypycify@v0.2.6
+        with:
+          python-version: "3.13"
+          hash-key: |
+            pyproject.toml
+            setup.py
+            eth_portfolio/**/*.py
+          pip-cache-dependency-path: |
+            pyproject.toml
+            requirements.txt
+          normalize-source: true
+          push-source: true
+          commit-message: "chore: compile C files for source control"
+          trigger-pr-number: ${{ github.event.pull_request.number }}
+          trigger-branch-name: ${{ github.head_ref || github.ref_name }}

eth_portfolio-0.5.6/.github/workflows/deploy_docs.yaml

@@ -0,0 +1,102 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  id-token: write
+  pages: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-wheel:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.head_ref }}
+        continue-on-error: true
+
+      - name: Branch no longer exists on GitHub
+        if: failure()
+        run: |
+          echo "The branch ${{ github.head_ref }} no longer exists on GitHub"
+          exit 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+
+      - name: Mypycify
+        uses: BobTheBuidler/mypycify@v0.2.6
+        with:
+          python-version: "3.12"
+          hash-key: |
+            pyproject.toml
+            setup.py
+            eth_portfolio/**/*.py
+          pip-cache-dependency-path: |
+            pyproject.toml
+            requirements.txt
+
+  build-and-deploy:
+    needs: build-wheel
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+
+      - name: Download wheel artifact
+        uses: actions/download-artifact@v7
+        with:
+          name: BobTheBuidler_mypycified_wheel-${{ runner.os }}-py3.12-source-${{ hashFiles('pyproject.toml', 'setup.py', 'eth_portfolio/**/*.py') }}-source
+
+      - name: Install dependencies
+        run: pip install $(find . -name '*.whl') sphinx sphinx-rtd-theme
+
+      - name: Build documentation config
+        run: make docs
+
+      - name: Build documentation
+        run: |
+          cd docs
+          BROWNIE_NETWORK_ID=mainnet ETHERSCAN_TOKEN=${{ secrets.ETHERSCAN_TOKEN }} make html
+        continue-on-error: true
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html
+
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          ref: gh-pages
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          # Upload entire repository
+          path: '.'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

eth_portfolio-0.5.6/.github/workflows/lint.yaml

@@ -0,0 +1,27 @@
+name: Lint All The Things
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - '.github/workflows/**'
+      - '!.github/workflows/lint.yaml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint-all-the-things:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Lint All The Things
+        uses: BobTheBuidler/lint-all-the-things@v0.0.3
+        with:
+          python-version: 3.14
+          pyupgrade-target-version: py310

eth_portfolio-0.5.6/.github/workflows/mypy.yaml

@@ -0,0 +1,37 @@
+name: MyPy
+
+on:
+  pull_request:
+    paths:
+      - '**.py'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+  
+jobs:
+  mypy:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        pyversion: [ "3.10", "3.11", "3.12" ]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        persist-credentials: false
+        
+    - name: Setup Python (faster than using Python container)
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.pyversion }}
+
+    - name: Install Dependencies
+      run: pip install -r requirements.txt
+
+    - name: Run MyPy
+      run: make mypy

eth_portfolio-0.5.6/.github/workflows/release.yaml

@@ -0,0 +1,221 @@
+name: Build and Publish Wheels
+
+on:
+  release:
+    branches:
+      - master
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      fake_tag:
+        description: 'Fake tag name to use for dry run (e.g. v2.3.4)'
+        required: true
+
+jobs:
+  build_wheels:
+    name: Build wheels using cibuildwheel
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # ----------------------------------------------------
+          # manylinux 64-bit
+          # ----------------------------------------------------
+          - os: ubuntu-latest
+            build_type: manylinux-x64
+            cibw_build: "*manylinux*"
+            cibw_archs_linux: x86_64
+            artifact_name: "wheels-ubuntu-latest-manylinux-x64"
+
+          # ----------------------------------------------------
+          # manylinux 32-bit
+          # ----------------------------------------------------
+          - os: ubuntu-latest
+            build_type: manylinux-x86
+            cibw_build: "*manylinux*"
+            cibw_archs_linux: i686
+            artifact_name: "wheels-ubuntu-latest-manylinux-x86"
+
+          # ----------------------------------------------------
+          # musllinux 64-bit
+          # ----------------------------------------------------
+          - os: ubuntu-latest
+            build_type: musllinux-x64
+            cibw_build: "*musllinux*"
+            cibw_archs_linux: x86_64
+            artifact_name: "wheels-ubuntu-latest-musllinux-x64"
+
+          # ----------------------------------------------------
+          # macOS (64-bit only)
+          # ----------------------------------------------------
+          - os: macos-latest
+            build_type: macos
+            cibw_build: ""
+            cibw_archs_linux: ""
+            artifact_name: "wheels-macos-latest"
+
+          # ----------------------------------------------------
+          # Windows 64-bit
+          # ----------------------------------------------------
+          - os: windows-latest
+            build_type: winx64
+            cibw_build: ""
+            cibw_archs_windows: AMD64
+            artifact_name: "wheels-windows-latest-x64"
+
+          # ----------------------------------------------------
+          # Windows 32-bit
+          # ----------------------------------------------------
+          - os: windows-latest
+            build_type: winx86
+            cibw_build: ""
+            cibw_archs_windows: x86
+            artifact_name: "wheels-windows-latest-x86"
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      # ----------------------------------------------------
+      # Extract version from git tag or use fake tag for dry run (strip leading 'v')
+      # ----------------------------------------------------
+      - name: Extract version from tag
+        id: get_version
+        shell: bash
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "version=$(echo '${{ github.event.inputs.fake_tag }}' | sed 's/^v//')" >> $GITHUB_OUTPUT
+          else
+            echo "version=${GITHUB_REF_NAME#v}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install cibuildwheel
+        run: |
+          python -m pip install --upgrade pip setuptools wheel cibuildwheel mypy[mypyc]
+
+      - name: Build wheels
+        env:
+          # Skip PyPy
+          CIBW_SKIP: pp*
+          # On Linux: manylinux / musllinux arches
+          CIBW_ARCHS_LINUX: ${{ matrix.cibw_archs_linux || '' }}
+          # On Windows: AMD64 / x86
+          CIBW_ARCHS_WINDOWS: ${{ matrix.cibw_archs_windows || '' }}
+          # Which wheels to build for Linux (manylinux vs. musllinux)
+          CIBW_BUILD: ${{ matrix.cibw_build || '' }}
+          # Use version from git tag (stripped 'v')
+          SETUPTOOLS_SCM_PRETEND_VERSION: ${{ steps.get_version.outputs.version }}
+          # Pass version into Docker for Linux builds
+          CIBW_ENVIRONMENT: "SETUPTOOLS_SCM_PRETEND_VERSION=${{ steps.get_version.outputs.version }}"
+        run: |
+          python -m cibuildwheel --output-dir wheelhouse
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: ${{ matrix.artifact_name }}
+          path: wheelhouse/*.whl
+
+  publish_sdist_and_wheels:
+    name: Publish wheels to PyPI
+    needs: build_wheels
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      # ----------------------------------------------------
+      # Extract version from git tag or use fake tag for dry run (strip leading 'v')
+      # ----------------------------------------------------
+      - name: Extract version from tag
+        id: get_version
+        shell: bash
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "version=$(echo '${{ github.event.inputs.fake_tag }}' | sed 's/^v//')" >> $GITHUB_OUTPUT
+          else
+            echo "version=${GITHUB_REF_NAME#v}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine mypy[mypyc] types-aiofiles
+
+      - name: Build sdist
+        env:
+          # Use version from git tag (stripped 'v')
+          SETUPTOOLS_SCM_PRETEND_VERSION: ${{ steps.get_version.outputs.version }}
+        run: python setup.py sdist
+
+      # ----------------------------------------------------
+      # Download wheels built on each runner
+      # ----------------------------------------------------
+      - name: Download manylinux 64-bit wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-ubuntu-latest-manylinux-x64"
+          path: wheelhouse/linux-many-x64
+
+      - name: Download manylinux 32-bit wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-ubuntu-latest-manylinux-x86"
+          path: wheelhouse/linux-many-x86
+
+      - name: Download musllinux 64-bit wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-ubuntu-latest-musllinux-x64"
+          path: wheelhouse/linux-musl-x64
+
+      - name: Download macOS wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-macos-latest"
+          path: wheelhouse/macos
+
+      - name: Download Windows 64-bit wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-windows-latest-x64"
+          path: wheelhouse/windows-x64
+
+      - name: Download Windows 32-bit wheels
+        uses: actions/download-artifact@v7
+        with:
+          name: "wheels-windows-latest-x86"
+          path: wheelhouse/windows-x86
+
+      # ----------------------------------------------------
+      # Publish sdist and wheels to PyPI
+      # ----------------------------------------------------
+      - name: Publish sdist and wheels to PyPI
+        if: ${{ github.event_name != 'workflow_dispatch' }}
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          twine upload \
+            dist/* \
+            wheelhouse/linux-many-x64/*.whl \
+            wheelhouse/linux-many-x86/*.whl \
+            wheelhouse/linux-musl-x64/*.whl \
+            wheelhouse/macos/*.whl \
+            wheelhouse/windows-x64/*.whl \
+            wheelhouse/windows-x86/*.whl

eth_portfolio-0.5.6/.gitignore

@@ -0,0 +1,19 @@
+cache/
+env/
+.env
+.mypy_cache/
+.hypothesis
+.pytest_cache
+__pycache__/
+eth_portfolio.egg-info/
+build/**/*.py
+build/**/*.json
+build/**/*.md
+build/**/*.typed
+build/**/*.yaml
+build/**/*.yml
+build/ops.txt
+**.o
+**.so
+**.whl
+eth_portfolio_temp.egg-info/

eth_portfolio-0.5.6/Makefile

@@ -0,0 +1,11 @@
+
+.PHONY: docs
+
+docs:
+	rm -r ./docs/source -f
+	rm -r ./docs/_templates -f
+	rm -r ./docs/_build -f
+	sphinx-apidoc -o ./docs/source ./eth_portfolio
+
+test-exporter:
+	eth-portfolio export balances --wallet 0xFEB4acf3df3cDEA7399794D0869ef76A6EfAff52 --network tenderly

eth_portfolio-0.5.6/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: eth_portfolio
+Version: 0.5.6
+Summary: eth-portfolio makes it easy to analyze your portfolio.
+Home-page: https://github.com/BobTheBuidler/eth-portfolio
+Author: BobTheBuidler
+Author-email: bobthebuidlerdefi@gmail.com
+Requires-Python: >=3.10,<3.14
+Requires-Dist: checksum_dict>=2.1.7
+Requires-Dist: dank_mids>=4.20.192
+Requires-Dist: eth-brownie<1.23,>=1.22.0.dev0
+Requires-Dist: eth_retry<1,>=0.3.4
+Requires-Dist: evmspec>=0.4.1
+Requires-Dist: ez-a-sync>=0.33.10
+Requires-Dist: faster-async-lru==2.0.5.2
+Requires-Dist: faster-eth-utils
+Requires-Dist: numpy<3
+Requires-Dist: pandas<3,>=1.4.3
+Requires-Dist: typed-envs>=0.2.3
+Requires-Dist: ypricemagic<5.2,>=5.1.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

eth_portfolio-0.5.6/README.md

@@ -0,0 +1,138 @@
+# eth-portfolio
+Use `eth-portfolio` to output information about your portfolio in a streamlined, speed-optimized way.
+
+### Requirements
+- Python 3.10 or higher.
+- At least 16GB of RAM, 32GB for Base chain.
+
+### Prerequisites
+- First, you will need to bring your own archive node. This can be one you run yourself, or one from one of the common providers (Tenderly, Alchemy, QuickNode, etc.)
+- You must configure a [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) to use your RPC.
+- You will also need an auth token for [Etherscan](https://etherscan.io/)'s API. Follow their [guide](https://docs.etherscan.io/etherscan-v2/getting-an-api-key) to get your key, and set env var `ETHERSCAN_TOKEN` with its value.
+
+### Installation:
+- Make sure you are using Python >= 3.9 and < 3.13. You should start with a fresh virtual environment, and then just...
+```
+pip install git+https://github.com/BobTheBuidler/eth-portfolio
+```
+
+### Usage:
+For basic use, input each of your addresses as environment variables using the following pattern:
+```
+PORTFOLIO_ADDRESS_0=0x123...
+PORTFOLIO_ADDRESS_1=0x234...
+PORTFOLIO_ADDRESS_2=0x345...
+```
+
+Then do...
+```
+from eth_portfolio import portfolio
+portfolio.eth_balance(block)
+
+>>> {
+        0xaddress0: _BalanceItem(balance=1234, usd_value=5678)
+        0xaddress1: _BalanceItem(balance=1234, usd_value=5678)
+        0xaddress2: _BalanceItem(balance=1234, usd_value=5678)
+    }
+```
+
+Getting token transfers:
+```
+from eth_portfolio import portfolio
+token_transfers = portfolio.token_transfers.get(start_block, end_block)
+token_transfers.df()
+
+>>> {
+        0xaddress0: AddressTokenTransfersLedger(...)  # Each of these contains the token transfers for the specified address
+        0xaddress1: AddressTokenTransfersLedger(...)
+        0xaddress2: AddressTokenTransfersLedger(...)
+    }
+```
+
+Getting transactions as a DataFrame:
+```
+from eth_portfolio import portfolio
+txs = portfolio.transactions.get(start_block, end_block)
+txs.df()
+
+>>> [I am a pretend DataFrame]
+```
+
+Getting assets:
+```
+from eth_portfolio import portfolio
+portfolio.describe(start_block, end_block)
+
+>>>  {
+        'assets': {
+            'wallet0_address': {
+                'token0': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+                'token1': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+            },
+            'wallet0_address': {
+                'token0': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+                'token1': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+            },
+        },
+        'debt': {
+            'wallet0_address': {
+                'token0': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+                'token1': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+            },
+            'wallet1_address': {
+                'token0': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+                'token1': {
+                    'amount': 123,
+                    'value usd: 456,
+                },
+            },
+        },
+    }
+```
+
+Getting net worth:
+```
+from eth_portfolio import portfolio
+desc = portfolio.describe(block)
+assets = desc['assets']     # OR you can do `assets = portfolio.assets(block)`
+debt = desc['debt']         # OR you can do `debt = portfolio.debt(block)`
+assets = sum(assets.values())
+debt = sum(debt.values())
+net = assets - debt
+net.sum_usd()
+
+>>> Decimal("123456.78900")
+```
+
+### Advanced:
+You also have more granular control available using the Portfolio object:
+```
+from eth_portfolio import Portfolio
+port = Portfolio([0xaddress0, 0xaddress1, 0xaddress2])
+port.describe(chain.height)
+
+# Or for async code
+async_port = Portfolio([0xaddress0, 0xaddress1, 0xaddress2], asynchronous=True)
+await port.describe(chain.height)
+```

eth_portfolio-0.5.6/brownie-config.yaml

@@ -0,0 +1 @@
+autofetch_sources: true

eth_portfolio-0.5.6/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)