Modify the project structure to match the structure for the python package

Warehouse class knows about:

• all deliveries
• rest amount of wooden pellets (from all deliveries in one pack)
• all consumptions
• max amount of pellets in history

Class coordinate interactivity between other classes (Delivery, Consumption).

Add PyPI python version badge to README.md before Build badge.

Check https://github.com/Netflix/osstracker a https://shields.io/category/other

Use https://opensource.guide/starting-a-project/

Create classes for Delivery and Consumption. Data in app will be populated.

Delivery

• Product
  • Name
  • Bag size
  • Moisture in pct
  • Raw material (Wood type)
  • Ash in pct
  • Class
  • Calorific value in MJ per kg
• Producer
• Supplier
• Amount in kgs
• Price
• Date

Consumption

• Date
• Delivery
• Amount in kgs
• Calculated:
  • Price per consumption

Entries can have multiple currencies. One currency for whole data file.

.. during day hours in a whole week

• Input for every day of week
• Input for days 1-5 (Mon-Fri)
• Input for days 6-7 (Sat-Sun)
• Input for all days in week

Input contains:

• Day of week (1 / 1-5 / 6-7 / *)
• Time for change
• Target temperature in °C

Event class serves for records about financial expenses, alarms and other events with stove/boiler.

Members:

• timestamp
• type of event
• price
• note

Type of event:

• maintenance
• spare parts
• financing
• payment
• purchase price
• miscellaneous
• accessories
• supervisory board
• repair
• alarm

Do this before #17 and #16

Installation of pyenv, pipenv. Set up pyenv with python 3.9.0

Learn how to use Pipfiled instead of requirements.txt files.
https://github.com/pypa/pipfile
https://realpython.com/pipenv-guide/

Check format with https://keepachangelog.com/en/1.0.0/

Needed attributes:

• Product (name)
• Brand
• Supplier
• Amount in kgs
• Price (in your currency)
• Date
• Type of product (raw pellets, bags)
• Number of bags

The input takes place after loading the pellets into the hopper or after consuming them.

Record contains attributes:

• Product (delivery)
• Amount in kgs/bags
• Date

Use toml for configuration file
In config file store values for:

• config version
• language

Add to Readme after license badge.

Learn by https://realpython.com/pypi-publish-python-package/, https://packaging.python.org/tutorials/packaging-projects/, https://docs.python-guide.org/writing/structure/

Implement save file containing:

• save file version
• deliveries data records
• consumption data records
• maintenance records

Save format could be toml.

Use https://opensource.guide/starting-a-project/

Follow the python package tutorial and create first pypi package

You can add expenses as input parameters/interactive input like:

• type of expense (mandatory inspection of the boiler, maintenance, repair, purchase price, etc)
• date
• price in selected currency
• note

There are possibility to import files exported from Granules.

It is possible to import orders.csv and entries.csv.