TpLinkFirmwareDirectory

Python utility to list and export all firmware and app files from the public TP-Link S3 bucket.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

TpLinkFirmwareDirectory is a Python utility that lists and exports all available firmware and app files from the public TP-Link S3 bucket (download.tplinkcloud.com). It is useful for researchers, developers, and users who want to audit, archive, or analyze TP-Link firmware and app releases.

The main script, list_s3_files.py, connects to the S3 bucket (with anonymous access), paginates through all objects, and writes the full list of keys to all_keys.txt.

(back to top)

Built With

• Python 3.13+
• boto3
• botocore

(back to top)

Getting Started

Follow these steps to set up and run the project locally.

Prerequisites

• Python 3.13 or newer
• pip (Python package manager)

Installation

1. Clone the repository:

   git clone https://github.com/LoveDoLove/TpLinkFirmwareDirectory.git
   cd TpLinkFirmwareDirectory

2. Install dependencies:

   pip install -r requirements.txt

   Or, if using Poetry:

   pip install poetry
   poetry install

(back to top)

Usage

To list all files in the TP-Link public S3 bucket and export them to all_keys.txt:

python list_s3_files.py

• The output file all_keys.txt will contain one key per line, representing each file in the bucket.
• You can use this file for further analysis, archiving, or automation.

(back to top)

Roadmap

• List all files in TP-Link public S3 bucket
• Add filtering by file type or prefix
• Export metadata (size, last modified, etc.)
• Add CLI options for custom buckets
• Add tests and CI

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

For bug reports and feature requests, use the provided GitHub issue templates.

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

LoveDoLove - GitHub

Project Link: https://github.com/LoveDoLove/TpLinkFirmwareDirectory

(back to top)

Acknowledgments

• boto3
• botocore
• Best-README-Template

(back to top)