First commit - add the functions that makes the package work :)

Author: capaci

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+omit = */migrations/*,venv/*
+
+[coverage:report]
+skip_empty = true
+omit = */migrations/*,*/test*,*/tests/,venv/*
+

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 120
+exclude = migrations/*,venv/*
+max-complexity = 10

.gitignore

@@ -0,0 +1,254 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm,code,sublime
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm,code,sublime
+
+### Code ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+#!! ERROR: sublime is undefined. Use list command to see defined gitignore types !!#
+
+# End of https://www.toptal.com/developers/gitignore/api/python,pycharm,code,sublime

README.md

@@ -1,2 +1,50 @@
-# allokation
-Allocate your money to have equal distribution between the stocks you want in your portfolio
+# Welcome to Allokation 👋
+
+![Version](https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000)
+![License](https://img.shields.io/badge/License-MIT-yellow.svg)
+
+> A python package that gets stocks prices from yahoo and calculates how much of each stocks you must buy to have almost equal distribution between the stocks you want in your portfolio
+
+## Requires
+
+python >= 3.x
+
+## Install
+
+- clone the repository
+
+```sh
+git clone [email protected]:capaci/allokation.git
+```
+
+- install dependencies
+
+```sh
+pip install -r requirements.txt
+```
+
+## Usage
+
+Check the example available in [`example/example.py`](./example/example.py)
+
+## Run tests
+
+```sh
+pytest
+```
+
+## Author
+
+👤 **Rafael Capaci**
+
+- Website: [capaci.dev](https://capaci.dev)
+- Twitter: [@capacirafael](https://twitter.com/capacirafael)
+- Github: [@capaci](https://github.com/capaci)
+- LinkedIn: [@rafaelcapaci](https://linkedin.com/in/rafaelcapaci)
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+***
+_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

allokation/__init__.py

@@ -0,0 +1,19 @@
+from .functions import (
+    get_closing_price_from_yahoo,
+    map_columns_without_suffix,
+    transpose_prices,
+    calculate_multiplier,
+    calculate_amount,
+    calculate_total_for_each_ticker,
+    calculate_percentage_of_each_ticker
+)
+
+__all__ = [
+    'get_closing_price_from_yahoo',
+    'map_columns_without_suffix',
+    'transpose_prices',
+    'calculate_multiplier',
+    'calculate_amount',
+    'calculate_total_for_each_ticker',
+    'calculate_percentage_of_each_ticker'
+]

allokation/functions.py

@@ -0,0 +1,38 @@
+import pandas as pd
+from pandas_datareader import data as web
+
+
+def get_closing_price_from_yahoo(tickers, date):
+    result = web.get_data_yahoo(tickers, date)
+    return result['Adj Close']
+
+
+def map_columns_without_suffix(tickers):
+    return {ticker: ticker[:-3] for ticker in tickers}
+
+
+def transpose_prices(prices):
+    df = pd.DataFrame()
+    df['symbol'] = prices.columns
+    df['price'] = prices.values[0]
+    df = df.round(2)
+    return df
+
+
+def calculate_multiplier(df, number_of_tickers, available_money):
+    max_price = df['price'].max()
+    percentage = 1 / number_of_tickers
+    multiplier = (available_money * percentage) / max_price
+    return multiplier
+
+
+def calculate_amount(df, multiplier):
+    return (df['price'].max()*multiplier/df['price']).round(0)
+
+
+def calculate_total_for_each_ticker(df):
+    return df['price']*df['amount']
+
+
+def calculate_percentage_of_each_ticker(df):
+    return df['total']/df['total'].sum() * 100