Skip to main content

Price database storage for commodities

Project description

price-database

A simple Python library and a CLI for storage of prices

The purpose of this project is to provide a storage and means of accessing a price database. It can be reused among multiple projects.

The goal is very simple: separate a storage of prices of various elements (commodities) from other applications or components.

The Price object has several properties:

  • unique identifier = uniquely identifies each record for ease of accessing

  • namespace = distinguishes the namespace for the symbol. Often the exchange name.

  • symbol = security/commodity symbol that identifies it within the namespace (exchange).

  • date = The date of the price

  • time = The time of the price

  • value = Value in currency

  • currency identifier = identifier for the currency. Can be anything the remote system is using.

With these, it should be possible to store prices for commodities used in GnuCash, GnuCash Portfolio, Asset Allocation and other similar financial packages.

Development

I'm toggling between using PyCharm and Visual Studio Code, with the following libraries:

  • pylint,

  • pytest,

  • rope, for refactoring

Installation

pip install -e .

Then manually copy the data/prices-template.db into data/prices.db.

Running commands like pricedb list for the first time, will create pricedb.ini file in your home directory. Once created, edit the file and add the required values, like the database path and/or the API keys for online services.

Configuration

PriceDb expects to find a configuration file "pricedb.ini" in the user's profile directory. It will create one if it doesn't find it, but you need to supply the values before the application is functional.

At a minimum, provide the path to the database file.

Running

pricedb

is a command-line interface to all the provided functionality.

Using Python, the PriceDbApplication class is the front-end, providing the same functionality through code.

Example:

pricedb import data\AUD_2017-11-11_142445.csv AUD -v DEBUG

Logging

click-log package is used to provide log output. Simply enable by passing

-v LEVEL

to the command line, where LEVEL is one of the logging levels. Use empty -v option for details.

Publishing

Publishing to PyPi:


python setup.py sdist bdist_wheel

twine check dist/*

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PriceDb-2.11.0.tar.gz (29.7 kB view hashes)

Uploaded source

Built Distribution

PriceDb-2.11.0-py2.py3-none-any.whl (30.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page