⚡ Quick Start Guide¶

from xeepy import Xeepy

# Option A: Pass directly
async with Xeepy(auth_token="your_auth_token_here") as x:
    ...

# Option B: Environment variable (recommended)
# export XEEPY_AUTH_TOKEN=your_auth_token_here
async with Xeepy() as x:
    ...

# Option C: Config file
# Create ~/.xeepy/config.yaml

import asyncio
from xeepy import Xeepy

async def main():
    async with Xeepy() as x:
        # Get replies to any tweet
        replies = await x.scrape.replies(
            "https://x.com/elonmusk/status/1234567890",
            limit=50
        )

        print(f"Found {len(replies)} replies!")

        for reply in replies[:5]:
            print(f"@{reply.username}: {reply.text[:100]}...")

        # Export to CSV
        x.export.to_csv(replies, "replies.csv")

asyncio.run(main())

import asyncio
from xeepy import Xeepy

async def main():
    async with Xeepy() as x:
        # First, do a dry run to see who would be unfollowed
        preview = await x.unfollow.non_followers(
            max_unfollows=50,
            whitelist=["friend1", "important_account"],
            dry_run=True
        )

        print(f"Would unfollow {len(preview.unfollowed_users)} users:")
        for user in preview.unfollowed_users[:10]:
            print(f"  - @{user}")

        # If you're sure, run for real
        # result = await x.unfollow.non_followers(dry_run=False)

asyncio.run(main())

import asyncio
from xeepy import Xeepy

async def main():
    async with Xeepy() as x:
        # Auto-like tweets containing keywords
        result = await x.engage.auto_like(
            keywords=["python", "machinelearning", "AI"],
            max_likes=25,
            duration_minutes=15
        )

        print(f"Liked {result.success_count} tweets!")

asyncio.run(main())

import asyncio
from xeepy import Xeepy

async def main():
    async with Xeepy() as x:
        # Check who unfollowed you
        report = await x.monitor.unfollowers()

        if report.unfollowers:
            print(f"😢 {len(report.unfollowers)} people unfollowed you:")
            for user in report.unfollowers:
                print(f"  - @{user}")
        else:
            print("✅ No one unfollowed you!")

        if report.new_followers:
            print(f"🎉 {len(report.new_followers)} new followers!")

asyncio.run(main())

import asyncio
from xeepy import Xeepy
from xeepy.ai import ContentGenerator

async def main():
    async with Xeepy() as x:
        # Initialize AI (requires API key)
        ai = ContentGenerator(
            provider="openai",
            api_key="sk-..."
        )

        # Generate reply for a tweet
        tweet = "Just shipped my first Python package! 🐍"

        reply = await ai.generate_reply(
            tweet_text=tweet,
            style="supportive"
        )

        print(f"Suggested reply: {reply}")
        # Output: "Congrats! 🎉 What does it do? Would love to check it out!"

asyncio.run(main())

import asyncio
from xeepy import Xeepy

async def main():
    async with Xeepy() as x:
        # Your automation code here
        pass

if __name__ == "__main__":
    asyncio.run(main())

async with Xeepy(headless=False) as x:
    # Browser window will be visible
    pass