Merge pull request #19 from NavAbility/release_info

Release info for v0.1.0

Author: GearsAD

.gitignore

@@ -116,3 +116,5 @@ cython_debug/
 
 venv/
 venv_test/
+
+sandbox.py

Makefile

@@ -8,6 +8,13 @@ $(VIRTUAL_ENV_DIR):
 	$(PYTHON_VERSION) -m venv $(VIRTUAL_ENV_DIR)
 	$(VIRTUAL_ENV_DIR)/bin/python setup.py install
 
+release: $(VIRTUAL_ENV_DIR)
+	rm -rf dist
+	$(PYTHON_VERSION) setup.py sdist
+	# Assuming you have twine already in the sdist
+	pip install twine
+	twine upload dist/*
+
 # typically, phony make targets are imperatives.
 lint: install
 	tox -e lint

README.md

@@ -5,10 +5,10 @@ Note that this SDK and the related API are still in development. Please let us k
 
 # Installation
 
-We'll register the package shortly, but for the moment install the NavAbilitySDK directly from the repo:
+Install the NavAbilitySDK using pip:
 
 ```bash
-pip install git+ssh://[email protected]/NavAbility/NavAbilitySDK.py.git
+pip install navabilitysdk
 ```
 
 # Notes and FAQ

setup.cfg

@@ -0,0 +1,3 @@
+# Inside of setup.cfg
+[metadata]
+description-file = README.md

setup.py

@@ -13,14 +13,18 @@
 
 setup(
     name="navabilitysdk",
-    version="0.0.1",
+    version="0.1.0",
+    license="Apache",
     author="NavAbility",
+    author_email="[email protected]",
     package_dir={"": "src"},
     include_package_data=True,
     packages=find_packages("src", exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
-    entry_points={"console_scripts": ["navability = navability.main:cli"]},
+    # entry_points={"console_scripts": ["navability = navability.main:cli"]},
     python_requires=">=3.5",
-    long_description="NavAbility SDK",
+    download_url="https://github.com/NavAbility/NavAbilitySDK.py/archive/refs/tags/v0.1.0.tar.gz",
+    long_description="""NavAbility SDK: Access NavAbility Cloud factor graph features from Python.
+Note that this SDK and the related API are still in development. Please let us know if you have any issues at [email protected].""",
     install_requires=[
         "click>=8.0.0,<9",
         "gql[all]==3.0.0a6",