dao-treasury 0.0.30__tar.gz → 1.0.0__tar.gz

{dao_treasury-0.0.30/dao_treasury.egg-info → dao_treasury-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
-Name: dao-treasury
-Version: 0.0.30
+Metadata-Version: 2.4
+Name: dao_treasury
+Version: 1.0.0
 Summary: Produce comprehensive financial reports for your on-chain org
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -14,6 +14,14 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10,<3.13
 Description-Content-Type: text/markdown
+Requires-Dist: eth-portfolio==0.5.11
+Requires-Dist: psycopg2-binary==2.9.11
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 DAO Treasury is a comprehensive financial reporting and treasury management solution designed specifically for decentralized organizations. Built as an extension to [eth-portfolio](https://github.com/BobTheBuidler/eth-portfolio)'s [Portfolio Exporter](https://bobthebuidler.github.io/eth-portfolio/exporter.html), DAO Treasury automates the collection and visualization of financial data, enabling organizations to monitor and report on treasury activities with clarity and transparency.
 
@@ -22,6 +30,7 @@ DAO Treasury is a comprehensive financial reporting and treasury management solu
 - **Financial Reporting for DAOs:** Extends core portfolio functionalities to generate detailed reports tailored for on-chain organizations.
 - **Dashboard Provisioning:** Utilizes [Grafana](https://grafana.com/) dashboards—defined in JSON files within the .grafana/provisioning directories—to offer real-time, dynamic visualizations of treasury data.
 - **Automated Data Export:** Features a treasury export tool that, once configured (with a supported [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) and [Docker](https://www.docker.com/get-started/)), continuously captures financial snapshots at set intervals.
+- **Custom Buckets for Wallets:** Assign custom categories ("buckets") to specific wallet addresses for more granular reporting using the `--custom-bucket` CLI option.
 - **Ease of Contribution:** Non-technical users can easily update or create dashboard visuals using Grafana’s intuitive UI. The [Contributing Guidelines](https://github.com/BobTheBuidler/dao-treasury/blob/master/CONTRIBUTING.md) document provides a step-by-step guide to defining new visuals and dashboards and integrating those changes into the repository, ensuring that anyone can contribute to the visual reporting aspect of the project.
 
 ## Requirements
@@ -34,7 +43,10 @@ DAO Treasury is a comprehensive financial reporting and treasury management solu
 - 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.). Your archive node must have tracing enabled (free-tier Alchemy nodes do not support this option).
 - You must configure a [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) to use your RPC.
 - You will 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.
-- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while Yearn Treasury is running.
+- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while DAO Treasury is running.
+
+## Debug logging
+DAO Treasury relies on ypricemagic for price lookups. If you need to spot long-running price calls, enable the `y.stuck?` logger at DEBUG. Details: [y.stuck? logger](CONTRIBUTING.md#y-stuck-logger).
 
 ## Installation
 
@@ -56,17 +68,31 @@ For local development (from source installation), use:
 poetry run dao-treasury run --wallet 0x123 --network mainnet --interval 12h
 ```
 
+**Assigning Custom Buckets to Wallets:**
+
+You can assign custom categories ("buckets") to specific wallet addresses for more granular reporting. Use the `--custom-bucket` option one or more times, each with the format `address:bucket_name`:
+
+```bash
+dao-treasury run --wallet 0x123 --network mainnet --custom-bucket "0x123:Operations" --custom-bucket "0x456:Grants" --custom-bucket "0x789:Investments"
+```
+
 **CLI Options:**
+> Only optional arguments are listed here. Required arguments (such as `--wallet` or `--wallets`) are shown in the usage examples above.
+
 - `--network`: The id of the brownie network the exporter will connect to (default: mainnet)
 - `--interval`: The time interval between each data snapshot (default: 12h)
+- `--concurrency`: The max number of historical blocks to export concurrently. (default: 30)
 - `--daemon`: Run the export process in the background (default: False) (NOTE: currently unsupported)
+- `--sort-rules`: Directory containing sort rules definitions for transaction categorization.
+- `--nicknames`: File containing address nicknames for reporting.
 - `--grafana-port`: Set the port for the Grafana dashboard where you can view data (default: 3004)
 - `--renderer-port`: Set the port for the report rendering service (default: 8091)
 - `--victoria-port`: Set the port for the Victoria metrics reporting endpoint (default: 8430)
 - `--start-renderer`: If set, both the Grafana and renderer containers will be started for dashboard image export. By default, only the grafana container is started.
+- `--custom-bucket`: Assign a custom bucket/category to a wallet address for reporting. Specify as `address:bucket_name`. Can be used multiple times.
 
 After running the command, the export script will run continuously until you close your terminal.
-To view the dashboards, just open your browser and navigate to [http://localhost:3004](http://localhost:3004)!
+To view the dashboards, open your browser and navigate to [http://localhost:3004](http://localhost:3004). Log in with the Grafana admin credentials you set via `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD` (or enable anonymous access with `DAO_TREASURY_GRAFANA_ANON_ENABLED=true`).
 
 ## Docker
 
@@ -77,7 +103,10 @@ When you run DAO Treasury, [eth-portfolio](https://github.com/BobTheBuidler/eth-
   - Pre-configured with dashboards and plugins for real-time monitoring.
   - Uses persistent storage to retain dashboard settings and data.
   - Accessible locally (default port `3004`, configurable via `--grafana-port`).
-  - Supports anonymous access for convenience.
+  - Requires login by default using `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD`.
+  - Optional anonymous access via `DAO_TREASURY_GRAFANA_ANON_ENABLED=true` (Viewer-only).
+  - Sign-ups are disabled for safety.
+  - Validates admin credentials on startup and fails fast if they are incorrect.
   - Integrates with the renderer container for dashboard image export.
   - Loads dashboards and data sources automatically via provisioning files.
 

dao_treasury-0.0.30/PKG-INFO → dao_treasury-1.0.0/README.md

@@ -1,20 +1,3 @@
-Metadata-Version: 2.1
-Name: dao_treasury
-Version: 0.0.30
-Summary: Produce comprehensive financial reports for your on-chain org
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.10,<3.13
-Description-Content-Type: text/markdown
-
 DAO Treasury is a comprehensive financial reporting and treasury management solution designed specifically for decentralized organizations. Built as an extension to [eth-portfolio](https://github.com/BobTheBuidler/eth-portfolio)'s [Portfolio Exporter](https://bobthebuidler.github.io/eth-portfolio/exporter.html), DAO Treasury automates the collection and visualization of financial data, enabling organizations to monitor and report on treasury activities with clarity and transparency.
 
 ## Key Features
@@ -22,6 +5,7 @@ DAO Treasury is a comprehensive financial reporting and treasury management solu
 - **Financial Reporting for DAOs:** Extends core portfolio functionalities to generate detailed reports tailored for on-chain organizations.
 - **Dashboard Provisioning:** Utilizes [Grafana](https://grafana.com/) dashboards—defined in JSON files within the .grafana/provisioning directories—to offer real-time, dynamic visualizations of treasury data.
 - **Automated Data Export:** Features a treasury export tool that, once configured (with a supported [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) and [Docker](https://www.docker.com/get-started/)), continuously captures financial snapshots at set intervals.
+- **Custom Buckets for Wallets:** Assign custom categories ("buckets") to specific wallet addresses for more granular reporting using the `--custom-bucket` CLI option.
 - **Ease of Contribution:** Non-technical users can easily update or create dashboard visuals using Grafana’s intuitive UI. The [Contributing Guidelines](https://github.com/BobTheBuidler/dao-treasury/blob/master/CONTRIBUTING.md) document provides a step-by-step guide to defining new visuals and dashboards and integrating those changes into the repository, ensuring that anyone can contribute to the visual reporting aspect of the project.
 
 ## Requirements
@@ -34,7 +18,10 @@ DAO Treasury is a comprehensive financial reporting and treasury management solu
 - 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.). Your archive node must have tracing enabled (free-tier Alchemy nodes do not support this option).
 - You must configure a [brownie network](https://eth-brownie.readthedocs.io/en/stable/network-management.html) to use your RPC.
 - You will 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.
-- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while Yearn Treasury is running.
+- You'll also need [Docker](https://www.docker.com/get-started/) installed on your system. If on MacOS, you will need to leave Docker Desktop open while DAO Treasury is running.
+
+## Debug logging
+DAO Treasury relies on ypricemagic for price lookups. If you need to spot long-running price calls, enable the `y.stuck?` logger at DEBUG. Details: [y.stuck? logger](CONTRIBUTING.md#y-stuck-logger).
 
 ## Installation
 
@@ -56,17 +43,31 @@ For local development (from source installation), use:
 poetry run dao-treasury run --wallet 0x123 --network mainnet --interval 12h
 ```
 
+**Assigning Custom Buckets to Wallets:**
+
+You can assign custom categories ("buckets") to specific wallet addresses for more granular reporting. Use the `--custom-bucket` option one or more times, each with the format `address:bucket_name`:
+
+```bash
+dao-treasury run --wallet 0x123 --network mainnet --custom-bucket "0x123:Operations" --custom-bucket "0x456:Grants" --custom-bucket "0x789:Investments"
+```
+
 **CLI Options:**
+> Only optional arguments are listed here. Required arguments (such as `--wallet` or `--wallets`) are shown in the usage examples above.
+
 - `--network`: The id of the brownie network the exporter will connect to (default: mainnet)
 - `--interval`: The time interval between each data snapshot (default: 12h)
+- `--concurrency`: The max number of historical blocks to export concurrently. (default: 30)
 - `--daemon`: Run the export process in the background (default: False) (NOTE: currently unsupported)
+- `--sort-rules`: Directory containing sort rules definitions for transaction categorization.
+- `--nicknames`: File containing address nicknames for reporting.
 - `--grafana-port`: Set the port for the Grafana dashboard where you can view data (default: 3004)
 - `--renderer-port`: Set the port for the report rendering service (default: 8091)
 - `--victoria-port`: Set the port for the Victoria metrics reporting endpoint (default: 8430)
 - `--start-renderer`: If set, both the Grafana and renderer containers will be started for dashboard image export. By default, only the grafana container is started.
+- `--custom-bucket`: Assign a custom bucket/category to a wallet address for reporting. Specify as `address:bucket_name`. Can be used multiple times.
 
 After running the command, the export script will run continuously until you close your terminal.
-To view the dashboards, just open your browser and navigate to [http://localhost:3004](http://localhost:3004)!
+To view the dashboards, open your browser and navigate to [http://localhost:3004](http://localhost:3004). Log in with the Grafana admin credentials you set via `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD` (or enable anonymous access with `DAO_TREASURY_GRAFANA_ANON_ENABLED=true`).
 
 ## Docker
 
@@ -77,7 +78,10 @@ When you run DAO Treasury, [eth-portfolio](https://github.com/BobTheBuidler/eth-
   - Pre-configured with dashboards and plugins for real-time monitoring.
   - Uses persistent storage to retain dashboard settings and data.
   - Accessible locally (default port `3004`, configurable via `--grafana-port`).
-  - Supports anonymous access for convenience.
+  - Requires login by default using `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD`.
+  - Optional anonymous access via `DAO_TREASURY_GRAFANA_ANON_ENABLED=true` (Viewer-only).
+  - Sign-ups are disabled for safety.
+  - Validates admin credentials on startup and fails fast if they are incorrect.
   - Integrates with the renderer container for dashboard image export.
   - Loads dashboards and data sources automatically via provisioning files.