diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c44ab14 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,19 @@ +The MIT License (MIT) + +Copyright (c) 2013 Charles Allderman. Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 12b4b51..9d0c31d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PyIRess # +# PyIress # PyIress is a Python interface onto the Iress web services API. See the [Website] (https://www.iress.com/za/company/products/iress-pro-market-data-desktop/). @@ -19,10 +19,10 @@ PyIress is a Python interface onto the Iress web services API. See the [Website] ### Installation ### * Dependencies - zeep - For the [Zeep documentation] (https://python-zeep.readthedocs.io/en/master/). - pandas - For the dependencies of `pandas` please refer to the [pandas documentation](http://pandas.pydata.org/pandas-docs/stable/install.html). + - zeep + -- For the [Zeep documentation] (https://python-zeep.readthedocs.io/en/master/). + - pandas + -- For the dependencies of `pandas` please refer to the [pandas documentation](http://pandas.pydata.org/pandas-docs/stable/install.html). * To install the latest version pip install pyiress @@ -30,7 +30,7 @@ PyIress is a Python interface onto the Iress web services API. See the [Website] ### Some Notes on Use ### - Pandas is great for data analysis +* Pandas is great for data analysis. We pull down the data and add it to a datafrome. from pyiress import Iress @@ -55,4 +55,14 @@ PyIress is a Python interface onto the Iress web services API. See the [Website] ### Acknowledgements ### -* Thanks to Vladimir Filimonov @vfilimonov whe wrote PyDatastream on which this project is based \ No newline at end of file +* Thanks to Vladimir Filimonov @vfilimonov whe wrote PyDatastream on which this project is based + + +### License ### + +PyIress library is released under the MIT license. + +The license for the library is not extended in any sense to any of the content of the Iress or related services. Appropriate contract with Iress and valid credentials are required in order to use the API. + +Author of the library (@ceaza) is not affiliated, associated, authorized, sponsored, endorsed by, or in any way officially connected with Iress, or any of its subsidiaries or its affiliates. The name “Iress” as well as related names are registered trademarks of Iress. +