flickr-mail/README.md

68 lines
2.4 KiB
Markdown
Raw Normal View History

2023-09-29 12:31:15 +01:00
# Flickr Photo Finder for Wikipedia Articles
2023-09-29 12:51:14 +01:00
Tool lives here: <https://edwardbetts.com/flickr_mail/>
2023-09-29 12:31:15 +01:00
This tool is designed to help you find photos on Flickr for Wikipedia articles
and contact the photographer. It's a Python application that leverages the Flask
framework for web development.
## Table of Contents
- [Introduction](#introduction)
- [Usage](#usage)
- [Error Handling](#error-handling)
- [Running the Application](#running-the-application)
## Introduction
This tool is developed and maintained by Edward Betts (edward@4angle.com). Its
primary purpose is to simplify the process of discovering and contacting
photographers on Flickr whose photos can be used to enhance Wikipedia articles.
### Key Features
- Search for Flickr photos related to specific Wikipedia articles.
- Generate messages to request permission to use photos on Wikipedia.
- Handle exceptions gracefully and provide detailed error information.
## Usage
To use the tool, follow these steps:
1. Start the tool by running the script.
2. Access the tool through a web browser.
3. Enter the Wikipedia URL for the article you want to find photos for.
4. Optionally, provide a Flickr URL if you already have one in mind.
5. The tool will extract relevant information and generate a message for you to
request permission to use the photo on Wikipedia.
## Error Handling
The application includes error handling to ensure a smooth user experience. If
an error occurs, it will display a detailed error message with traceback
information. The error handling is designed to provide valuable insights into
any issues that may arise during use.
## Running the Application
To run the application, ensure you have Python 3 installed on your system. You
will also need to install the required Python modules mentioned in the script,
including Flask, requests, and others.
1. Clone this repository to your local machine.
2. Navigate to the project directory.
3. Run the following command to start the application:
```bash
2023-09-29 12:32:14 +01:00
python3 main.py
2023-09-29 12:31:15 +01:00
```
4. Access the application by opening a web browser and visiting the provided URL
(usually `http://localhost:5000/`).
2023-09-29 12:32:14 +01:00
That's it! You can now use the Flickr Photo Finder tool to streamline the
process of finding and contacting photographers for Wikipedia articles.
2023-09-29 12:31:15 +01:00
If you encounter any issues or have questions, feel free to contact Edward Betts
(edward@4angle.com).
Happy photo hunting!