Home and office nutrient tracking software
Project description
Extensible command-line tools for nutrient analysis.
Requires:
Python 3.4.0 or later (lzma, ssl & sqlite3 modules) [Win XP / Ubuntu 16.04]
Packages: see setup.py, requirements.txt, and config folder
Internet connection, to download food database & package dependencies
See nt database: https://github.com/nutratech/nt-sqlite
See usda database: https://github.com/nutratech/usda-sqlite
Notes
On Windows you should check the box during the Python installer to include Scripts directory in your $PATH. This can be done manually after installation too.
Linux may need to install python-dev package to build python-Levenshtein.
Windows users may not be able to install python-Levenshtein.
Mac and Linux developers will do well to install direnv.
Main program works 100%, but test and lint may not on older operating systems (Ubuntu 16.04, Windows XP).
Install PyPi release (from pip)
pip install nutra
(Specify: flag -U to upgrade, or --pre for development releases)
Using the source code directly
Clone down, initialize nt-sqlite submodule, and install requirements:
git clone https://github.com/nutratech/cli.git
cd cli
make init
# source .venv/bin/activate # uncomment if NOT using direnv
make deps
./nutra -h
Initialize the DBs (nt and usda).
# source .venv/bin/activate # uncomment if NOT using direnv
./nutra init
# Or install and run as package script
make install
nutra init
If installed (or inside cli) folder, the program can also run with python -m ntclient
Building the PyPi release
# source .venv/bin/activate # uncomment if NOT using direnv
make build # python3 setup.py --quiet sdist
twine upload dist/nutra-X.X.X.tar.gz
Linting & Tests
Install the dependencies (make deps) and then:
# source .venv/bin/activate # uncomment if NOT using direnv
make format lint test
Argcomplete (tab completion on Linux/macOS)
After installing nutra, argcomplete package should also be installed,
Simply run the following out of a bash shell:
activate-global-python-argcomplete
Then you can press tab to fill in or complete subcommands and to list argument flags.
NOTE: This is a work in progress, we are adding more autocomplete functions.
Currently Supported Data
USDA Stock database
Standard reference database (SR28) [7794 foods]
Relative USDA Extensions
Flavonoid, Isoflavonoids, and Proanthocyanidins [1352 foods]
Usage
Requires internet connection to download initial datasets. Run nutra init for this step.
Run the nutra script to output usage.
Usage: nutra [options] <command>
Commands
usage: nutra [-h] [-v] [-d] [--no-pager] {init,nt,search,sort,anl,day,recipe,bio} ... optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit -d, --debug enable detailed error messages --no-pager disable paging (print full output) nutra subcommands: {init,nt,search,sort,anl,day,recipe,bio} init setup profiles, USDA and NT database nt list out nutrients and their info search search foods by name, list overview info sort sort foods by nutrient ID anl analyze food(s) day analyze a DAY.csv file, RDAs optional recipe list and analyze recipes bio view, add, remove biometric logs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.