Skip to content

sjrahimian/huh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

huh: ḥuqúqu'lláh helper

Calculates 19 mit͟hqáls of gold and 19% of wealth (after debts and expenses); a ḥuqúqu'lláh helper.

Helps calculate the voluntary tax Ḥuqúqu'lláh (Right of God; Arabic: Ḥuqúq 'right', Alláh 'God'), paid by those who have willingly chosen to be Bahá'í (Wikipedia; Huqúqu'lláh Compilation). Will retrieve the price of gold and perform the required operations, then the program will output the gold price and the payable amount of Ḥuqúqu'lláh (if any).

Setup

Running program

Planning to release executable file soon. Until then follow the instructions in Development to get setup.

Use the huh.ini configuration file to change defaults (e.g., which date to fetch metal prices). An example configuration file is provided of what can be changed can be found in huh.ini.example; remember to rename the file to huh.ini. File needs to be in the same directory as the app.py file.

To see options execute python app.py --help.

Development

Clone/download repo, create a virtual environment, and install the necessary packages.

$ python -m venv venv
$ . venv/bin/activate #(or .\venv\Scripts\Activate.ps1 )
$ pip install astral geopy requests timezonefinder
    # or
$ pip install -r requirements.txt

Python packages used:

  • astral
  • geopy
  • requests
  • timezonefinder

Thank you to the respective module Authors.

License

Copyright (C) 2024, Sama Rahimian. All rights reserved.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. In no world, this or the next, shall the Author be held liable for any damages, loss, damnation, or miscalculations, arising from the use of this software.

About

Help calculate the voluntary tax Huququ'llah ("Right of God"), by retrieving the price of gold and performing required operations.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages