ServerPortfolio Documentation

This is the entry page of the documentation of the python ServerPortfolio package.
Follow this link to access the the C++ ROOT_application documentation.

Contents

• Overview of the package
• Dependencies and installation
• Configuration
• Usage of the tools
• Implementation details
• Unit-testing and debugging
• Glossary

Overview of the package

The aim of ServerPortfolio is to retrieve and store financial data from the internet.
A server is provided to update periodically the value of assets and can be queried from python or C++ modules through a TCP/IP connection.

Different types of financial data can be retrieved, they are referred as Action in the rest of the documentation:

• Last value of the asset (InstValue) : use of Boursorama web site
• Historical price (HistPrice) : Yahoo
• Dividends and split (DivSplit) : Yahoo - Not fully implemented
• Fundamental data PER, PEG...(Fundamental) : YahooYQL
• Industry and sector category of a company (Info) :YahooYQL - Not working at this time due to a recent change in Yahoo page

Data are stored either in a XML or Comma-Separated Values format:

• XML : Fundamental, Info
• CSV : HistPrice, InstValue

The python package provides:

• A server (ServerPortfolio.py) which periodically parses the value of predefined assets.
• A script (RunParser.py) provides most of the functionalities.

Dependencies and installation

The installation of lxml is required.
The other modules are available by default with python 2.7:

• SocketServer, threading, Queue, logging, urllib2, Tkinter

There is not (yet) the possibility to install or distribute the package. So it is needed to set up the PYTHONPATH variable:
export PYTHONPATH=path_to_mycstock/ServerPortfolio/trunk/ServerPortfolio

before using any of the tools or importing the package in a python script with:
import serverportfolio

Compiling the wrapper to the C++ code

To use all the python tools, the shared library wrapPyStock.so must be compiled first.
See the ROOT_application documentation.

Configuration

Some paths must be edited manually before the compilation:

• in serverportfolio/GlobalDicts.py: set the directories containing the data and the configuration file for the parser (dictstocks.txt), as well as the TCP ports used for the communication with the server and the GUI

This documentation has been generated with:
doxygen path_to_mycstock/ServerPortfolio/trunk/ServerPortfolio/DoxyServerPortfolio

Asset configuration

A single file (default PATH_DICT/dictstocks.txt) contains the definition of the assets.

## code market  code_bourso code_yahoo format_bourso
CAC40   FR      1rPCAC  ^FCHI   Pts
ORA     FR      1rPORA  ORA.PA  EURO
LVC     FR      1rTLVC  lvc     EURO
FSLR    US      FSLR    FSLR    DOLLAR
FAZ     US      1yFAZ   faz     DOLLAR
DJ      US      %24INDU DJ      Pts
DAX     DE      5pDAX   dax     Pts
CBK     DE      1zCBK   CBK     EURO
SP500   US      %24INX  ^GSPC   Pts
EURUS   DEVISE  1xEURUS toto2   Pts
Brent   MP      8xBRN   brent   DOLLAR
AUX MP  1xGLDAM or  Pts
# can add comment with '#'
# it is a future, code always changing, commented
#OIL    MP  CLJN10  petrole Pts   

• code : also referred as symbol, a convenient name for the stock or devise. This name will be the reference for both Python and C++ modules and will be used for the filenames in data/.
• market : indicates where this stock referenced. Possible values are: FR/DE/US/ML_FR/MP/DEVISE, it is used to know about the opening and closing time of the share.
• code_bourso, code_yahoo : are used to build the URL respectively of the Boursorama.com and Yahoo.com websites.
• format_bourso : is used only for the parser of Boursorama.com

The codes (code_bourso and code_yahoo) must be edited manually by the user. The only way at this moment is to visit the respective websites and check the URL. They must follow the format:

• code_bourso : http://www.boursorama.com/cours.phtml?symbole=
• code_yahoo : http://ichart.yahoo.com/table.csv?s=

Usage of the tools

Running the ServerPortfolio for real time update

The server is run in executing:

• ./Server_Portfolio.py

It is stopped in executing:

• ./SocketServer_Client.py BYE

Using the Python parsers as a command line

The tool Run_Parsers.py group all options. Action available for parsing instantaneous values with –source=Boursorama:

• GET
• FORCE

Actions available for updating historical data with –source=Yahoo:

• UPDATE_CSV
• INTRO

Run RunParsers.py -h to get the help and examples.