🎨 Artsy Web Service

A modern web application for searching and discovering artists using the Artsy API

📋 Table of Contents

• ✨ Features
• 🚀 Quick Start
• 🛠️ Installation
• 📖 API Documentation
• 🏗️ Architecture
• 🔧 Configuration
• 🚀 Deployment
• 🧪 Testing
• 📁 Project Structure
• 🤝 Contributing
• 📄 License

✨ Features

• 🔍 Artist Search: Search for artists using the Artsy API
• 📱 Responsive Design: Modern, mobile-friendly interface
• ⚡ Real-time Results: Fast search with loading indicators
• 🔄 Auto Token Refresh: Automatic API token renewal every 7 days
• ☁️ Cloud Ready: Deployed on Google App Engine
• 🎨 Beautiful UI: Clean, intuitive user interface

🚀 Quick Start

Prerequisites

• Python 3.9+
• pip (Python package installer)

Local Development

1. Clone the repository

   git clone https://github.com/hill0106/Artsy-Web-Service.git
   cd Assignment2/app

2. Install dependencies

   pip install -r requirements.txt

3. Run the application

   python main.py

4. Open your browser

   http://localhost:8080
   

🛠️ Installation

Dependencies

The application uses the following Python packages:

Flask==3.0.0          # Web framework
apscheduler==3.8.0    # Background task scheduler
requests==2.26.0      # HTTP library for API calls

Environment Setup

No additional environment variables are required for local development. The application uses hardcoded Artsy API credentials for demonstration purposes.

📖 API Documentation

Endpoints

GET /

• Description: Serves the main application interface
• Response: HTML page with search functionality

GET /api/search?q={query}

• Description: Search for artists by name
• Parameters:
  • q (string, required): Artist name to search for
• Response: JSON array of artist search results
• Example:

  curl "http://localhost:8080/api/search?q=picasso"

GET /api/artist/{artist_id}

• Description: Get detailed information about a specific artist
• Parameters:
  • artist_id (string, required): Unique artist identifier
• Response: JSON object with artist details
• Example:

  curl "http://localhost:8080/api/artist/4d8b92b34eb68a1b2c0003f4"

Error Handling

• 400 Bad Request: Missing required parameters
• 500 Internal Server Error: API request failures or server errors

🏗️ Architecture

System Overview

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Web Browser   │◄──►│   Flask App     │◄──►│   Artsy API     │
│                 │    │                 │    │                 │
│ - Search UI     │    │ - Routes        │    │ - Artist Data   │
│ - Results       │    │ - Token Mgmt    │    │ - Search API    │
│ - Responsive    │    │ - Error Handling│    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘

Key Components

• Flask Application: Main web server handling HTTP requests
• Background Scheduler: Manages automatic token refresh
• Artsy API Integration: Fetches artist data and search results
• Static Assets: CSS, JavaScript, and images for the frontend

🔧 Configuration

Token Management

The application automatically manages Artsy API tokens:

• Initial Token: Fetched on application startup
• Auto Refresh: Tokens are renewed every 7 days
• Error Handling: Graceful fallback for token failures

API Credentials

Current implementation uses demo credentials:

• Client ID: 208b20e0a3e74e677cef
• Client Secret: 87014948d402d1d0b9934dd621e5ab0f

⚠️ Security Note: In production, store credentials as environment variables

🚀 Deployment

Google App Engine

The application is configured for Google App Engine deployment:

1. Configuration File: app.yaml

   runtime: python39
   handlers:
     - url: /static
       static_dir: static
     - url: /.*
       script: auto

2. Deploy Command:

   gcloud app deploy

Environment Variables

For production deployment, consider setting:

• PORT: Application port (default: 8080)
• ARTSY_CLIENT_ID: Artsy API client ID
• ARTSY_CLIENT_SECRET: Artsy API client secret

🧪 Testing

Manual Testing

1. Search Functionality:

   • Enter artist names in the search box
   • Verify results are displayed correctly
   • Test with various artist names

2. Error Handling:

   • Test with empty search queries
   • Verify error messages are user-friendly

3. Responsive Design:

   • Test on different screen sizes
   • Verify mobile compatibility

📁 Project Structure

app/
├── main.py              # Main Flask application
├── requirements.txt     # Python dependencies
├── app.yaml            # Google App Engine configuration
├── README.md           # Project documentation
├── static/             # Static assets
│   ├── style.css       # Application styles
│   ├── script.js       # Frontend JavaScript
│   └── images/         # Image assets
│       ├── artsy_logo.svg
│       ├── clear_icon.png
│       ├── loading.gif
│       └── search_icon.png
└── templates/          # HTML templates
    └── index.html      # Main application template

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Guidelines

• Follow PEP 8 style guidelines
• Add comments for complex logic
• Test your changes thoroughly
• Update documentation as needed

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

---

Made with ❤️ for art lovers

🌐 Live Demo • 📧 Contact • 🐛 Report Bug