Skip to content

README.md

Latest commit

 

History

History
134 lines (96 loc) · 3.81 KB

README.md

File metadata and controls

134 lines (96 loc) · 3.81 KB

TrendTags - Tag Generator

Python Lint CodeQL

TrendTags is a real-time tag generator powered by YouTube trends, built with Flask and a clean, responsive frontend.

Features

  • 🔥 Real-time tag generation from YouTube trending videos
  • 🪄 One-click “copy all tags” functionality
  • 📱 Clean, responsive, and modern interface
  • ⚡ Fast Flask-powered backend
  • 🛡️ Auto-updating tag database
  • 👨‍💻 Python linting, CodeQL security scanning via GitHub Actions

Installation 🛠️

Prerequisites

  • Python >=3.12
  • A YouTube API key (get one from Google Cloud Console)

Quick Start

  1. Clone the repository and navigate to it:

    git clone https://github.com/imDarshanGK/TrendTags.git
cd TrendTags

  2. Create a .env file:

    cp .env.example .env
nano .env  # Add your actual API keys

    Edit .env to set your Youtube API key. The Youtube API key is required, but you may optionally specify a Rapid API key, as well as the port the application will run on and the debug mode. When deploying to product, debug mode should be disabled.

    Preliminary validation will be ran on your API keys prior to the app fully launching. If you receive an error, inspect the log file to identify what may resolve your issue.

  3. Install dependencies:

    pip install -r requirements.txt
# or, if using something like uv
uv sync

  4. Run the application:

    python app.py
# or, if using something like uv
uv run app.py

Usage

  1. Enter your video topic (e.g., "cooking", "tech reviews")
  2. Select the number of tags (10–30)
  3. Click "Generate Tags"
  4. Copy tags with a single click

Project Structure

TrendTags/
├── .github/                # CI/CD workflows
│   └── workflows/          # GitHub Actions
├── config/                 # Configuration files
│   └── logging_config.json # Logging configuration file
├── logs/                   # Source code
│   └── debug_log.log       # Logging file
├── src/                    # Source code
│   ├── config.py           # Configuration
│   └── ...                 # Other modules
├── static/                 # Frontend assets
│   ├── css/                # Stylesheets
│   └── js/                 # JavaScript
├── templates/              # HTML templates
├── tests/                  # Pytest tests
│   ├── integration/        # Integration level tests
│   └── unit/               # Unit level tests
├── env.example             # Example environment file
├── app.py                  # Main Flask application
├── requirements.txt        # Python dependencies
├── LICENSE                 # MIT License
└── README.md               # This file

Code Quality

Python code style and tests:

flake8 src tests app.py
black --check src tests app.py
pytest

Security & Code Scanning

TrendTags uses CodeQL for code scanning via GitHub Actions. You can view “Code scanning results” and security alerts in the Security tab of your repository.

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for:

  • How to report issues
  • Code style guidelines
  • Pull request process
  • Commit message standards

License

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