Merge pull request #13 add setup.py adn fix imports

Author: Mec-iS

README.md

@@ -1,6 +1,32 @@
 # hydra-python-core
 This library provides the core functions to implement Hydra Official Specification in Python.
 
+Currently the library mainly consists of 2 modules `doc_writer` and `doc_maker` which help hydrus generalise a lot of things.
 
-*Porting out from hydrus the hydraspecs directory*
+-> `doc_writer` creates a new API Documentation as well as a `HydraDoc` object while,
+-> `doc_maker` uses an existing API Documentation to create a `HydraDoc` object c`
+
+
+
+### Installation
+
+To install the library:
+
+```bash
+pip install git+https://github.com/HTTP-APIs/hydra-python-core.git#egg=hydra_python_core
+```
+
+**Note :-** If using hydrus, the library doesn't need to be installed separately as it is already a part of `requirements.txt` for hydrus.
 
+
+
+### Usage
+
+To import the modules:
+
+```python
+from hydra_python_core import doc_writer
+from hydra_python_core import doc_maker
+```
+
+*Porting out from hydrus the hydraspecs directory*

hydra_python_core/doc_maker.py

@@ -1,14 +1,14 @@
-'''Contsructor to take a Python dict containing an API Documentation and
-create a HydraDoc object for it'''
+"""Contsructor to take a Python dict containing an API Documentation and
+create a HydraDoc object for it
+"""
 import re
 import json
-from hydrus.samples.doc_writer_sample import api_doc as sample_document
-from hydrus.hydraspec.doc_writer import HydraDoc, HydraClass, HydraClassProp, HydraClassOp
-from hydrus.hydraspec.doc_writer import HydraStatus
+from hydra_python_core.doc_writer import HydraDoc, HydraClass, HydraClassProp, HydraClassOp
+from hydra_python_core.doc_writer import HydraStatus
 from typing import Any, Dict, Match, Optional, Tuple, Union
 
 
-def error_mapping(body: str = None) -> str:
+def error_mapping(body: str=None) -> str:
     """Function returns starting error message based on its body type.
     :param body: Params type for error message
     :return string: Error message for input key
@@ -357,8 +357,3 @@ def create_status(possible_status: Dict[str, Any]) -> HydraStatus:
     status = HydraStatus(result["statusCode"],
                          result["title"], result["description"])
     return status
-
-
-if __name__ == "__main__":
-    api_doc = create_doc(sample_document.generate())
-    print(json.dumps(api_doc.generate(), indent=4, sort_keys=True))

samples/__init__.py

@@ -0,0 +1,5 @@
+import json
+
+if __name__ == "__main__":
+    api_doc = create_doc(sample_document.generate())
+    print(json.dumps(api_doc.generate(), indent=4, sort_keys=True))

samples/cli.py

@@ -1,6 +1,6 @@
 """Sample to create Hydra APIDocumentation using doc_writer."""
 
-from hydrus.hydraspec.doc_writer import HydraDoc, HydraClass, HydraClassProp, HydraClassOp
+from hydra_python_core.doc_writer import HydraDoc, HydraClass, HydraClassProp, HydraClassOp
 from typing import Any, Dict, Union
 
 # Creating the HydraDoc object, this is the primary class for the Doc

samples/doc_writer_sample.py

@@ -0,0 +1,13 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='hydra_python_core',
+    version='0.1',
+    packages=find_packages(),
+    license='MIT',
+    description='Core functions for Hydrus',
+    long_description=open('README.md').read(),
+    long_description_content_type="text/markdown",
+    url='https://github.com/HTTP-APIs/hydra-python-core',
+    zip_safe=False
+)