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.
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.
- 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.
Check out the live app hosted on Streamlit Community Cloud:
(Replace the URL with your actual app link after deployment.)
Follow these steps to set up 4tune locally on your machine:
-
Clone the Repository
git clone https://github.com/yourusername/4tune.git
-
Navigate to the Project Directory
cd 4tune -
Create a Virtual Environment
python3 -m venv venv
-
Activate the Virtual Environment
-
On macOS/Linux:
source venv/bin/activate -
On Windows:
venv\Scripts\activate
-
-
Install the Required Packages
pip install -r requirements.txt
To run the app locally:
-
Ensure the Virtual Environment is Activated
Your terminal prompt should show
(venv). -
Run the Streamlit App
streamlit run app.py
-
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.
- The terminal will provide a local URL (usually
-
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.
- Python 3.6 or higher
- Packages (listed in
requirements.txt):streamlityoutube-transcript-apirequests
Contributions are welcome! Here's how you can help:
-
Fork the Repository
Click the Fork button at the top right corner of the repository page.
-
Clone Your Fork
git clone https://github.com/yourusername/4tune.git
-
Create a New Branch
git checkout -b feature/your-feature-name
-
Make Your Changes
Implement your feature or fix.
-
Commit Your Changes
git commit -am "Add your commit message here" -
Push to Your Fork
git push origin feature/your-feature-name
-
Submit a Pull Request
- Go to the original repository on GitHub.
- Click on Pull Requests.
- Click New Pull Request and follow the instructions.
This project is licensed under the MIT License. See the LICENSE file for details.
- 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.