README.md

Lighthouse Python SDK

Lighthouse is a permanent decentralized file storage protocol that allows the ability to pay once and store forever. While traditionally, users need to repeatedly keep track and pay for their storage after every fixed amount of time, Lighthouse manages this for them and makes sure that user files are stored forever. The aim is to move users from a rent-based cost model where they are renting their own files on cloud storage to a permanent ownership model. It is built on top of IPFS, Filecoin, and Polygon. It uses the existing miner network and storage capacity of the filecoin network.

Installation

pip install lighthouseweb3

Usage

Instantiate the client

from lighthouseweb3 import Lighthouse

# use token from env variable LIGHTHOUSE_TOKEN
lh = Lighthouse()

# or you can pass token as parameter
lh = Lighthouse(token="your_token")

Uploading a file

from lighthouseweb3 import Lighthouse
lh = Lighthouse()
response = lh.upload("path/to/file")
print(response) # prints a dict containing the cid of the file

Uploading a directory

from lighthouseweb3 import Lighthouse
lh = Lighthouse("my-lightouse-token")
response = lh.upload("path/to/directory")
print(response) # prints a dict containing the root cid of the directory

Testing

The tests are written with inheritance from the unittest module. To run the tests, run the following command:

pip install -r requirements.txt && python -m unittest discover

or using nose2

pip install -r requirements.txt && python -m nose2