Updated README.md

Author: sabuhish

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to OPA-python-client
+
+We welcome contributions to [OPA-python-client](https://github.com/Turall/OPA-python-client)
+
+## Issues
+
+Feel free to submit issues and enhancement requests.
+
+[OPA-python-client Issues](https://github.com/Turall/OPA-python-client/issues)
+
+## Contributing
+
+Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
+
+1.  **Fork** the repo on GitHub
+2.  **Clone** the project to your own machine
+3.  **Commit** changes to your own branch
+4.  **Push** your work
+5.  Submit a **Pull request** so that we can review your changes
+
+
+## Testing
+```sh
+$ docker run -it --rm -p 8181:8181 openpolicyagent/opa run --server --addr :8181
+$ pytest
+```
+
+NOTE: Be sure to merge the latest from "upstream" before making a pull request!

README.md

@@ -13,13 +13,19 @@ See offical documentation page [Open Policy Agent](https://www.openpolicyagent.o
 ### Installation ###
 
 ```sh
- $ pip install OPA-python-client
+$ pip install OPA-python-client
 ```
 
+Alternatively, if you prefer to use `poetry` for package dependencies:
+
+```bash
+$ poetry shell
+$ poetry add OPA-python-client
+```
 
 
 
-## Usage Examples ##
+## Usage Examples 
 
 ```python
 >>> from opa_client.opa import OpaClient
@@ -52,7 +58,7 @@ True
 ```
 
 
-### Connection to OPA service ###
+### Connection to OPA service
 
 ```python
 from opa_client.opa import OpaClient
@@ -66,10 +72,9 @@ del client
 ```
 
 
-### Connection to OPA service with SSL ###
+### Connection to OPA service with SSL
 
 ```python
-
 from opa_client.opa import OpaClient
 
 
@@ -87,9 +92,7 @@ del client
 ```
 
 
-
-
-### Update policy from rego file ###
+### Update policy from rego file
 
 ```python
 from opa_client.opa import OpaClient
@@ -104,10 +107,9 @@ del client
 ```
 
 
-### Update policy from URL ###
+### Update policy from URL
 
 ```python
-
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -121,12 +123,10 @@ del client
 ```
 
 
-### Delete policy ###
+### Delete policy
 
 
 ```python
-
-
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -138,12 +138,10 @@ client.get_policies_list() # response is []
 del client
 ```
 
-### Get raw data from OPA service ###
+### Get raw data from OPA service
 
 
 ```python
-
-
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -164,12 +162,11 @@ print(client.get_opa_raw_data("userinfo",query_params={"metrics": True}))
 del client
 ```
 
-### Save policy to file from OPA service ###
-
 
-```python
+### Save policy to file from OPA service
 
 
+```python
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -179,12 +176,11 @@ client.opa_policy_to_file(policy_name="fromurl",path="/your/path",filename="exam
 del client
 ```
 
-### Delete data from OPA service ###
-
 
-```python
+### Delete data from OPA service
 
 
+```python
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -195,12 +191,10 @@ del client
 ```
 
 
-### Information about policy path and rules ###
+### Information about policy path and rules
 
 
 ```python
-
-
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -213,12 +207,10 @@ del client
 ```
 
 
-### Check permissions ###
+### Check permissions
 
 
 ```python
-
-
 from opa_client.opa import OpaClient
 
 client = OpaClient() 
@@ -255,7 +247,6 @@ hello {
 
 check_data = {"message": "world"}
 client.check_policy_rule(input_data=check_data, package_path="play", rule_name="hello") # response {'result': True}
-
 ```
 
 ### Execute an Ad-hoc Query
@@ -291,7 +282,6 @@ print(client.ad_hoc_query(query_params={"q": "data.userinfo.user_roles[name]"}))
 #you can send body request
 print(client.ad_hoc_query(body={"query": "data.userinfo.user_roles[name] "})) 
 # response is {'result': [{'name': 'eve'}, {'name': 'alice'}, {'name': 'bob'}]}
-
 ```
 
 ### Check OPA healthy. If you want check bundels or plugins, add query params for this.
@@ -306,12 +296,14 @@ print(client.check_health({"bundle": True})) # response is  True or False
 # If your diagnostic url different than default url, you can provide it.
 print(client.check_health(diagnostic_url="http://localhost:8282/health"))  # response is  True or False
 print(client.check_health(query={"bundle": True}, diagnostic_url="http://localhost:8282/health"))  # response is  True or False
-
 ```
 
 
-# Contributing #
+# Contributing
+
+Fell free to open issue and send pull request.
 
-#### Free to open issue and send PR ####
+Thanks To [Contributors](https://github.com/Turall/OPA-python-client/graphs/contributors).
+Contributions of any kind are welcome!
 
-### OPA-python-client  supports Python >= 3.5
+Before you start please read [CONTRIBUTING](https://github.com/Turall/OPA-python-client/blob/master/CONTRIBUTING.md)