eth-portfolio 1.1.0__py3-none-any.whl

eth_portfolio-1.1.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.2
+Name: eth-portfolio
+Version: 1.1.0
+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
+Project-URL: Homepage, https://github.com/BobTheBuidler/eth-portfolio
+Project-URL: Documentation, https://bobthebuidler.github.io/eth-portfolio
+Project-URL: Source Code, https://github.com/BobTheBuidler/eth-portfolio
+Description-Content-Type: text/markdown
+Requires-Dist: checksum_dict>=1.1.2
+Requires-Dist: dank_mids>=4.20.109
+Requires-Dist: eth-brownie<1.21,>=1.19.3
+Requires-Dist: eth_retry<1,>=0.1.15
+Requires-Dist: evmspec>=0.2.0
+Requires-Dist: ez-a-sync>=0.24.43
+Requires-Dist: numpy<2
+Requires-Dist: pandas<1.6,>=1.4.3
+Requires-Dist: ypricemagic<5,>=4.0.57
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+
+# eth-portfolio
+Use `eth-portfolio` to output information about your portfolio in a streamlined, speed-optimized way.
+
+### NOTES:
+- This lib is still a WIP and the provided API is subject to change without notice.
+
+### INSTALLATION:
+- You should start with a fresh virtual environment, and then just...
+```
+pip install git+https://github.com/BobTheBuidler/eth-portfolio
+```
+
+**Known Issues**  
+Make sure you are using Python >= 3.8 and < 3.13
+If you have a PyYaml Issue with 3.4.1 not installing due to an issue with cython, try the following:  
+```
+pip install wheel
+pip install --no-build-isolation "Cython<3" "pyyaml==5.4.1"
+```
+then try again
+`
+pip install git+https://github.com/BobTheBuidler/eth-portfolio
+`
+
+
+### USE:
+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-1.1.0.dist-info/RECORD

