{"id":16759268,"url":"https://github.com/ncdulo/suppylement","last_synced_at":"2025-04-10T17:14:49.373Z","repository":{"id":40971157,"uuid":"237863974","full_name":"ncdulo/suppylement","owner":"ncdulo","description":"Quick \u0026 easy to use nutritional supplement tracking software.","archived":false,"fork":false,"pushed_at":"2022-06-22T01:01:35.000Z","size":117,"stargazers_count":4,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T15:02:28.000Z","etag":null,"topics":["command-line-interface","command-line-tool","csv","data","nutrition","nutritional-supplements","python","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ncdulo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-03T01:29:48.000Z","updated_at":"2021-06-15T16:32:15.000Z","dependencies_parsed_at":"2022-09-17T03:00:31.173Z","dependency_job_id":null,"html_url":"https://github.com/ncdulo/suppylement","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ncdulo%2Fsuppylement","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ncdulo%2Fsuppylement/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ncdulo%2Fsuppylement/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ncdulo%2Fsuppylement/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ncdulo","download_url":"https://codeload.github.com/ncdulo/suppylement/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248261916,"owners_count":21074225,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line-interface","command-line-tool","csv","data","nutrition","nutritional-supplements","python","python3"],"created_at":"2024-10-13T04:07:44.991Z","updated_at":"2025-04-10T17:14:49.353Z","avatar_url":"https://github.com/ncdulo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Suppylement\n---------\nQuick \u0026 easy to use nutritional supplement tracking software. Simple input via\ncommand line arguments. Data stored in CSV files. Provides output of various\nstatistics when requested.\n\nThe intention of this project is to allow the user to track various types and\namounts of nutritional supplements. This can be helpful when trying a new\nsupplement, or changing things. As you will have a log of what you did, and\nwhen. The ability to run statistics and analysis on the data can be useful as\nwell. Interpretation of the results presented is an exercise for the user ;)\n\nCurrently, there are no plans to add a GUI to this program. The decision was\nmade because it will add an undue layer of complexity to a relatively simple\ndesign. Suppylement aims to be intuitive in it's use on the command line.\n\nSuppylement is still a very new project, having only been created in the end\nof January 2020. The current state is still very much in-progress and very\nmuch unfinished. Most of the functionality has not yet been implemented. Work\nis underway, however. Without giving any sort of time estimates, I think the\nfunctional prototype milestone is not a very far reach once the time is made.\n\nRequirements\n------------\nNote: Other versions of these packages may very well work just fine. This\nis simply the package versions used for this project, and specified in\n`requirements.txt`.\n\n* Python 3.6\n* Pandas 1.0.0\n  * Numpy 1.18.1\n  * Python-dateutil 2.8.1\n  * Pytz 2019.3\n  * Six 1.14.0\n\nInstallation\n------------\nAt the moment, the only supported installation is to directly clone this\nrepository and either run the wrapper script, or run the Python program\ndirectly. In the future `pip` installation is planned to be supported.\n\nThe commands laid out below will clone this repository, create a new virtual\nenvironment for Suppylement to run in, install the dependencies and display\nthe program's help text.\n\n\n```bash\n# Clone the repo\ngit clone https://github.com/ncdulo/suppylement.git\ncd suppylement\n\n# Create a new virtual environment and enable it\n# Requires virtualenvwrapper. Substitute with your own flavor\n# of virtual environment, if desired\nmkvirtualenv suppylement\nworkon suppylement\n\n# Install to user site-packages\npip install .\n\n# Create blank data file\ncp data/blank.csv data/data.csv\n\n# To run via setuptools executable (recommended)\nsuppylement --help\n# To run directly\npython suppylement/main.py --help\n\n# If using virtual environment, to disable it when finished run:\ndeactivate\n\n# Link the executable to `~/.local/bin` so that it's available in `$PATH`\nln -s /path/to/virtual_environment/bin/suppylement /home/user_path/.local/bin/suppylement\n```\n\nUsage\n-----\nSuppylement aims to be simple and intuitive to use. The full set of arguments\nhas not be decided on or implemented yet but anything that is can be listed\nwith the `-h` or `--help` argument. Some basic examples are listed below. Note\nthat some (most) functionality is currently not fully implemented.\n\n```bash\n# Display help\nsuppylement --help\nsuppylement log --help\n\n# List most recent 5 entries\nsuppylement list\n# List most recent 20 entries\nsuppylement list --most-recent 20\n\n# Log a new entry\nsuppylement log 1000 VitaminC\nsuppylement log 250 magnesium-citrate\n\n# Delete the most recent entry\nsuppylement rm\n# Delete the most recent 5 entries\nsuppylement rm --most-recent 5\n\n# View statistics\nsuppylement stats\n# View full statistics\nsuppylement stats --full\n```\n\nDevelopment Goals \u0026 Roadmap\n---------------------------\nStub section for an overview of the current development direction, priorities,\nand goals. The roadmap is planned to be more of a list of features than an\na full-fledged roadmap document.\n\n\nContributing\n------------\nThis will be filled in with a brief overview of some general guidelines for\ncontributing to this project. Also a link to the full text when created.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fncdulo%2Fsuppylement","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fncdulo%2Fsuppylement","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fncdulo%2Fsuppylement/lists"}