NUNA/guidebook/01_Book_Map.md

Book Map

This document provides a high-level overview of the repository's scripts, their functionalities, and the data flow between them.

Device and Data Flow Map

This section illustrates the connections between your local machine, the cloud services, and the scripts in this repository.

gdrive_cleanup.py

• Purpose: To audit and clean up your Google Drive by identifying large and duplicate files.
• Action:
  1. Authenticates with your Google account using OAuth 2.0.
  2. Scans your Google Drive files based on your specified criteria (e.g., file size, duplicates).
  3. Provides a report of the findings.
  4. Can move files to the trash (but does not permanently delete them).
• Target: Google Drive.
• Next Steps:
  • Review the generated reports (.csv, .json).
  • Create a list of file IDs to be trashed.
  • Run the trash command with the list of file IDs.

dropbox_to_onedrive.py

• Purpose: To import a shared folder from Dropbox into your OneDrive.
• Action:
  1. Downloads the Dropbox shared folder as a ZIP file.
  2. Extracts the ZIP file locally.
  3. Authenticates with your Microsoft account using OAuth 2.0.
  4. Uploads the extracted files to a specified folder in your OneDrive.
• Target: Dropbox (read-only), OneDrive (write).
• Next Steps:
  • Verify that the files have been successfully uploaded to your OneDrive.

trading_data_manager.py

• Purpose: To automate local file management for trading logs, raw exports, and reports.
• Action:
  1. Creates a consistent local folder structure under trading_data/.
  2. Converts raw_csv/*.csv into reports/*.xlsx.
  3. Moves older logs and raw files into trash/ (quarantine).
  4. Archives older reports into archive/YYYY/MM/.
  5. Writes a per-run log into automation_logs/.
• Target: Local filesystem only (no cloud APIs).
• Next Steps:
  • Copy trading_data_config.example.json to trading_data_config.json and tune retention days.
  • Run a dry-run first: python3 trading_data_manager.py run
  • Schedule daily runs (cron / Task Scheduler) once you’re happy with the output.

Repository Instruction and Map

This section provides instructions on how to set up the repository and where to find the key scripts.

Automated Setup

This repository includes setup scripts to automate the creation of a virtual environment and the installation of dependencies.

For Linux and macOS:

# Make the script executable
chmod +x setup.sh

# Run the setup script
./setup.sh

For Windows:

# Run the setup script
setup.bat

After the setup is complete, you will need to activate the virtual environment in your current shell:

• Linux and macOS: source .venv/bin/activate
• Windows: .venv\Scripts\activate.bat

Manual Setup

If you prefer to set up the environment manually, follow these steps:

1. Clone the repository:

   git clone https://github.com/USERNAME/REPOSITORY.git
   cd REPOSITORY
   

2. Create and activate a virtual environment:

   python3 -m venv .venv
   # On Linux/macOS
   source .venv/bin/activate
   # On Windows
   .venv\Scripts\activate.bat
   

3. Install dependencies:

   pip install -r requirements.txt
   

Next Steps: OAuth Credentials

After setting up the environment, you will need to configure the necessary OAuth credentials for the scripts to function:

• For gdrive_cleanup.py, follow the instructions in the README.md to create credentials.json.
• For dropbox_to_onedrive.py, follow the instructions in the README.md to set the ONEDRIVE_CLIENT_ID environment variable.

File and Script Locations

• gdrive_cleanup.py: The main script for auditing and cleaning up Google Drive.
• dropbox_to_onedrive.py: The main script for importing Dropbox shared folders to OneDrive.
• requirements.txt: A list of the Python dependencies required to run the scripts.
• guidebook/: The directory containing this guide book.

GitHub Agents Setup

• guidebook/04_org_copilot_agents_setup.md: A comprehensive guide for setting up GitHub Copilot and Jules agents at the organization level.