Publish to PyPi

Author: hschickdevs

README.md

@@ -1,7 +1,7 @@
 <!-- PROJECT HEADER -->
 <div align="center">
-  <a href ="https://homora-v2.alphaventuredao.io/"><img src="img/ahv2.png" alt="Alpha Homora V2 Logo" height="200"></a>
-  <br></br>
+  <a href ="https://homora-v2.alphaventuredao.io/"><img src="https://dappimg.com/media/image/dapp/bd46bacaa4f045d491d2723340590edf.blob" alt="Alpha Homora V2 Logo" height="200"></a>
+  <br/>
   <h2 align="center"><strong>Alpha-Homora-V2-Python</strong></h2>
     <a href="https://homora-v2.alphaventuredao.io/"><img src="https://img.shields.io/website?down_color=red&down_message=Disconnected&label=Alpha%20Homora%20V2&up_color=blue&up_message=Online&url=https%3A%2F%2Fhomora-v2.alphaventuredao.io%2F"/></a>
     <img src="https://img.shields.io/badge/Python-3.9%2B-yellow"/>
@@ -38,14 +38,12 @@ This package is set up to be installed using the `pip` package manager.
 
 1. Ensure that you have Python 3.9+ installed. If not, you can download [here](https://www.python.org/downloads/release/python-3912/). The syntax is dependent on features added in this recent version.
 
-2. Install the package using pip (you must use the git+url as this project is private and not listed on PyPi):
+2. Install the package using pip:
     ```bash
-    pip install --upgrade git+https://github.com/PathX-Projects/Alpha-Homora-V2-Python.git
+    pip install --upgrade alpha-homora-v2
     ```
 
-    ***Note:*** You may need to provide your git credentials depending on the repository privacy settings. In the event, if you need help generating a personal access token see [here](https://catalyst.zoho.com/help/tutorials/githubbot/generate-access-token.html)
-
-3. After install, the package will be available to you in your local Python environment as ***alpha_homora_v2***
+3. After install, the package will be available to you in your local Python environment as ***alpha-homora-v2***
 
 When updates are made to the package, the version will automatically be incremented so that in order to get the newest version on your end, you can simply use the same installation command and your pip will detect and update to the newest version.
 
@@ -70,7 +68,7 @@ How to use the package:
 3. Creating an [AvalanchePosition](alpha_homora_v2/position.py) instance requires the following:
     - Your position ID (an integer)
         - This ID should match your position on Alpha Homora, without the "#"
-          ![demo](img/id_highlight.png)
+          ![demo](https://github.com/PathX-Projects/Alpha-Homora-V2-Python/blob/main/img/id_highlight.png?raw=true)
 
     <!--- DEPRECATED
     - The token symbol/pair (a string)

alpha_homora_v2/__init__.py

@@ -1,4 +1,4 @@
 from .position import AvalanchePosition
 
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 

examples/avalanche/position_info.ipynb

@@ -26,7 +26,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -36,7 +36,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 25,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -45,7 +45,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -54,7 +54,7 @@
        "('0xC9E6e248928aC18eD6b103653cBcF66d23B743C6', None)"
       ]
      },
-     "execution_count": 26,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -157,18 +157,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'totalAPY': 17.11585545697788,\n",
-       " 'tradingFeeAPY': 10.584364627015674,\n",
-       " 'farmingAPY': 6.531490829962204}"
+       "{'APY': 9.824596908196767,\n",
+       " 'tradingFeeAPY': 8.55467361459393,\n",
+       " 'farmingAPY': 6.59739128857244,\n",
+       " 'borrowAPY': -5.327467994969603}"
       ]
      },
-     "execution_count": 15,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }

img/ahv2.png

@@ -6,15 +6,23 @@
 import alpha_homora_v2
 
 
+def readme():
+    with open("README.md") as infile:
+        return infile.read().strip()
+
+
 setup(
-    name='alpha_homora_v2',
+    name='alpha-homora-v2',
     version=alpha_homora_v2.__version__,
     author='Harrison Schick',
     author_email='[email protected]',
     description='An unofficial Python package that wraps Alpha Homora V2 position smart contracts.',
+    long_description=readme(),
+    long_description_content_type="text/markdown",
     url='https://github.com/PathX-Projects/Alpha-Homora-V2-Python',
     license='Apache-2.0',
     packages=['alpha_homora_v2'],
     include_package_data=True,
     install_requires=[line.strip() for line in open('requirements.txt').readlines()],
+    python_requires='>=3.9',
 )