Skip to content

dlt-science/hedera-intel

Repository files navigation

Hedera Transactions

Clone this repository

git clone https://github.com/dlt-science/hedera-intel.git

Navigate to the directory of the cloned repo

cd hedera-transactions

Set up the repo

Give execute permission to your script and then run setup_repo.sh

chmod +x setup_repo.sh
./setup_repo.sh

or follow the step-by-step instructions below between the two horizontal rules:


Create a python virtual environment

  • iOS
python3 -m venv venv
  • Windows
python3 -m venv venv

Activate the virtual environment

  • iOS
. venv/bin/activate
  • Windows (in Command Prompt, NOT Powershell)
venv\Scripts\activate.bat

Install the project in editable mode

pip install -e ".[dev]"

Run scripts

Fetch balances data for the first time:

python scripts/process/fetch-transactions.py

This only needs to be run once, and the data will be saved in data/ folder. run git lfs pull to get the data.

python scripts/process/process-tx-types.py

Git Large File Storage (Git LFS)

All files in data/ are stored with lfs.

To initialize Git LFS:

git lfs install
git lfs track data/**/*

To pull data files, use

git lfs pull

Synchronize with the repo

Always pull latest code first

git pull

Make changes locally, save. And then add, commit and push

git add [file-to-add]
git commit -m "update message"
git push

Best practice

Coding Style

We follow PEP8 coding format. The most important rules above all:

  1. Keep code lines length below 80 characters. Maximum 120. Long code lines are NOT readable.
  2. We use snake_case to name function, variables. CamelCase for classes.
  3. We make our code as DRY (Don't repeat yourself) as possible.
  4. We give a description to classes, methods and functions.
  5. Variables should be self explaining and just right long:
    • implied_volatility is preferred over impl_v
    • implied_volatility is preferred over implied_volatility_from_broker_name

Do not

  1. Do not place .py files at root level (besides setup.py)!
  2. Do not upload big files > 100 MB.
  3. Do not upload log files.
  4. Do not declare constant variables in the MIDDLE of a function

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •