Skip to content

Commit cbcca31

Browse files
Merge pull request #32 from ibm-hyperknowledge/main
Prepared setup.py to publication.
2 parents 76751cc + 6763c8c commit cbcca31

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
# hkpy: a Python Framework for Hyperknowledge
1+
# HKPy: a Python Framework for Hyperknowledge
22

33
## Getting Started
44

5+
### Install
6+
7+
To use HKPy in your project, you can install using:
8+
```
9+
pip install hkpy
10+
```
11+
512
### Connecting to a [Hyperknowledge Base](#)
613

714
```

setup.py

+10-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import setuptools
99
from setuptools import setup, find_packages
1010

11+
1112
def find_recursive_packages(root):
1213
def _isdir(f):
1314
return os.path.isdir(f) and '__pycache__' not in f
@@ -17,10 +18,11 @@ def _isdir(f):
1718
dirs += find_recursive_packages(dir_)
1819

1920
return [dir_.replace('/', '.') for dir_ in dirs]
20-
21+
22+
2123
NAME = 'hkpy'
2224
VERSION = open('version.txt', 'r').read().strip()
23-
URL = 'https://github.ibm.com/hyperknowledge-wg/HKpy'
25+
URL = 'https://github.com/ibm-hyperknowledge/hkpy'
2426
DESCRIPTION = 'A Python module to create software abstraction for accessing hyperknowledge graphs'
2527
LONG_DESCRIPTION = None
2628
AUTHOR = 'IBM Research Brazil'
@@ -33,7 +35,10 @@ def _isdir(f):
3335
'Flask',
3436
'flask-cors',
3537
'PyJWT',
36-
'urllib3'
38+
'urllib3',
39+
'idna',
40+
'chardet',
41+
'certifi'
3742
]
3843

3944
try:
@@ -48,8 +53,10 @@ def _isdir(f):
4853
url=URL,
4954
description=DESCRIPTION,
5055
long_description=LONG_DESCRIPTION,
56+
long_description_content_type="text/markdown",
5157
author=AUTHOR,
5258
author_email=AUTHOR_EMAIL,
59+
license="MIT",
5360
keywords=KEYWORDS,
5461
python_requires=REQUIRES_PYTHON,
5562
packages=setuptools.find_packages(),

0 commit comments

Comments
 (0)