Merge pull request #3 from dxFeed/EN-1335-correct-samples-and-doc

En 1335 correct samples and doc

Author: Aleksandr Salynskii

README.md

@@ -4,16 +4,16 @@ This library provides Python API to dxfeed via C API. The code is written in Pyt
 
 ## Installation
 
-**Requirements:** python >3.6, cython, pandas
+**Requirements:** python >3.6, pandas
 
 ```python
-pip3 install cython pandas
+pip3 install pandas
 ```
 
-Install package itself
+Install package via PyPI
 
 ```python
-pip3 install dxpyfeed-x.x.x.tar.gz
+pip3 install dxfeed
 ``` 
 
 ## Basic usage
@@ -41,18 +41,18 @@ sub2 = dx.dxf_create_subscription(con, 'Quote')
 'Trade', 'Quote', 'Summary', 'Profile', 'Order', 'TimeAndSale', 'Candle', 'TradeETH', 'SpreadOrder',
 'Greeks', 'TheoPrice', 'Underlying', 'Series', 'Configuration' event types are supported.
 
-**Add tickers you want to get data for**:
-```python
-dx.dxf_add_symbols(sub1, ['AAPL', 'MSFT'])
-dx.dxf_add_symbols(sub2, ['AAPL', 'C'])
-```
-
 **Attach listeners**:
 ```python
 dx.dxf_attach_listener(sub1)
 dx.dxf_attach_listener(sub2)
 ```
 
+**Add tickers you want to get data for**:
+```python
+dx.dxf_add_symbols(sub1, ['AAPL', 'MSFT'])
+dx.dxf_add_symbols(sub2, ['AAPL', 'C'])
+```
+
 `dxfeed` has default listeners for each event type, but you are able to write 
 your custom one. You can find how to do it at `example/Custom listener example.ipynb`.
 

docs/basic_usage.rst

@@ -31,13 +31,6 @@ create. One connection may have several subscriptions.
     'Trade', 'Quote', 'Summary', 'Profile', 'Order', 'TimeAndSale', 'Candle', 'TradeETH', 'SpreadOrder',
     'Greeks', 'TheoPrice', 'Underlying', 'Series', 'Configuration' event types are supported.
 
-Each subscription should be provided with tickers to get events for:
-
-.. code-block:: python
-
-    dx.dxf_add_symbols(sub1, ['AAPL', 'MSFT'])
-    dx.dxf_add_symbols(sub2, ['AAPL', 'C'])
-
 Special function called listener should be attached to the subscription to start receiving
 events. There are default listeners already implemented in dxpyfeed, but you
 can write your own with cython: :ref:`custom_listener`. To attach
@@ -48,6 +41,13 @@ default listener just call `dxf_attach_listener`
     dx.dxf_attach_listener(sub1)
     dx.dxf_attach_listener(sub2)
 
+Each subscription should be provided with tickers to get events for:
+
+.. code-block:: python
+
+    dx.dxf_add_symbols(sub1, ['AAPL', 'MSFT'])
+    dx.dxf_add_symbols(sub2, ['AAPL', 'C'])
+
 The data can be extracted with `get_data()` method. It is stored as dict with list of columns and list
 of events. Note that `get_data` extracts the data and then clean the field. To look at data call this property:
 

docs/conf.py

@@ -9,7 +9,7 @@
 pyproject = toml.load(Path(__file__).parents[1].joinpath('pyproject.toml'))
 # -- Path setup --------------------------------------------------------------
 
-sys.path.append(Path(__file__).parents[1])
+sys.path.append(str(Path(__file__).parents[1]))
 # -- Project information -----------------------------------------------------
 
 project = pyproject['tool']['poetry']['name']

docs/custom_listener.rst

@@ -127,19 +127,19 @@ You can either import extension built on previous step or install your extension
 
     con = dx.dxf_create_connection()
     sub = dx.dxf_create_subscription(con, 'Trade')
-    dx.dxf_add_symbols(sub, ['AAPL', 'MSFT'])
 
 Attach custom listener, specifying the columns
 
 .. code:: ipython3
 
     dx.dxf_attach_custom_listener(sub, cust.tc, ['Symbol', 'Price'])
+    dx.dxf_add_symbols(sub, ['AAPL', 'MSFT'])
 
 After some time you will get the data.
 
 .. code:: ipython3
 
-    sub.gat_data()
+    sub.get_data()
 
 .. code:: ipython3
 

docs/installation.rst

@@ -10,11 +10,11 @@ Installation
 
         pip3 install pandas
 
-The easiest way to install dxpyfeed is to use pip
+The easiest way to install dxfeed is to use pip
 
 .. code-block:: bash
 
-    pip3 install dxpyfeed-x.x.x.tar.gz
+    pip3 install dxfeed
 
 .. warning::
     Package is not available on MacOS for now

examples/CustomListenerExample.ipynb

@@ -191,8 +191,7 @@
    "outputs": [],
    "source": [
     "con = dx.dxf_create_connection()\n",
-    "sub = dx.dxf_create_subscription(con, 'Trade')\n",
-    "dx.dxf_add_symbols(sub, ['AAPL', 'MSFT'])"
+    "sub = dx.dxf_create_subscription(con, 'Trade')"
    ]
   },
   {
@@ -208,7 +207,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dx.dxf_attach_custom_listener(sub, cust.tc, ['Symbol', 'Price'])"
+    "dx.dxf_attach_custom_listener(sub, cust.tc, ['Symbol', 'Price'])\n",
+    "dx.dxf_add_symbols(sub, ['AAPL', 'MSFT'])"
    ]
   },
   {

pyproject.toml

@@ -1,9 +1,8 @@
 [tool.poetry]
 name = "dxfeed"
-version = "0.1.0"
+version = "0.1.1"
 description = "DXFeed Python API via C API"
-authors = ["Ivan Mishalkin <ivan.mishalkin@devexperts.com>",
-           "DxCurrent Team <dxcurrent@devexperts.com>"]
+authors = ["Index Management Team <im@dxfeed.com>"]
 build = "build.py"
 license = "MPL-2.0"
 readme = "README.md"