Upload file to IPFS using Python

What is IPFS?

IPFS stands for InterPlanetary File System, and it is a breakthrough system that aims to transform the way we store and distribute data on the internet. Unlike standard web protocols like HTTP, which rely on centralized servers, IPFS operates on a decentralized peer-to-peer network.

Here are some important things concerning IPFS

1. Decentralisation: IPFS offers a distributed system in which files are kept on numerous nodes, similar to how torrents function. This decentralized method boosts resilience while reducing reliance on single points of failure.
2. Content Addressed: Instead of utilizing location-based addresses such as URLs, IPFS uses content-based addressing. Each piece of content is given a unique hash, rendering it immutable and tamper-proof.
3. Versioning and Deduplication: IPFS effectively stores file versions by deduplicating identical material, which reduces redundancy and saves storage space.
4. Peer-to-Peer Sharing: Users can exchange files directly without using a central server. This improves privacy, accelerates data transit, and reduces bandwidth costs.
5. Caching and Distribution: IPFS nodes cache popular material, increasing access speed while minimizing the pressure on original producers.
6. Blockchain Integration: IPFS may be used with blockchain technology to provide a strong framework for decentralized apps (dApps), content distribution networks (CDNs), and other uses.

Why to use Python with IPFS?

Python and IPFS are a great mix for various reasons.

1. Ease of Use: Python is noted for its simplicity and readability, making it suitable for developers of all levels. Integrating IPFS functionality into Python scripts is simple, allowing developers to reap the benefits of IPFS without a steep learning curve.
2. Rich Ecosystem: Python has a large ecosystem of libraries and frameworks, giving developers a variety of tools to improve their IPFS integration. Libraries like 'py-ipfs-http-client' and 'ipfsapi' make it easier to communicate with IPFS nodes, such as file uploads, retrievals, and content addressing.
3. Community Support: Both Python and IPFS have robust communities that actively participate in their development and upkeep. This implies that developers working with Python and IPFS will have access to a wealth of tools, documentation, and community assistance, making troubleshooting and learning easier.
4. Cross-Platform Compatibility: Because Python is cross-platform, IPFS apps written in Python will work effortlessly on a variety of operating systems, including Windows, macOS, and Linux. This adaptability increases the accessibility and deployment choices for IPFS-powered projects.
5. Scalability and Performance: Python's performance, particularly when paired with optimized IPFS modules, can fulfill the scalability requirements of a wide range of applications. Whether managing modest file uploads or large-scale data distribution, Python's efficiency and IPFS's decentralized design provide strong performance.
6. Integration with Web Technologies: Python's flexibility extends to web development, allowing developers to quickly include IPFS functionality into online applications. This connection enables the development of decentralized web platforms, content-sharing networks, and blockchain-based apps that use IPFS as their backbone.

Uploading Files with Python

To get started, follow the steps from https://docs.ipfs.tech/install/ipfs-desktop/ to install IPFS on your PC.

from django.http import HttpResponse
from django.shortcuts import render
import requests

Import the required files.

IPFS_API_URL = 'http://localhost:5001/api/v0'  # Adjust the IP and port as per your IPFS setup

The above code sets the value of the IPFS API URL i.e. the URL and Port at which IPFS is running.

def upload_file_to_ipfs(file_path):
    files = {'file': open(file_path, 'rb')}
    response = requests.post(f'{IPFS_API_URL}/add', files=files)
    ipfs_hash = response.json()['Hash']
    return ipfs_hash

The above code is the code that uploads the file to IPFS.

The following code

response = requests.post(f'{IPFS_API_URL}/add', files=files)

is used to send the file to add an endpoint, to upload the file to IPFS.

ipfs_hash = response.json()['Hash']

Above code is used to get the hash of the result, this is the IPFS CID, which when added to the IPFS fetch URL results into the actual resource.

def upload_file(request):
    if request.method == 'POST' and request.FILES['static/images/file']:
        uploaded_file = request.FILES['static/images/file']
        file_name = uploaded_file.name
        file_path = 'static' / 'images' / file_name
        
        # Save the uploaded file to a temporary location
        with open(file_path, 'wb+') as destination:
            for chunk in uploaded_file.chunks():
                destination.write(chunk)
        
        # Upload the file to IPFS using IPFS HTTP API
        ipfs_hash = upload_file_to_ipfs(file_path)
        
        return HttpResponse(f'File uploaded to IPFS with hash: {ipfs_hash}')
    return render(request, 'upload.html')

The above code is used to read the file uploaded by the user, which is saved inside the custom path, and then call the upload_file_to_ipfs() to get the CID. In my case, the path is "static/images/file".

<!-- upload.html -->
<form method="post" enctype="multipart/form-data">
    {% csrf_token %}
    <input type="file" name="static/images/file">
    <button type="submit">Upload</button>
</form>

The above code is used to take a file as input and return the IPFS CID.

Benefits of IPFS Integration

Integrating IPFS (InterPlanetary File System) into your projects has several advantages that can improve many elements of data storage, sharing, and decentralized applications. Here are some major advantages of IPFS integration:

1. Decentralization and Data Redundancy: IPFS distributes files over a network of nodes, decentralizing data storage. This strategy increases data redundancy and fault tolerance, lowering the risk of data loss caused by server failures or centralized outages.
2. Immutable and Tamper-Proof material: IPFS identifies each piece of material with a unique cryptographic hash. This hash acts as an immutable identifier, guaranteeing that the information is tamper-proof and verifiable. It improves data integrity and trustworthiness, which are crucial in applications that require safe data storage.
3. Content-Based Addressing and Versioning: - IPFS employs content-based addressing, where the material is identified by its hash rather than location. This allows for effective file versioning and deduplication of identical material, saving storage space and bandwidth.
4. Efficient File Sharing and Distribution: IPFS enables peer-to-peer file sharing and direct content retrieval from other nodes. This decentralized strategy accelerates information delivery, minimizes dependency on centralized servers, and cuts bandwidth costs.
5. IPFS offers enhanced privacy and security by allowing users to store and exchange files peer-to-peer, giving them greater control over their data. This improves privacy by limiting data exposure to intermediaries and other parties. Additionally, IPFS allows encryption, which improves data security.
6. Global Accessibility and Resilience: IPFS nodes may be spread internationally, enhancing content accessibility for users in various areas. This worldwide accessibility improves the robustness of data distribution networks by reducing latency and assuring content availability even during network failures.
7. IPFS integrates perfectly with blockchain technology, allowing for safe data storage in decentralized applications (dApps). This connection improves the interoperability and functionality of blockchain-based solutions.
8. IPFS optimizes scalability and performance by enabling concurrent content retrieval and caching for large-scale data dissemination. Applications may manage rising workloads and user demands more effectively by utilizing IPFS's distributed design.

Conclusion

Empower your data storage strategy with IPFS and Python, paving the way for a decentralized, resilient, and scalable future. Start uploading your files with ease today!

I have attached the code, please feel free to download.