minor updates to docs, prepare for push to pypi

README.md

@@ -18,19 +18,8 @@ The library is built specifically for converting data into a [neo4j](https://neo
 This library has been developed at the [Chair of Systems Design at ETH Zürich](https://www.sg.ethz.ch).
 
 ## Installation
-If you have setup a private ssh key for your github, copy-paste the command below to install the latest version ([v1.3.3][latest_tag]):
 ```
-pip install git+ssh://[email protected]/jkminder/[email protected]
-```
-
-If you don't have ssh set up, download the latest wheel [here][latest_wheel] and install the wheel with:
-```
-pip install **path-to-wheel**
-```
-
-If you have cloned the repository you can also build it locally with
-```
-pip install **path-to-repository**
+pip install data2neo
 ```
 The Data2Neo library supports Python 3.8+.
 
@@ -94,7 +83,4 @@ converter()
 # Known issues
 If you encounter a bug or an unexplainable behavior, please check the [known issues](https://github.com/jkminder/Data2Neo/labels/bug) list. If your issue is not found, submit a new one.
 
-[latest_version]: v1.3.3
-[latest_tag]: https://github.com/jkminder/data2neo/releases/tag/v1.3.3
-[latest_wheel]: https://github.com/jkminder/data2neo/releases/download/v1.3.3/Data2Neo-1.3.3-py3-none-any.whl
-[wiki]: https://Data2Neo.jkminder.ch/index.html
+[wiki]: https://data2neo.jkminder.ch/index.html

docs/source/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to **data2neo**'s documentation!
+Welcome to **Data2Neo**'s documentation!
 =========================================
 
 **Data2Neo** is a library that simplifies the conversion of data in relational format 

docs/source/installation.rst

@@ -3,22 +3,10 @@
 Installation
 =============
 
-To install the software, follow these steps:
+Install the package using pip:
 
-1. Clone the repository:
+.. code-block:: bash
 
-    .. code-block:: bash
+    pip install data2neo
 
-        git clone [email protected]:sg-dev/data2neo.git
-
-2. Change to the project directory:
-
-    .. code-block:: bash
-
-        cd data2neo
-
-3. Install the library:
-
-    .. code-block:: bash
-
-        pip install .
+    

docs/source/quick_start.rst

@@ -66,7 +66,7 @@ We can define a function, CONVERTCURRENCY, to standardise these values into a si
 
 .. code-block:: python
 
-    from Data2Neo import register_attribute_postprocessor, Attribute
+    from data2neo import register_attribute_postprocessor, Attribute
 
     @register_attribute_postprocessor
     def CONVERTCURRENCY(attribute, currency):

setup.py

@@ -6,15 +6,20 @@
     'neo4j>=5.11.0'
 ]
 
+long_desc = open('README.md').read()
+# replace local links
+long_desc = long_desc.replace('docs/source/assets/images/data2neo_banner.png', 'https://github.com/jkminder/data2neo/blob/main/docs/source/assets/images/data2neo_banner.png?raw=true')
+
 setup(
     name = "data2neo", 
     packages = find_packages(),
-    version = "1.4.0",
+    version = "1.4.3",
     description = "Library for converting relational data into graph data (neo4j)",
     author = "Julian Minder",
     author_email = "[email protected]",   
     url = "https://github.com/jkminder/data2neo",    
     install_requires = requirements,
-    python_requires = ">=3.8"
-)
-
+    python_requires = ">=3.8",
+    long_description=long_desc,
+    long_description_content_type='text/markdown'
+)