Skip to content

washyaderner/4tune

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Certainly! Here's the updated README file for your app, with the email address changed to washyaderner@gmail.com. You can copy the text below.


4tune: Crypto Token Extractor from YouTube Videos

Welcome to 4tune, a tool designed to help you quickly identify and explore cryptocurrency tokens mentioned in YouTube videos. By scanning video transcripts, 4tune extracts token names and symbols, providing you with direct links to their CoinGecko pages.

Table of Contents

Features

  • Instant Token Extraction: Scan YouTube video transcripts in seconds to find mentioned crypto tokens.
  • Easy-to-Use Interface: Simple web app where you can paste a YouTube link and click a button to get results.
  • Direct Links: Provides clickable links to CoinGecko pages for quick access to token information.
  • Top Tokens Limit: Option to limit the output to the top 10 tokens mentioned.
  • Streamlit Integration: Built with Streamlit for a seamless and interactive user experience.

Demo

Check out the live app hosted on Streamlit Community Cloud:

4tune Live Demo

(Replace the URL with your actual app link after deployment.)

Installation

Follow these steps to set up 4tune locally on your machine:

  1. Clone the Repository

    git clone https://github.com/yourusername/4tune.git
  2. Navigate to the Project Directory

    cd 4tune
  3. Create a Virtual Environment

    python3 -m venv venv
  4. Activate the Virtual Environment

    • On macOS/Linux:

      source venv/bin/activate
    • On Windows:

      venv\Scripts\activate
  5. Install the Required Packages

    pip install -r requirements.txt

Usage

To run the app locally:

  1. Ensure the Virtual Environment is Activated

    Your terminal prompt should show (venv).

  2. Run the Streamlit App

    streamlit run app.py
  3. Open the App in Your Browser

    • The terminal will provide a local URL (usually http://localhost:8501).
    • Open this URL in your web browser to access 4tune.
  4. Using 4tune

    • Enter a YouTube Video URL: Paste the link of the YouTube video you want to analyze.
    • Extract Tokens: Click the "Extract Tokens" button.
    • View Results: The app will display a list of tokens mentioned in the video transcript, each linked to their CoinGecko page.

Requirements

  • Python 3.6 or higher
  • Packages (listed in requirements.txt):
    • streamlit
    • youtube-transcript-api
    • requests

Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the Repository

    Click the Fork button at the top right corner of the repository page.

  2. Clone Your Fork

    git clone https://github.com/yourusername/4tune.git
  3. Create a New Branch

    git checkout -b feature/your-feature-name
  4. Make Your Changes

    Implement your feature or fix.

  5. Commit Your Changes

    git commit -am "Add your commit message here"
  6. Push to Your Fork

    git push origin feature/your-feature-name
  7. Submit a Pull Request

    • Go to the original repository on GitHub.
    • Click on Pull Requests.
    • Click New Pull Request and follow the instructions.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

  • Streamlit: For providing an amazing framework to build the web app.
  • YouTube Transcript API: For enabling access to YouTube video transcripts.
  • CoinGecko API: For providing up-to-date cryptocurrency data.

Feel free to open an issue or contact me at washyaderner@gmail.com if you have any questions or suggestions.

About

Turn Crypto YouTube Links Into $TICKER Lists

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages