Merge branch 'master' into EN-1398-cd-pypi

Author: Aleksandr Salynskii

.gitignore

@@ -16,4 +16,4 @@ _build*
 *.ipynb_checkpoints*
 
 Pipfile*
-dist*
+dist*

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "dxfeed/dxfeed-c-api"]
     path = dxfeed/dxfeed-c-api
-    url = https://github.com/dxFeed/dxfeed-c-api.git
+    url = https://github.com/dxFeed/dxfeed-c-api.git

.readthedocs.yml

@@ -0,0 +1,21 @@
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+submodules:
+  include: all

LICENSE

@@ -370,4 +370,4 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice
 ---------------------------------------------------------
 
   This Source Code Form is "Incompatible With Secondary Licenses", as
-  defined by the Mozilla Public License, v. 2.0.
+  defined by the Mozilla Public License, v. 2.0.

README.md

@@ -1,6 +1,7 @@
 # dxfeed package
 
 ![PyPI](https://img.shields.io/pypi/v/dxfeed)
+[![Documentation Status](https://readthedocs.org/projects/dxfeed/badge/?version=latest)](https://dxfeed.readthedocs.io/en/latest/?badge=latest)
 
 This package provides access to [dxFeed](https://www.dxfeed.com/) streaming data.
 The library is build as a thin wrapper over [dxFeed C-API library](https://github.com/dxFeed/dxfeed-c-api).

build.py

@@ -1,4 +1,4 @@
-from setuptools import setup, Extension, find_packages
+from setuptools import Extension, find_packages
 from setuptools.dist import Distribution
 from pathlib import Path
 import platform
@@ -14,18 +14,19 @@
     ext = ext_pp = 'pyx'
 
 # Get all dxfeed c api c files to be compiled into separate lib
-source_files_directory = Path(__file__).resolve().parent.joinpath('dxfeed', 'dxfeed-c-api', 'src')
+root_path = Path(__file__).resolve().parent
+source_files_directory = root_path / 'dxfeed' / 'dxfeed-c-api' / 'src'
 source_files_paths = [str(path) for path in source_files_directory.glob('*.c')]
 libs = list()
-include_dirs = [str(source_files_directory.parent.joinpath('include')),
+include_dirs = [str(source_files_directory.parent / 'include'),
                 str(source_files_directory)]
-### Build dxfeed c library
+# Build dxfeed c library
 dxfeed_c_lib_args = dict()
 if platform.system() == 'Windows':
-    source_files_paths.remove(str(source_files_directory.joinpath('Linux.c')))
+    source_files_paths.remove(str(source_files_directory / 'Linux.c'))
     libs.append('ws2_32')
 else:
-    source_files_paths.remove(str(source_files_directory.joinpath('Win32.c')))
+    source_files_paths.remove(str(source_files_directory / 'Win32.c'))
 dxfeed_c_lib_args.update({'sources': source_files_paths,
                           'include_dirs': include_dirs})
 
@@ -44,14 +45,13 @@
 if use_cython:
     extensions = cythonize(extensions, language_level=3)
 
-
 def build(setup_kwargs):
     setup_kwargs.update({
         'ext_modules': extensions,
         'zip_safe': False,
         'libraries': [dxfeed_c],
         'packages': find_packages(),
-        'include_dirs': include_dirs,
+        'include_dirs': include_dirs
     })
 
 def build_extensions():

docs/_static/custom.css

@@ -9,4 +9,4 @@
 }
 .current.reference.internal {
     font-weight: bold;
-}
+}

docs/_static/custom.js

@@ -1,3 +1,3 @@
 $(document).ready(function () {
       $('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank');
-});
+});

docs/api.rst

@@ -18,4 +18,4 @@ Utils functions
 	:inherited-members:
 
 .. automodule:: dxfeed.core.utils.data_class
-	:members:
+	:members:

docs/basic_usage.rst

@@ -82,4 +82,4 @@ Same with connection:
 
 .. code-block:: python
 
-    dx.dxf_close_connection(con)
+    dx.dxf_close_connection(con)