Update README.md and setup.py for Python modules [ECR-3992] (#1296)

* Prepare python modules for release

Fix Readme with recent changes in docs
Fix setup.py

* Update version in setup.py

Author: Ilya Bogdanov

exonum-java-binding/exonum_launcher_java_plugins/README.md

@@ -6,10 +6,18 @@
 
 ## Installation
 
-#### Requirements
+### Requirements
 
 - [Python3](https://www.python.org/downloads/)
 
+### Using PyPI
+
+```bash
+pip3 install exonum-launcher-java-plugins
+```
+
+### From Source
+
 ```bash
 # Generate sources
 source ./tests_profile
@@ -20,122 +28,9 @@ python3 -m pip install -e exonum_launcher_java_plugins
 
 ## Usage
 
-TODO: Move the entire section to the EJB App tutorial.
-
-To deploy and start a specific list of services, use the following command with the
-prepared `config.yml` file:
-
-```bash
-python3 -m exonum_launcher -i config.yml
-```
-
-### Writing Configuration File
-
-Start with specifying IP addresses of the blockchain nodes:
-
-```yaml
-networks:
-  - host: "127.0.0.1"
-    ssl: false
-    public-api-port: 8080
-    private-api-port: 8081
-```
-
-You need to specify every node for which you have an access to its private API port. If you
-do not have an access to every node in the network, the administrators of other nodes must
-run `exonum-launcher` with the same configuration file (with a different list of available nodes).
-
-Deadline height describes the maximum blockchain height for the deployment process. Make sure to
-specify the value larger than the current blockchain height.
-
-```yaml
-deadline_height: 20000
-```
-
-Enable Java runtime by specifying its identifier (`1`). Rust runtime is enabled by default:
-
-```yaml
-runtimes:
-  java: 1
-```
-
-Add artifacts you want to deploy. For each artifact, you need to specify its name alias
-(as YAML key) and its runtime (using `runtime` field). Name aliases are used in other parts
-of configuration for readability and easier refactoring. Java artifacts also need name of the
-`jar` file in the `spec: artifact_filename` field. In our example we add the Java
-`cryptocurrency-demo` service, and two Rust services - the `timestamping` and `time` oracle services.
-
-```yaml
-artifacts:
-  cryptocurrency:
-    runtime: java
-    name: "com.exonum.examples:cryptocurrency:0.10.0-SNAPSHOT"
-    spec:
-      artifact_filename: "exonum-java-binding-cryptocurrency-demo-0.10.0-SNAPSHOT-artifact.jar"
-  time:
-    runtime: rust
-    name: "exonum-time:0.13.0-rc.2"
-  timestamping:
-    runtime: rust
-    name: "exonum-timestamping:0.13.0-rc.2"
-```
-
-Add a `plugins` section to enable both Java Runtime plugin and Instance Configuration plugin.
-Runtime plugin is enabled for a specific runtime (`java` in our example), while Instance
-Configuration plugin is enabled for a specific artifact name alias (`timestamping` in our example).
-
-```yaml
-plugins:
-  runtime:
-    java: "exonum_java_runtime_plugin.JavaDeploySpecLoader"
-  artifact:
-    timestamping: "exonum_instance_configuration_plugin.InstanceSpecLoader"
-```
-
-In our example we will use the Instance Configuration plugin to serialize initial configuration parameters of
-the `timestamping` service in Protobuf. We need to take a `service.proto` file with the message
-description from the service sources and place it inside some known directory.
-
-  ```proto
-  syntax = "proto3";
-  
-  package exonum.examples.timestamping;
-  
-  message Config {
-      string time_service_name = 1;
-  }
-  ```
-
-Finally, add an `instances` section that describes the list of service instances you want to
-start in the blockchain. For each instance you need to specify its artifact name alias.
-Instance Configuration plugin also requires a list of additional parameters, which we
-provide for the `timestamping` instance:
-
-- `sources`. Points to a directory with the Protobuf sources of the service configuration 
-message. We use the `proto_sources` directory.
-- `config_message_source`. A file name where the `message_name` message 
-is located. In our example we use the `service.proto` file.
-- `message_name`. A name of the Protobuf message used to represent the service configuration.
-  Optional, defaults to `Config`.
-- `data`. Your actual configuration in the format corresponding to the `message_name` message.
-
-```yaml
-instances:
-  cryptocurrency:
-    artifact: cryptocurrency
-  time:
-    artifact: time
-  timestamping:
-    artifact: timestamping
-    config:
-      sources: "proto_sources"
-      config_message_source: "service.proto"
-      message_name: "Config"
-      data:
-        time_service_name: "time"
-```
+See [Deploy and Start the Service][deploy-and-start].
 
-See [sample-config.yml](sample-config.yml) for the final state of the configuration file.
+[deploy-and-start]: https://exonum.com/doc/version/0.13-rc.2/get-started/java-binding/#deploy-and-start-the-service
 
 # License
 

exonum-java-binding/exonum_launcher_java_plugins/setup.py

@@ -14,18 +14,35 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from distutils.core import setup
+import setuptools
 
-install_requires = ["exonum-launcher"]
+INSTALL_REQUIRES = ["exonum-launcher"]
 
-python_requires = ">=3.6"
+PYTHON_REQUIRES = ">=3.6"
 
-setup(
+with open("README.md", "r") as readme:
+    LONG_DESCRIPTION = readme.read()
+
+setuptools.setup(
     name="exonum_launcher_java_plugins",
     version="0.10.0-SNAPSHOT",
-    description="Exonum Java plugins for exonum_launcher",
+    author="The Exonum team",
+    author_email="contact@exonum.com",
+    description="Exonum Java plugins for exonum-launcher",
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type="text/markdown",
     url="https://github.com/exonum/exonum-java-binding",
-    packages=["exonum_java_runtime_plugin", "exonum_instance_configuration_plugin"],
-    install_requires=install_requires,
-    python_requires=python_requires,
+    packages=[
+        "exonum_java_runtime_plugin",
+        "exonum_java_runtime_plugin.proto",
+        "exonum_instance_configuration_plugin",
+    ],
+    install_requires=INSTALL_REQUIRES,
+    python_requires=PYTHON_REQUIRES,
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        "Topic :: Security :: Cryptography",
+    ],
 )