Skip to content

Commit 5338340

Browse files
committed
ci: completed setup.py for deploying package to PyPI
1 parent 5cdba08 commit 5338340

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# Lighthouse.py
1+
# Lighthouse Python SDK
22

33
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.
44

55
# Installation
66

77
```
8-
pip install lighthouse.py
8+
pip install lighthouseweb3
99
```
1010

1111
# Usage
1212

1313
### Instantiate the client
1414

1515
```python
16-
from lighthouse import Lighthouse
16+
from lighthouseweb3 import Lighthouse
1717

1818
# use token from env variable LIGHTHOUSE_TOKEN
1919
lh = Lighthouse()
@@ -25,7 +25,7 @@ lh = Lighthouse(token="your_token")
2525
### Uploading a file
2626

2727
```python
28-
from lighthouse import Lighthouse
28+
from lighthouseweb3 import Lighthouse
2929
lh = Lighthouse()
3030
response = lh.deploy("path/to/file")
3131
print(response) # prints a dict containing the cid of the file
@@ -34,7 +34,7 @@ print(response) # prints a dict containing the cid of the file
3434
### Uploading a directory
3535

3636
```python
37-
from lighthouse import Lighthouse
37+
from lighthouseweb3 import Lighthouse
3838
lh = Lighthouse("my-lightouse-token")
3939
response = lh.deploy("path/to/directory")
4040
print(response) # prints a dict containing the root cid of the directory

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
setup(
66
name="lighthouseweb3",
7-
version="0.0.1",
7+
version="0.0.4",
88
description="Lighthouse Python SDK",
99
author="Perfection Loveday",
1010
author_email="perfection@lighthouse.storage",
@@ -29,4 +29,5 @@
2929
long_description=(
3030
(pathlib.Path(__file__).parent.resolve()) / "README.md"
3131
).read_text(encoding="utf-8"),
32+
long_description_content_type="text/markdown",
3233
)

0 commit comments

Comments
 (0)