Skip to content

PUSH_TO_GITHUB.md

Latest commit

 

History

History
68 lines (50 loc) · 1.53 KB

PUSH_TO_GITHUB.md

File metadata and controls

68 lines (50 loc) · 1.53 KB

🚀 Push to GitHub Instructions

Quick Push

cd /home/atakan/memoryguard

git init
git add .
git commit -m "Initial commit: MemoryGuard v1.0.0 - Modular Memory Monitoring"

git branch -M main
git remote add origin https://github.com/YOUR_USERNAME/memoryguard.git
git push -u origin main

Create GitHub Repo First

  1. Go to https://github.com/new
  2. Repository name: memoryguard
  3. Description: 🔍 Modular Python Memory Monitoring & Valgrind Integration
  4. Set to Public (or Private)
  5. DO NOT initialize with README (we already have one!)
  6. Click "Create repository"

Then run the commands above.

Usage After Push

Install in any project:

pip install git+https://github.com/YOUR_USERNAME/memoryguard.git

Or add to requirements.txt:

git+https://github.com/YOUR_USERNAME/memoryguard.git@main

Or use as git submodule:

git submodule add https://github.com/YOUR_USERNAME/memoryguard.git third_party/memoryguard

Files Overview

File Purpose
memoryguard/core.py Main MemoryGuard class
memoryguard/integration.py Tool integration helpers
memoryguard/dashboard.py Terminal UI (needs 'rich')
examples/demo.py 9 interactive examples
tests/test_memoryguard.py Full test suite
pyproject.toml Package configuration

Like Lego! 🧱

Just drop it into any project:

from memoryguard import MemoryGuard, track_memory

guard = MemoryGuard()

@track_memory("my_function", guard)
def my_function():
    pass