Skip to content

Commit 342a873

Browse files
Refactor README structure for improved readability and maintainability (#1258)
1 parent 8274ebd commit 342a873

9 files changed

Lines changed: 123 additions & 53 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# 🌟 Contributing to PictoPy
1+
# Contributing to PictoPy
22

33
Hi there! Thank you for considering contributing to **PictoPy** – we’re excited to collaborate with you. Whether you're fixing a bug, improving documentation, or suggesting a new feature — you're welcome here!
44

55
NOTE: Please do not open a PR for the issue which is not yet reviewed and labelled by the maintainer. Wait for the maintainer to give a green light.
66

7-
# 🛠 Setting Up the Project
7+
# Setting Up the Project
88

99
## Setup
1010

COPYRIGHT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright © 2025 AOSSIE <br />
1+
Copyright © 2026 AOSSIE <br />
22
All rights reserved.
33

44
All works in this repository may be used according to the conditions

README.md

Lines changed: 88 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,75 @@
1-
# PictoPy
2-
3-
PictoPy is an advanced desktop gallery application that combines the power of Tauri, React, and Rust for the frontend with a Python backend for sophisticated image analysis and management.
4-
5-
# Want to Contribute? 😄
1+
<!-- Don't delete it -->
2+
<div name="readme-top"></div>
3+
4+
<p align="center">
5+
<img src="docs/assets/banner.png" alt="PictoPy Banner" width="100%"/>
6+
</p>
7+
8+
<!-- Organization/Project Social Handles -->
9+
<p align="center">
10+
<!-- Telegram -->
11+
<a href="https://t.me/StabilityNexus">
12+
<img src="https://img.shields.io/badge/Telegram-black?style=flat&logo=telegram&logoColor=white&logoSize=auto&color=24A1DE" alt="Telegram Badge"/></a>
13+
&nbsp;&nbsp;
14+
<!-- X (formerly Twitter) -->
15+
<a href="https://x.com/aossie_org">
16+
<img src="https://img.shields.io/twitter/follow/aossie_org" alt="X (formerly Twitter) Badge"/></a>
17+
&nbsp;&nbsp;
18+
<!-- Discord -->
19+
<a href="https://discord.gg/hjUhu33uAn">
20+
<img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" alt="Discord Badge"/></a>
21+
&nbsp;&nbsp;
22+
<!-- Medium -->
23+
<a href="https://news.stability.nexus/">
24+
<img src="https://img.shields.io/badge/Medium-black?style=flat&logo=medium&logoColor=black&logoSize=auto&color=white" alt="Medium Badge"></a>
25+
&nbsp;&nbsp;
26+
<!-- LinkedIn -->
27+
<a href="https://www.linkedin.com/company/aossie/">
28+
<img src="https://img.shields.io/badge/LinkedIn-black?style=flat&logo=LinkedIn&logoColor=white&logoSize=auto&color=0A66C2" alt="LinkedIn Badge"></a>
29+
&nbsp;&nbsp;
30+
<!-- Youtube -->
31+
<a href="https://www.youtube.com/@AOSSIE-Org">
32+
<img src="https://img.shields.io/youtube/channel/subscribers/UCKVVLbawY7Gej_3o2WKsoiA?style=flat&logo=youtube&logoColor=white%20&logoSize=auto&labelColor=FF0000&color=FF0000" alt="Youtube Badge"></a>
33+
</p>
634

7-
&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/hjUhu33uAn"><img src="https://github.com/user-attachments/assets/3ed93273-5055-4532-a524-87a337a4fbba" height="40"></a>
8-
9-
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
10-
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
35+
# PictoPy
1136

12-
# Architecture
37+
**PictoPy is an open-source, privacy-first AI photo management application built for the desktop - featuring on-device face recognition, object detection, and smart search, with zero data leaving your machine.**
1338

14-
### Frontend
39+
PictoPy brings the intelligence of modern AI photo management to your local machine, without the privacy trade-offs of cloud-based alternatives. Built as a fully offline desktop application with Rust, React, and Python, PictoPy automatically groups faces across your library, tags photos with detected objects, and lets you search your pictures with simple words - all powered by state-of-the-art on-device models, without an internet connection or a subscription.
1540

16-
- **Tauri**: Enables building the desktop application
17-
- **React**: Used for creating the user interface
18-
- **Rust**: Powers the backend, which the frontend communicates with through Tauri's API
41+
Find out more at [https://pictopy.aossie.org/](https://pictopy.aossie.org/).
1942

20-
### Backend (Python)
43+
## Features
2144

22-
- **FastAPI**: Serves as the API framework
23-
- **SQLite**: Database for storing metadata and embeddings
24-
- **YOLO**: Used for object detection
25-
- **FaceNet**: Generates face embeddings
26-
- **ONNX Runtime**: Runs the models efficiently
27-
- **DBSCAN**: Performs clustering for face embeddings
45+
**AI-powered**
46+
* Smart tagging based on detected faces and objects
47+
* Advanced image analysis with object detection and facial recognition
48+
* Smart search and retrieval
2849

29-
### Backend (Rust via Tauri)
50+
**Gallery management**
51+
* Album management with traditional gallery features
52+
* Cross-platform compatibility
3053

31-
Handles file system operations and provides a secure bridge between the frontend and local system.
54+
**Privacy & performance**
55+
* Privacy-focused design with fully offline functionality
56+
* Efficient data handling and parallel processing
3257

33-
## Features
58+
## Demonstration
3459

35-
- Smart tagging of photos based on detected objects, faces, and their recognition
36-
- Traditional gallery features of album management
37-
- Advanced image analysis with object detection and facial recognition
38-
- Privacy-focused design with offline functionality
39-
- Efficient data handling and parallel processing
40-
- Smart search and retrieval
41-
- Cross-platform compatibility
60+
<p align="center">
61+
<a href="https://youtu.be/RWp-9xT9jow?si=c1vNO5cDgI4GYM6y">
62+
<img src="docs/assets/demo.png" alt="PictoPy Demonstration">
63+
</a>
64+
</p>
4265

43-
## Technical Stack
66+
## Technology Stack
4467

4568
| Component | Technology |
4669
| ----------------- | -------------------- |
4770
| Frontend | React |
4871
| Desktop Framework | Tauri |
49-
| Rust Backend | Rust |
50-
| Python Backend | Python |
72+
| Backend | Rust, Python |
5173
| Database | SQLite |
5274
| Image Processing | OpenCV, ONNX Runtime |
5375
| Object Detection | YOLOv11 |
@@ -60,6 +82,37 @@ Handles file system operations and provides a secure bridge between the frontend
6082
| Build Tool | Vite |
6183
| Type Checking | TypeScript |
6284

63-
---
85+
## High Level Architecture
86+
87+
<div align="center">
88+
<picture>
89+
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/architectual-design-dark.svg">
90+
<source media="(prefers-color-scheme: light)" srcset="docs/assets/architectual-design-light.svg">
91+
<img src="docs/assets/architectual-design-light.svg" alt="PictoPy architecture diagram">
92+
</picture>
93+
</div>
94+
95+
## Want to Contribute?
96+
97+
<a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" height="30"></a>
98+
99+
1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
100+
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
101+
102+
Don't forget to star this repository if you find it useful! ⭐
64103

65104
Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
105+
106+
107+
## License
108+
109+
This project is licensed under the GNU General Public License v3.0.
110+
See the [LICENSE](LICENSE) file for details.
111+
112+
## Thanks To All Contributors
113+
114+
Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂
115+
116+
[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/PictoPy)](https://github.com/AOSSIE-Org/PictoPy/graphs/contributors)
117+
118+
© 2026 AOSSIE

docs/assets/architectual-design-dark.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/assets/architectual-design-light.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/assets/banner.png

674 KB
Loading

docs/assets/database_architecture.svg

Lines changed: 20 additions & 0 deletions
Loading

docs/assets/demo.png

404 KB
Loading

docs/backend/backend_python/database.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,8 @@
55
PictoPy uses several SQLite databases to manage various aspects of the application. This document provides an overview of each database, its structure, and its primary operations.
66

77
## Database Schema
8+
<p align="center">
9+
<img src="../../assets/database_architecture.svg" alt="PictoPy Banner" width="100%"/>
10+
</p>
811

9-
You can view the interactive DB schema below:
10-
<br>
11-
<br>
12-
13-
<iframe
14-
src="https://dbdiagram.io/e/685704c4f039ec6d364647e1/68701a53f413ba350850acf9"
15-
width="100%"
16-
height="700px"
17-
style="border: 1px solid #ccc; border-radius: 8px;"
18-
loading="lazy"
19-
allowfullscreen>
20-
</iframe>
21-
<br>
22-
23-
Alternatively, [click here to open the DB diagram in a new tab](https://dbdiagram.io/d/PictoPy-685704c4f039ec6d364647e1).
12+
Alternatively, [click here to view the interactive DB schema diagram in a new tab](https://dbdiagram.io/d/PictoPy-685704c4f039ec6d364647e1).

0 commit comments

Comments
 (0)