Restructured into package; added setup.py; changed location of my_bonds.yaml to ~/.ppserve/

Author: fberg

MANIFEST.in

@@ -0,0 +1 @@
+include ppserve/templates/*

README.md

@@ -12,7 +12,7 @@ The currency and `clean_or_dirty` may be omitted (currency defaults to the argum
 
 ## Configuration
 
-A file `my_bonds.yaml` in the script directory can be used to preconfigure bonds (e.g. if some of the data is not available from the price source).
+A file `my_bonds.yaml` in `~/.ppserve/` can be used to preconfigure bonds (e.g. if some of the data is not available from the price source).
 This is mostly useful for providing missing information needed for accrued interest computation.
 The format is as follows:
 
@@ -27,6 +27,12 @@ The format is as follows:
 ...
 ```
 
+## Installation
+
+Installation is done by running `python setup.py install --user` (skip `--user` to install system-wide).
+This installs a binary called `ppserve`.
+Check `ppserve -h` to see command line options.
+
 ## Dependencies
 
 [`BeautifulSoup`](https://www.crummy.com/software/BeautifulSoup/) for scraping, [`bottle`](http://bottlepy.org/docs/dev/) for serving HTML, [`coloredlogs`](https://pypi.org/project/coloredlogs/) for fancy output, [`CurrencyConverter`](https://pypi.org/project/CurrencyConverter/) for currency conversion.

bin/ppserve

@@ -0,0 +1,4 @@
+#!/usr/bin/env python3
+
+import ppserve
+ppserve.main()

ppserve/__init__.py

@@ -0,0 +1 @@
+from .ppserve import main

my_bonds.py ppserve/my_bonds.py

@@ -1,18 +1,19 @@
-from datetime import date
-from price_sources.securities import Bond
-from price_sources import ArivaPriceSource
+from .price_sources.securities import Bond
+from .price_sources import ArivaPriceSource
 
 import logging
 logger = logging.getLogger('my_bonds')
 
 import yaml
 from pathlib import Path
 
-script_path = Path(__file__).parent/'my_bonds.yaml'
+yaml_file = Path.home()/'.ppserve'/'my_bonds.yaml'
 
 try:
-    data = yaml.load(open(script_path, 'r').read())
+    logger.info('Found configuration in {}'.format(str(yaml_file)))
+    data = yaml.load(open(yaml_file, 'r').read())
 except FileNotFoundError:
+    logger.info('No my_bonds.yaml found.')
     data = {}
 
 # Sanitize symbols; they may be of integer type if entered without quotes

ppserve.py ppserve/ppserve.py

@@ -28,8 +28,8 @@
 from bottle import route, run, SimpleTemplate, abort, redirect, template
 from threading import Thread
 
-from price_sources import ArivaPriceSource
-from price_sources.securities import Bond
+from .price_sources import ArivaPriceSource
+from .price_sources.securities import Bond
 
 import logging
 import coloredlogs
@@ -38,7 +38,7 @@
 coloredlogs.install(level=getattr(logging, args.log_level))
 
 logger.info('Loading manually configured securities.')
-from my_bonds import my_bonds
+from .my_bonds import my_bonds
 
 template_path = Path(__file__).parent/"templates"
 portfolio_performance_template = SimpleTemplate(
@@ -129,8 +129,7 @@ def update_sec_prices(sec):
         sec.update_historic(start_date, date.today())
         sec.write_quotes()
 
-if __name__ == "__main__":
-
+def main():
     try:
         Thread(
             target=run, name="price server",
@@ -154,3 +153,6 @@ def update_sec_prices(sec):
 
     except KeyboardInterrupt:
         sys.exit()
+
+if __name__ == "__main__":
+    main()

price_sources/__init__.py ppserve/price_sources/__init__.py

@@ -91,7 +91,7 @@ def price_history(self): return self._price_history
 
     @property
     def _quotes_path(self):
-        return Path(__file__).parent/'quotes'/(self.symbol + '.quotes')
+        return Path.home()/'.ppserve'/'quotes'/(self.symbol + '.quotes')
 
     def write_quotes(self, path=None):
         if path is None:

price_sources/ariva.py ppserve/price_sources/ariva.py

@@ -0,0 +1,23 @@
+from setuptools import setup
+
+setup(name='ppserve',
+      description='Serves prices of financial securities fetched from the internet in a format that Portfolio Performance understands',
+      version='0.1',
+      url='https://github.com/fberg/ppserve',
+      author='Franz Berger',
+      license='GPL-3',
+      packages=[
+          'ppserve',
+          'ppserve.price_sources',
+          'ppserve.price_sources.securities'
+      ],
+      scripts=['bin/ppserve'],
+      install_requires=[
+          'PyYAML',
+          'bs4',
+          'coloredlogs',
+          'bottle',
+          'CurrencyConverter'
+      ],
+      include_package_data=True
+)