README.md

Python FTP Cloud

Español

Developers

Mamey 📖

---

Description

A small and lightweight local-network based file storage server (Google Drive-like) made with python3, pyQT5, and pyftplib.

---

Features

• Upload/download/Delete/share files in your local network.
• Can make multiple separated Users.
• Can create up to 2 admin accounts to manage and create users.

---

Requirements

Dependencies:

• Python 3.10+
• ftpdlib
• PyQT5
• Pydantic
• Sqlite3
• Pyside2

Dev dependencies and extras:

• PyQT5 Designer (To edit the front end)
• Mypy (Optional: for debbugging only)

---

Installation

1. Download and install Python 3.10.8
2. Download (or clone) this repository.
3. Once the repository is opened, access to the directory through terminal/cmd.

With poetry:

4. Run poetry install in the repository to install all the dependencies.

Without poetry:

4. Run pip install -U mypy python-dotenv PyQt5 pyside2 pyftpdlib pydantic pywin32.

You would need to install the exact versions that are described in the project.toml

---

Running the Server

From your IDE

• Click on src/server/app.py -> Run

From lastest .exe:

• Get the lastest server release and execute it

Running a user client

From your IDE

• Click on src/client/client.py-> Run

From lastest .exe:

• Get the lastest client release and execute it

---

References

• Requirements (wiki-docs)

---

License

• GPL-3.0 license