diff --git a/CHANGELOG.md b/CHANGELOG.md index f85aa29..10c8646 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,36 +1,466 @@ # CHANGELOG -## v1.1.1-rc.1 (2025-01-30) -### Bug Fixes +## v1.1.1-rc.2 (2025-01-31) -- Allow cicd on test branch - ([`f6aaccf`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/f6aaccf4788ff14b349128cdce6352a670c90476)) +### Fix -### Chores +* fix: ci cd with release candidate option ([`af25f34`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/af25f34ca97fb228afbf7f8f1c708d0b5743ee3d)) -- Add more badges - ([`70a1f92`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/70a1f92ad06517de4ff2c3604ed51ea85d4669c2)) +* fix: Get bmi seperate file + erase risk factor (#96) -- Update README test coverage badge - ([`9f56281`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/9f56281f4a39d45e13aedd3893d3242eadda59f7)) +* fix: created get_bmi seperate file + +* fix: remove risk_factor + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`76ed73a`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/76ed73a5523a60e2c46bbed5795c69393939c44b)) +### Unknown -## v1.0.0 (2025-01-30) +* lower python version ([`e2112c9`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/e2112c980cfba1b513e0f70165ef982f723e84d2)) -### Bug Fixes +* Merge branch 'main' of https://github.com/UBC-MDS/HealthScienceCalculator into ci-cd-integration ([`009b86c`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/009b86cc598ecea05cc9b35ea3638aaefa38f9f3)) -- Allow ci cd merge versioning - ([`5e4f761`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/5e4f76136c059a88003fd2341925b84a00b9fad9)) +* Update test functions with the correct import instruction (#98) +* fix: Update README.md structure to move Python Ecosystem Fit after summary + +Update README.md structure to move Python Ecosystem Fit to appear after the summary + +* Fix: Create get_bmr.py function in new file + +Fix: Create a new file for the BMR function + +* fix: Create get_tdee.py as a new file + +Create a new file for tdee function to fix comment from milestone 2 + +* Fix: Create unit_convert.py + +Create a new file for the unit convertor function + +* Fix: updated the test functions to cover changes to the functions ([`ee5ee5a`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/ee5ee5a7860ee2cd6e5f9877c29e4ffb6d65c30f)) -## v1.1.0 (2025-01-30) +* Merge branch 'main' of https://github.com/UBC-MDS/HealthScienceCalculator into ci-cd-integration ([`bd6b172`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/bd6b17203833e51cec6a633604f01ffb6bbbe6d8)) -### Bug Fixes +* just remove some spaces ([`35ee2c2`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/35ee2c2c148adbe9306948e8d6b8d4ad234fe53c)) -- Add semantic versioning to poetry environment - ([`a8b953d`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/a8b953dce304854e3778b50773a6222bf58874bc)) +## v1.1.1-rc.1 (2025-01-31) -## v1.0.1 (2025-01-25) +### Chore + +* chore: add more badges ([`70a1f92`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/70a1f92ad06517de4ff2c3604ed51ea85d4669c2)) + +* chore: update README test coverage badge ([`9f56281`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/9f56281f4a39d45e13aedd3893d3242eadda59f7)) + +### Fix + +* fix: allow cicd on test branch ([`f6aaccf`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/f6aaccf4788ff14b349128cdce6352a670c90476)) + +### Unknown + +* Separate the functions in the package into separate files (#95) + +* fix: Update README.md structure to move Python Ecosystem Fit after summary + +Update README.md structure to move Python Ecosystem Fit to appear after the summary + +* Fix: Create get_bmr.py function in new file + +Fix: Create a new file for the BMR function + +* fix: Create get_tdee.py as a new file + +Create a new file for tdee function to fix comment from milestone 2 + +* Fix: Create unit_convert.py + +Create a new file for the unit convertor function ([`f97eb21`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/f97eb215246a75731b785e6eba9dcf75a485b2ed)) + +* Merge branch 'main' of https://github.com/UBC-MDS/HealthScienceCalculator into ci-cd-integration ([`7e30387`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7e303879aeab3cfabfebbc5c43215b3eef2db33e)) + + +## v1.0.0 (2025-01-31) + +### Fix + +* fix: allow ci cd merge versioning ([`5e4f761`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/5e4f76136c059a88003fd2341925b84a00b9fad9)) + + +## v1.1.0 (2025-01-31) + +### Fix + +* fix: add semantic versioning to poetry environment ([`a8b953d`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/a8b953dce304854e3778b50773a6222bf58874bc)) + +### Unknown + +* Milestone1edits (#88) + +* I changed the get_tdee documentation + +* fix: I added example doccumentation to get_tdee and get_bmi + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`d9a9aa1`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/d9a9aa14458070424800551b2fe15f83576c21b7)) + +* I changed the get_tdee documentation (#85) + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`cd1a22a`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/cd1a22adc9cbd372c7794949fd45fb12d26b6cbd)) + +* update conf and lock (#78) + +* Update pyproject.toml + +* update lock + +* update conf and lock + +--------- + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`eae4642`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/eae4642c0994dce35fcd1b7933faba2f76240547)) + +* Bmr doc update (#77) + +* Update tutorial + +* Change formatting on example file + +* Update example.ipynb + +Update formatting + +* Update example.ipynb + +Update header formatting ([`5d01411`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/5d01411c09f38c309eaa05851d96f928a48de76f)) + +* add status badge (#75) ([`6ccc203`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/6ccc20308c5c47a1db375877923db6b4d9819a9d)) + +* Bmr doc update (#73) + +* Update tutorial + +* Change formatting on example file ([`c9fdff4`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/c9fdff4bfae65692186fc0b9f7cdf82a4a17a00a)) + +* Update tutorial (#71) ([`7b94c06`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7b94c062217a47d5959753de5d9bcdb544721232)) + +* removed files we don't need (#68) + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`dedbea9`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/dedbea9cfac3ce0820346d1f1747dcf053ed7e54)) + +* Tdee doc3 (#67) + +* tdee doc + +* tdee to example + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`5d820ed`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/5d820ed791970a809d365452deae3ce72731484d)) + +* update toml and lock file (#64) + +* Update pyproject.toml + +* update lock + +--------- + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`7b8900b`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7b8900b58ee52430fa56f2b2862086bcead31f45)) + +* Bmr docs (#65) + +* Update unit convector examples + +* Tutorial on bmr application ([`b12a6db`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/b12a6db3d0848dc6b7f3c9bbfa6893466c055b34)) + +* unit convert doc (#61) + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`b99fd18`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/b99fd188e4f4c3ad4270c5aeac0bbbd79934d998)) + +* add unit_convert (#60) + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`e087f80`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/e087f806c62a3f50f2645a64b5648b8f2708beae)) + +* Tdee doc (#59) + +* create tdee example + +* tdee documentation example + +* tdee-doc + +* example + +* example + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`7879aa3`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7879aa338b7bc7c345fee117de1b338c98ea2733)) + +* Add BMI doc to example ipynb (#58) + +* add starting example code + +* fixed wording + +* update wording on example + +* update sys path for unsupporting packages + +* formatting bmi + +* adding bmi example to master example ipynb + +--------- + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`cb3291f`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/cb3291f0d629f43324df29bddbb72fdd09a10667)) + +* Add sys path to import packages (#55) + +* add starting example code + +* fixed wording + +* update wording on example + +* update sys path for unsupporting packages + +--------- + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`2d87de8`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/2d87de85e7427b489560559909dc005931721fb1)) + +* Setup example usage (#52) + +* add starting example code + +* fixed wording + +--------- + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`1b678d8`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/1b678d8f170873491582181a7b7ab14d5653b22b)) + +* add more test cases and doc (#47) ([`b43c3ae`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/b43c3ae0addebe8bbb23a06bfb8cf29e74c88d8c)) + +* - Add BMI data validation + +- Updated `pytest` package to version 7.4.4 and adjusted its dependencies. +- Introduced `pytest-cov` package (version 6.0.0) for measuring coverage in tests. +- Enhanced `get_bmi` function with input validation for weight and height. +- Expanded `__init__.py` to include new functions: `get_bmr`, `get_tdee`, `unit_convert`, and `BMIResult`. +- Added comprehensive tests for `get_bmi`, covering various categories, edge cases, and input validation. + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`6560903`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/6560903844362cdf894f9d7914b7d16edbe01e7d)) + +* Test bmr (#45) + +* added the bmr function to the general functions + +* developed function bmr + +* Updated implementation + +* Add test case + +* add pytest to project toml + +* update test cases on age + +* Update edge cases + +* Update code to meet test cases + +* Update test_get_bmr.py + +Add documentation to BMR test ([`6cb9098`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/6cb90984ad52e27f97d3f32c1de66cb024ab864d)) + +* fix duplicate entries in toml (#43) + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`968fac4`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/968fac41bcc55bdf6ee661aaca695eb3fef8bae0)) + +* Update __init__.py (#42) ([`931c62c`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/931c62c1dd81b3217ab53cb614c84c8419c77148)) + +* Project.toml pytest (#37) + +* tdee tests + +* tdee implementation + +* fix pyproject.toml so that pytest runs + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`41da33b`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/41da33b7188a58e128b1b71eea68f6288b30313f)) + +* test and code for unit convert (#35) + +* write test cases + +* write unit convert code and modify unit test + +* modify code + +return value if input and output are the same + +--------- + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`4de6891`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/4de6891ec3feadc90ba4e7097e0255150a820ab8)) + +* Test bmr (#39) + +* added the bmr function to the general functions + +* developed function bmr + +* Updated implementation + +* Add test case + +* add pytest to project toml + +* update test cases on age + +* Update edge cases + +* Update code to meet test cases ([`0d77e97`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/0d77e9700e75a24ef964500c4dd70e2e51511312)) + +* Bmi implementation and unit tests (#38) + +* fix get_bmi rounding issue + +* unit test in functions + +--------- + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`f6aeb80`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/f6aeb807f5cf4fa3464283ba0ce71ff0fe506e94)) + +* Implement tdee (#33) + +* tdee tests + +* tdee implementation + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`f4eeb52`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/f4eeb52308f1612eccd3f2f0aaa65557e022c12a)) + +* tdee tests (#31) + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`d9eec03`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/d9eec03c049c8968567641847ae7cbba7300ca3c)) + +* Test bmr (#29) + +* added the bmr function to the general functions + +* developed function bmr + +* Updated implementation + +* Add test case + +* add pytest to project toml + +* update test cases on age ([`df8e92b`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/df8e92b4f4b0d7eaadbca8afa3916a3a1b7c8344)) + +* Code bmr (#28) + +* added the bmr function to the general functions + +* developed function bmr + +* Updated implementation ([`ea1f9ec`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/ea1f9ecc1abc25dc3b99e32c6c25f667823ded21)) + +* Bmr function updates on readme (#25) + +* added the bmr function to the general functions + +* Update README.md + +updated the bmr portion of readme ([`7ad3639`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7ad363974c652403edae1abcf431411abdebab01)) + +* Update README.md (#24) ([`7314c30`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7314c301cf6798b7533771ebcecf8d15cb1313f8)) + +* added the bmr function to the general functions (#23) ([`cb4d8a7`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/cb4d8a7fb1835e905da168fef6c30c939aee8eda)) + +* Tdee (#19) + +* Create TDEE calculator function + +* example section on how to call and use the function + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`a0e4a78`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/a0e4a78c8e4a61bb541da3ed14e30583d7242f6a)) + +* Readme edits (#18) + +* Create TDEE calculator function + +* add summary, describe functions and how it fits in the python ecosystem + +* edit read me and update usage + +* Update README.md inclucde unit converter and bmr + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`48a1e10`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/48a1e10bada713c69b4d20cb49599c9f42471dff)) + +* docstring for unit_convert (#13) + +Co-authored-by: tew49 <tew49@student.ubc.ca> ([`d4d4c9f`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/d4d4c9fcf7a28bcdfe436eeb4863b2c135dd489b)) + +* Add CONTRIBUTING.md with examples (#17) + +* added style guide and instructions for contributing + +* Add style guide example + +--------- + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`7d95091`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7d95091a900110a475362bf792b2dc3867ee2a47)) + +* Readme edits (#12) + +* Create TDEE calculator function + +* add summary, describe functions and how it fits in the python ecosystem + +--------- + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`0181020`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/0181020c8e0f1acc60b5d2a939c3b7f7d701c615)) + +* Create TDEE calculator function (#11) + +Co-authored-by: Hala Arar <halaosama92@yahoo.com> ([`b034667`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/b034667a770289c362ef73fd8554228b75fdb83c)) + +* Bmr function (#14) + +* project structure + +* updated readme and conduct + +* add documentation of bmr function ([`7918898`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/7918898e2b7df2732fb8470a1532247d37e779af)) + +* Structure (#10) + +* project structure + +* updated readme and conduct + +--------- + +Co-authored-by: halaarar <halaarar@student.ubc.ca> ([`682479c`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/682479cd9d3fa39db77ac4d696ea66452c577308)) + +* created bmi calculator function with no implementation (#9) + +Co-authored-by: Li, Jiayi <76764434+jiayili7@users.noreply.github.com> ([`464c9bb`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/464c9bb051f995958bd03e764f870d68b5733c0e)) + +* project structure (#7) ([`0aaed33`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/0aaed332772c3c3d5845f27baa435479e9e14937)) + +* Initial commit ([`a649af3`](https://github.com/UBC-MDS/HealthScienceCalculator/commit/a649af39b3d34e7f88ba65a5b0524cd4252cfb0d)) diff --git a/pyproject.toml b/pyproject.toml index 2457405..4c33f63 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "healthsciencecalculator" -version = "1.1.1-rc.1" +version = "1.1.1-rc.2" description = "Calculates basic health indexes" authors = ["Forgive Agbesi, Jiayi Li, Hala Arar, Tengwei Wang"] license = "MIT"