@@ -0,0 +1,47 @@
+eth_portfolio/__init__.py,sha256=KTtWGBCaebcToNLEok9DsE1t1o1TWOs3OL1Z9fl4dYg,335
+eth_portfolio/_argspec.py,sha256=VzUZkbDkmOSgNUZBGbGblqtxBfDcmBAB89dY2OX0j-U,1595
+eth_portfolio/_cache.py,sha256=K58BsK82QhOVi6dfmCsMDz7WeqmhATI3kx3Refm0Svg,4511
+eth_portfolio/_config.py,sha256=viSW-IzNZPSe4xZQ2iUNdaEdITY0Xzgh_APO6VbzCH0,66
+eth_portfolio/_decimal.py,sha256=v8GoB35Wk-JTMqFGvjQoLM_UuXtVjzz2oBwm-VMFvRA,3524
+eth_portfolio/_decorators.py,sha256=si7kePGSl1Nfkia9up0IuJa2BxuRVxM_3BzVCk8P-yY,2281
+eth_portfolio/_exceptions.py,sha256=_nSv-dIdny3d0fwMTodZyZ6JOzJZM2-8rIXjB7h37_Q,2421
+eth_portfolio/_shitcoins.py,sha256=KGWUwrmS0S8ouIZhq_OhtottXjwV2wQYbnWKz2ubDHM,10892
+eth_portfolio/_utils.py,sha256=HmeZhhkIMR_ghvJTpqVAJwnBv7239BMDQBDun8WpWwM,9117
+eth_portfolio/address.py,sha256=xu7ZVvc96K9yaE3QJOvM7s530t3ax6wHU9RCPca8JSM,13599
+eth_portfolio/buckets.py,sha256=ZqWyNvniQOfAw6JnRx8jljVAhemSv7xvfFGq4AG2tLk,5907
+eth_portfolio/constants.py,sha256=L_iiL3QGz2VeFCgg5333Q66l-t7uDKftdel8CNnVP90,2356
+eth_portfolio/portfolio.py,sha256=Rb3tKzICkWof1su31wlIoKpsgPICfiZJzCmGB2D9OoA,23045
+eth_portfolio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eth_portfolio/typing.py,sha256=q4O0dc4R0u2hIJMh7yZx0C-uaJ6VW-GexXZ4fcDRToU,58389
+eth_portfolio/_db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eth_portfolio/_db/decorators.py,sha256=QJooL70iW7VEfz4D1LEdzq9CacwjJ0BNFsg9d3sM87Q,5126
+eth_portfolio/_db/entities.py,sha256=IscZejsWrWu0LmKvWOSsjqdgL3_JRMvRatu6TFg37zk,6867
+eth_portfolio/_db/utils.py,sha256=LmglwyPQjPi0O46gaxsu38BLaz0qw1XuRbSs4P_6Z80,20706
+eth_portfolio/_ledgers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eth_portfolio/_ledgers/address.py,sha256=pAhZeveT_tOvE93V05yEFjCaBtBZJs6IRUji4OTnmMA,31339
+eth_portfolio/_ledgers/portfolio.py,sha256=XZ9eVPpgEWuDCEXmIKdsnIB-wLPNQ_dWbm554d05KkE,13056
+eth_portfolio/_loaders/__init__.py,sha256=lb45_0ak32Z7N3-Nx1CAoRKiZ1_w-_YGbmSCNuunro8,1702
+eth_portfolio/_loaders/balances.py,sha256=SPWFSUMCO6Ex74BlpbEvvPKavtsAirkZRVsG2LhKysM,2754
+eth_portfolio/_loaders/token_transfer.py,sha256=c9NGtkBENBIVKhukec__T4iWgf0835VcR10_W3aFKqE,8349
+eth_portfolio/_loaders/transaction.py,sha256=o_taK8LEruxmiwWzetGOvSzQJWyyiKUgjzwWtqQxghY,13691
+eth_portfolio/_loaders/utils.py,sha256=Za7o0c8sIFZtrV4Z1yWgLGr49ZONLtZ45xifWXblBVY,2003
+eth_portfolio/_ydb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eth_portfolio/_ydb/token_transfers.py,sha256=Vln7JN3WXabkZo9XBCHYlraKcdmcRYF1Zb95bwCBnAk,4937
+eth_portfolio/protocols/__init__.py,sha256=lBCuoYnHqm415O3FYIk1yPc-Mt2AVeqAN75Jrqg7d4U,2582
+eth_portfolio/protocols/_base.py,sha256=tJ8tJgLR6BtGov7ire3bXxWzmJOSI9LvdZMMen_v8Xg,3660
+eth_portfolio/protocols/convex.py,sha256=uNbXxEmhcpXulNkbxoqWl9eAJTZjPJlzXFtrBGvRXLo,518
+eth_portfolio/protocols/dsr.py,sha256=QpUhn3Ds_w8FWxURr60IMmd38FtFWcQsUhjdlUadZHw,1198
+eth_portfolio/protocols/liquity.py,sha256=sTUoVtFYj-OWUamwCnJyqna-eAa5Ww7-qGA0St1OTMQ,640
+eth_portfolio/protocols/lending/__init__.py,sha256=CZinbKLUXfzMhxr-nOygVoF6GsvK-R70HOouB1_AnY0,1669
+eth_portfolio/protocols/lending/_base.py,sha256=UBdJ5eV2baewEvppjES72eOJzKTK2XHGYnySQNBcack,2254
+eth_portfolio/protocols/lending/compound.py,sha256=IE3kXla6_4rjxES5HIUaktWM0KJeJpi0Y7x4i5VuiU4,7202
+eth_portfolio/protocols/lending/liquity.py,sha256=Cpa7TcxZjOqcNIIqfKrx1bLRtKtVgNv13zeUR8ndDI0,4177
+eth_portfolio/protocols/lending/maker.py,sha256=Oy9LDz71o6Dx-36pdLleBfHQPhJqvClK69Xi2rNRB3U,4008
+eth_portfolio/protocols/lending/unit.py,sha256=kRCTHXj7TBH6qP4Uo-38AgPu_G85STA-dJGFrRQ99sE,1973
+eth_portfolio/structs/__init__.py,sha256=3EmfKoJGszobO7fCkERLXSN50V6dX3nfhvbiKIvJUZI,1443
+eth_portfolio/structs/modified.py,sha256=z75XDNXOfm3hDr7pj0PbmUvfPeQSFH9BJ9m0L2V_LFw,1784
+eth_portfolio/structs/structs.py,sha256=UYBVPcar3uIid77p0sFzhlCHi7_Ftv-L8_CGBbhCnF0,19800
+eth_portfolio-1.1.0.dist-info/METADATA,sha256=yS1jO6e0JbfFgVo1OCSKMq6Kmpqw8yV3OBJLyNs8v10,4990
+eth_portfolio-1.1.0.dist-info/WHEEL,sha256=nn6H5-ilmfVryoAQl3ZQ2l8SH5imPWFpm1A5FgEuFV4,91
+eth_portfolio-1.1.0.dist-info/top_level.txt,sha256=TErEJr45v_N_UfMO8_NWlZoYHn_M8dt7nw-ejsXJkMU,14
+eth_portfolio-1.1.0.dist-info/RECORD,,

eth_portfolio-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

eth_portfolio-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+eth_portfolio