rename package name to substreams and update README

Author: rysuds

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -5,7 +5,7 @@ WIP Python Interface for querying via substreams
 1. Install the package:
 
 ```curl
-pip3 install git+ssh://git@github.com/messari/substreams-python
+pip3 install substreams
 ```
 2. Generate a StreamingFast API Token
     - Can do so via this [link](https://substreams.streamingfast.io/reference-and-specs/authentication)
@@ -24,7 +24,7 @@ pip3 install git+ssh://git@github.com/messari/substreams-python
 ### Instantiation
 First import the `Substream` object and pass in the path to your `.spkg` file
 ```python
-from substreams_python import Substream
+from substreams import Substream
 
 sb = Substream("substreams-uniswap-v2-v0.1.0.spkg")
 ```

demo.ipynb

@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from substreams_python import Substream"
+    "from substreams import Substream"
    ]
   },
   {

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "substreams-python"
+name = "substreams"
 version = "0.0.1"
 authors = [
   { name="Ryan Sudhakaran", email="ryan.sudhakaran@messari.io" },

setup.py

@@ -1,7 +1,20 @@
 from setuptools import setup
 
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
 setup(
-    name="substreams-python",
+    name="substreams",
     version="0.0.1",
-    packages=[".substreams_python"],
+    packages=[".substreams"],
+    author="Ryan Sudhakaran",
+    author_email="ryan.sudhakaran@messari.io",
+    description="Light Python wrapper for consuming Substreams",
+    url="https://github.com/messari/substreams-python",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.10",
 )