Skip to main content

A package for a quick and dirty portfolio analysis.

Project description

stockeasy

Quick and Easy Stock Portfolio Analysis - FOR ENTERTAINMENT PURPOSES ONLY!!

Introduction

All exposed functions in this package have been designed with the intent that they can be strung together in a DAG; as such, they all follow a consistent contract.

function contract

def function_name (data: Dict, config: dict, logging: logging.Logger)
return results: dict

data contract

data = {'name': pandas dataframe}

config contract

config = {'setting': setting values}

Example Code

import stockeasy
import pandas as pd

df_stocklist = pd.DataFrame([['VTSAX', 120], ['MSFT', 100]], columns=['symbol', 'sharesOwned'])

config = {
    'symbolField': 'symbol',
    'sharesField': 'sharesOwned',
    'dataFields': ['exchange', 'symbol', 'shortName', 'sector', 'country', 'marketCap']
}

results = stockeasy.get_info({'input': df_stocklist}, config=config)

print(results.get('output').head())

logging

Standard python logging object

Notes

  • I use Docker for enviroment management; as such, my build process will deviate from more classical approaches.
  • I attempt to follow functional programming style

Getting Started Contributing

for windows create a env.bat file after pulling with the mount path to the current directory. In windows, you can't use relative paths with Docker Volume mounts, so...

set LOCAL_MOUNT=C:\Users\ablac\OneDrive\Documents\stockeasy\

then run

make DOCKER
cd stockeasy
doit

Available doit tasks

lint -- runs linting setup_tool -- installs local tool unit_tests -- runs unit tests

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

stockeasy-0.0.20220226171140.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

stockeasy-0.0.20220226171140-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file stockeasy-0.0.20220226171140.tar.gz.

File metadata

  • Download URL: stockeasy-0.0.20220226171140.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10

File hashes

Hashes for stockeasy-0.0.20220226171140.tar.gz
Algorithm Hash digest
SHA256 411631c20b73acb60cf9579c9a3e19efdc87fbc33a8b237141a65631fc97251f
MD5 38545ae05e603e43a6f134f16dd590e4
BLAKE2b-256 188053b86436d4c100392a141269b7daa1d5aba8906bd046a1f205083bcf6c31

See more details on using hashes here.

File details

Details for the file stockeasy-0.0.20220226171140-py3-none-any.whl.

File metadata

  • Download URL: stockeasy-0.0.20220226171140-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10

File hashes

Hashes for stockeasy-0.0.20220226171140-py3-none-any.whl
Algorithm Hash digest
SHA256 2f852a9e68f09a6efc50b616d0be65753fba41b3b013a5b3fe3192075d299758
MD5 94f33ca3d3ad2099ad0bffea50707573
BLAKE2b-256 9860828572dad2674756b86bfc7aa7bf9bb51fb2e23fee2ca7bc92fcad7df320

See more details on using hashes here.

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