66731e2fc1
Refactored the CLI to modularize argument parsing, logging, and output, and improved error handling and progress reporting. The client now uses dataclasses for file metadata, introduces custom exception classes, and provides a more robust upload interface supporting both file paths and file-like objects. Utilities were updated for clarity and type safety.
GofilePy
A Python library and CLI tool for Gofile.io. It supports the free API tiers, streaming uploads (low memory usage for large files), and script-friendly JSON output.
Features
- Streaming Uploads: Upload 100GB+ files without loading them into RAM.
- Folder Management: Upload to specific folders or create new ones automatically.
- Script Ready: JSON output mode for easy parsing in pipelines.
- Free Tier Support: Handles Guest accounts and Standard tokens.
- Progress Bar: Visual feedback for long uploads.
Installation
From Source
- Clone the repository:
git clone https://github.com/garnajee/gofilepy.git && cd gofilepy
- Install via uv:
uv sync
- Running the CLI
uv run gofilepy --help
- (Optional) Install the package in your environment
uv pip install .
Usage (CLI)
Basic Upload
Upload a single file. A new public folder will be created automatically if you don't provide one.
gofilepy video.mp4
Upload with Token
Export your token (Get it from your Gofile Profile) to access your account storage.
export GOFILE_TOKEN="your_token_here"
gofilepy my_file.zip
Upload to a Specific Folder
If you have an existing folder ID:
gofilepy -f "folder-uuid-123" image.png
Group Upload (Single Folder)
Upload multiple files. The first file creates a folder, and the rest are uploaded into it.
gofilepy -s part1.rar part2.rar part3.rar
Scripting Mode (JSON Output)
Use --json to suppress human-readable text and output a JSON array.
gofilepy --json file.txt
# Output: [{"file": "file.txt", "status": "success", "downloadPage": "...", ...}]
Verbose Mode
Debug connection issues or API responses.
gofilepy -vv big_file.iso
Usage (Library)
You can use gofilepy in your own Python scripts.
from gofilepy import GofileClient
client = GofileClient()
# client = GofileClient(token="YOUR_TOKEN_HERE") # Optional token for private uploads
file = client.upload(file=open("./test.py", "rb"))
print(file.name)
print(file.page_link) # View and download file at this link
Development
For contributors and developers:
- Install with development dependencies:
uv sync --extra dev
- Run pylint to check code quality:
uv run pylint src/gofilepy
- Install in editable mode for development:
uv pip install -e .
Building for Release
To build a .whl (Wheel) file and a source distribution:
- Install build tools:
pip install build - Run build:
python -m build - Artifacts will be in
dist/.
License
This project is licensed under the MIT License.