adpro / pelletics

A tool to compare pellet consumption in recent years and other statistics

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pelletics

GitHub Build Status codecov

OSS Lifecycle GitHub last commit GitHub milestones GitHub issues

A tool to compare the consumption of pellets in recent years and other statistics.

⚠️ THIS IS UNFINISHED DRAFT OF INITIAL VERSION OF PROJECT README ⚠️

Goal

The application will calculate statistics based on historical data on the number of burned pellets:

  • number of kg of pellets burned for each month of the year
  • comparison of burned kg of pellets in individual years by months (trend)
  • the amount of ash produced by burning pellets in each month
  • costs of fuel burned in individual months
  • current number of kg of pellets in stock
  • prediction of the date of emptying the pellets based on their use in the current year and the trend of previous years
  • and more...

Motivation

My motivation for this project is:

  • learn to use what's new in Python since version 3.5
  • learn to create a complete Python package
  • learn to create a package in PyPi
  • improve knowledge in the use of Github tools
  • learn to use Travis CI
  • improve knowledge of the use of status badges
  • and more

Getting Started

It will be written.

Roadmap

Functionality definition for version 0.1.0 is now in progress. Subsequent versions will be added gradually.

Contributing

Please read CONTRIBUTING.md for details on code of conduct, and the process for submitting pull requests.

Versioning

pelletics uses SemVer for versioning. For the versions available, see the tags on this repository.

Maintainers and contributors

  • Ales Daniel - Initial work - adpro

License

pelletics is licensed under the MIT License - see the LICENSE file for details.

Project status

Project is in active OSS Lifecycle OSS Lifecycle

More info about lifecycle at Netflix's OSS Tracker.

About

A tool to compare pellet consumption in recent years and other statistics

License:MIT License


Languages

Language:Python 90.4%Language:Makefile 9.6%