buru 0.3.4

A Rust application with both CLI and Web interface for data/image processing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# buru

[![docs.rs](https://docs.rs/buru/badge.svg)](https://docs.rs/buru)

This project provides a comprehensive system for managing and archiving images, offering a robust CLI and a web interface to efficiently store images, extract metadata, and handle database interactions. The application is built in Rust and utilizes asynchronous processing to ensure high performance and scalability.

## Overview

The system consists of two main components:
- **CLI Application**: Enables users to archive images via command line, adding metadata and tags.
- **Web Interface**: Provides a RESTful API for interacting with the archival system programmatically.

## Features

- **Image Storage**: Efficiently handles image storage with metadata extraction and tagging capabilities.
- **Database Integration**: Uses SQLite for storing image metadata, tags, and source information.
- **Tagging System**: Supports tagging images to facilitate easy searching and categorization.
- **Asynchronous Execution**: Leverages async features of Rust for non-blocking operations.
- **Docker Support**: Containerization of the application with Docker for easy deployment.

## Setup

### Prerequisites

- [Rust](https://www.rust-lang.org/tools/install) for building the project.
- [Docker](https://www.docker.com/get-started) for running the application in containers.
- [SQLite](https://www.sqlite.org/download.html) database for metadata storage.

### Installation

1. **Clone the repository:**

   ```bash
   git clone <repository-url>
   cd image-archival-system
   ```

2. **Build the project:**

   ```bash
   cargo build --release
   ```

3. **Run the CLI or Web Server:**

   - **CLI**: Execute image archival commands.
     ```bash
     cargo run --bin cli
     ```

   - **Web Server**: Start the RESTful API.
     ```bash
     cargo run --bin web
     ```

4. **Docker**: Optionally, build and run using Docker.

   - Build Docker Image:

     ```bash
     docker-compose build
     ```

   - Run with Docker Compose:

     ```bash
     docker-compose up
     ```

## Usage

### CLI Application

To archive an image using the CLI:

```bash
cargo run --bin cli -- archive --path /path/to/image.jpg --tags "nature sunset" --source "http://example.com/source"
```

### Web Interface

The web interface provides endpoints to archive images, retrieve metadata, and manage tags. Start the server and access the API documentation at `[localhost:3000]`.

#### Example

- **GET /images**: Fetch all archived images.
- **POST /images**: Upload and archive a new image.

### Docker Deployment

The application can be easily deployed using Docker. Use the provided `docker-compose.yml` to manage services. This setup includes both the application server and a reverse proxy using Nginx.

## License

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