Merge remote-tracking branch 'origin/master' into development

Author: eegemberdiev

.gitlab-ci.yml

@@ -24,9 +24,9 @@ unit-tests:
 ###################
 build-package:
   stage: build
-  variables:
-    VERSION: build
   script:
+    - VERSION=$(echo ${CI_COMMIT_REF_NAME} | sed "s/v//")
+    - export VERSION=$VERSION
     - envsubst '${VERSION}' < setup.py > setup.py.new
     - mv setup.py.new setup.py
     - python3 setup.py sdist bdist_wheel

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2018-07-31
+### Added
+- Get all scaffolds API
+- Get scaffold API
+- Deploy scaffold API
+- Set scaffold webhook API
+- Get scaffold summary API
+- Deactivate scaffold API
+- Get scaffold quota API
+- Add shareholder API
+- Update shareholder API
+- Remove shareholder API
+- Get all transactions API
+- Tests
+
+[1.0.0]: https://github.com/OpenFuturePlatform/open-api-python-sdk/compare/e8d583f41e071d56dbc6dcf924bcc3a35c85b302...v1.0.0

README.md

@@ -1,6 +1,6 @@
 # open-api-sdk
 
-A library for interactions with Open Platform.
+Open-api-sdk is a library for interaction with Open Platform.
 
 ## Content
 
@@ -21,22 +21,22 @@ $ pip install open-api-sdk
 ## Get started
 OPEN Platform uses OpenKeys to allow access to the API. You can register a new OpenKey at your [Account.](https://api.openfuture.io/ "Open API")
 
-OPEN Platform expects for the OpenKey to be included in all API requests to the server in a header.
+OPEN Platform expects the OpenKey to be included in all API requests to the server in a header.
 
-We assume you have an open_key by this moment. 
+We assume that you have the OpenKey by this moment. 
 
-To access the library import the OpenPlatform class and call an instance of it with open key as followed: 
+To access the library import an OpenPlatform class and call an instance with the OpenKey as following: 
 
 
 ```python
 from openplatform import OpenPlatform
 
-# Access api via instance of OpenPlatform class
+# Access API via instance of OpenPlatform class
 op = OpenPlatform(open_key)
 ```
 `open_key` - your open key. 
 
-In the following examples it is assumed the `op` is the result of instantiating the `OpenPlatform` class with `open_key`
+In the following examples, it is assumed that `op` is a result of instantiating the `OpenPlatform` class with the `open_key`
 
 ### API