https://github.com/tmlmt/milk-tracker
Light breastfeeding data analysis
https://github.com/tmlmt/milk-tracker
Last synced: about 1 month ago
JSON representation
Light breastfeeding data analysis
- Host: GitHub
- URL: https://github.com/tmlmt/milk-tracker
- Owner: tmlmt
- License: mit
- Created: 2024-05-26T18:56:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-21T20:46:17.000Z (over 1 year ago)
- Last Synced: 2026-01-14T08:39:06.921Z (about 1 month ago)
- Language: Python
- Size: 1.15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Milk Tracker
  
Basic breastfeeding data analysis and tracking
## Introduction
The idea of this app stemmed from the need to track and visualize breastfeeding meal statistics stored in a Pandas DataFrame. This was the opportunity to learn how to create and deploy a web app based on python-based nicegui, an alternative to streamlit with better state management and handling of user interaction. It quickly expanded to learn even more how to develop python applications with best development practices like:
- formatting and linting with [ruff](https://github.com/astral-sh/ruff)
- deploying with GitHub Actions
- split code using a model-view-controller design pattern
- validate data using [pydantic](https://github.com/pydantic/pydantic) models
- keep track of changes using [git-cliff](https://github.com/orhun/git-cliff)
- managing a python environment using [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)
- Testing the code prior to releasing using [pytest](https://pytest.org/)
- Calculating the coverage of tests using [coverage](https://coverage.readthedocs.io/en/latest/)
- Typing python code and checking it with [mypy](https://mypy.readthedocs.io/en/stable/)
Huge thanks to the Open Source community for providing such great tools to the world.
## Features
- Protect access with password
- Record meals start and end times
- Lock start time of new meal
- Keep track of meal rounds during ongoing meal
- Reminders for daily intake of vitamins
- See latest three days trends in graphs
- See daily stats in a table
- Keep a log of daily memories
## Backlog
- Edit and delete any meal
## Tried without satisfactory result
- Prediction of next meal's time and duration (Facebook Prophet couldn't really predict accurately -- see https://github.com/tmlmt/milk-tracker/issues/15. Perhaps additional metadata would help, or another algorithm may be more addapted)
## Self-hosting
The following instructions rely on the use of [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) for managing python environment and [nginx](https://nginx.org) for the web server.
1. Use `env.yaml` file to create your environment: `micromamba env create -f env.yaml`
2. Copy `milk_tracker` folder in your web server area, e.g. `/var/www/`
3. Create an `.env` file within that folder with the following content:
```
APP_PORT=
PASSWORD=
STORAGE_SECRET=
```
4. Customize the `milk_tracker/config.yaml` file
5. Initialize the meal journal and memories log by renaming `assets/journal.template.xlsx` and resp. `assets/memories.template.csv` into `assets/journal.xlsx` and resp. `assets/memories.csv`
6. Use `scripts/milk-tracker.conf` as example to configure the redirection of http requests to your app using nginx and your own domain
7. Use `scripts/milk-tracker.service` as example to configure a systemd unit to manage the start/stop of the app
8. Enable the unit, e.g. `systemctl --user enable milk-tracker.service` if you're running the app using a specific user and choose to run user units
9. Start the app, e.g. `systemctl --user start milk-tracker.service`
10. Go to [https://:](https://:) and start tracking :-)
## License
MIT License
Copyright (c) 2024 Thomas Lamant