Package: humbldata
humbldataThis package connects thehumblfinanceproject to its data sources and data analytics functions.
Used in `humblfinance` and `humblbacktests` projects.📝Table of ContentsAboutFeaturesGetting StartedDeploymentUsageBuilt UsingTODOContributingAuthorsAcknowledgments🧐AboutThis package is used as an interface between thehumblfinanceproject and its data sources. It's also used to perform data analytics on the data collected from the data sources.FeaturesORATS data collectionVolatility EstimatorsRescaled-range analysis (Mandelbrot CHannel)Volatility Adjusted PositioningStrategy backtest performance🏁Getting StartedThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Seedeploymentfor notes on how to deploy the project on a live system.PrerequisitesPython- programming languageMicromamba(miniconda3/conda/mamba) - env managementPoetry- package managementcommitizen&cz_customiziable- commit message managementRuff- style/linter tool📩Installing PackageWhen I upload to pip:pipinstallhumbldataCurrent install method:pipinstallgit+https://github.com/jjfantini/humbldata.git🏗️Development SetupSetup Conda Environment (w/Poetry)This project uses a conda environment. I have done this to be able to use openbb
package easily. I have followed the instructions on theopenbbwebsite.I created the environment with a--prefixand not a name, to ensure that it installed in my project directory, not the default path. This is executed in the project root dir.# Windowsmicromambaenvcreate--prefix./obb--fileenvironment.yml# MacOS / Linuxmicromambaenvcreate--prefix./obb--filebase-environment.ymlI didn't want the full path to be displayed when using this env so I changed my.condarcfile to show the env name as the last directory where the env is located.micromambaconfig--setenv_prompt'({name})'micromambaconfig--addchannelsconda-forgeActivate the environmentmicromambaactivate./obbInstall PoetrymicromambainstallpoetryInstall Packages frompoetry.lockpoetryinstallIf you get an error:EnvCommandError

Command ['c:\\Users\\<user>\\<path>\\obb\\python.exe', '-m', 'pip', 'uninstall', 'charset-normalizer', '-y'] errored with the following return code 2Then run:pip install charset-normalizer --upgradeand re-run!poetryinstallSetup Conda Environment (w/o Poetry)If you do not usepoetryfor some weird reason, I keep the updated environment specs in anenvironment.ymlandrequirements.txtfile in the root of the project.I use keep the env. specs up to date. This is packaged in a fileupdate_reqs.pycondaenvexport|python-c"import sys; print(''.join(line for line in sys.stdin if 'prefix: ' not in line))">environment.yml# This cmd removes the 'prefix:' line to be platform independent.condalist--export>requirements.txtSetup Conda Env (w/ requirements)This method will be installing dependencies fromrequirements.txt || environment.ymlStepsThere are two methods to recreating the environment:Using requirements.txt```bash
conda create --name obb --file requirements.txt
```Using environment.yml (has my path prefix-check the file to change path prefix)```bash
# Windows 
conda env create --prefix ./obb -f environment.yml

#Alternative OS
conda env create --prefix ./obb --file base_environment.yml
```Setting Up `Commitizen`I am using the `vscode-commmitizen` extension to integrate `commitizen` into my workflow.
This allows for nice keyboard shortcuts and UI integration. I have also installed `cz_customizable` globally to allow me to customize the commit message template using `cz-config.js`.Thepyproject.tomlfile has the specifications forcz_customizableandcommitizento work together.Follow thequickstart guideand use the 'Quick Start' section to setupcz-customizable. You need to installcz-customizableglobally in order for the vscode extension to work along with the settings provided in thepyproject.tomlfile.make sure you have apre-commit-config.ymlmake sure you have abumpversion.ymlin.github/workflows🔧 Running the testsExplain how to run the automated tests for this system.Break down into end to end testsExplain what these tests test and whyGive an exampleAnd coding style testsExplain what these tests test and whyGive an example🎈 UsageAdd notes about how to use the system.🚀 DeploymentAdd additional notes about how to deploy this on a live system.⛏️ Built UsingOpenBB- Data SourcePostgreSQL- DatabasePython- Programming Language✍️ Authors@jjfantini- Idea & Initial workSee also the list ofcontributorswho participated in this project.🎉 AcknowledgementsHat tip to anyone whose code was usedInspirationReferences