Metadata-Version: 2.1
Name: health-tracking
Version: 0.0.1
Summary: Parse Apple Health App dump conveniently and create visualizations.
Home-page: https://github.com/se-jaeger/health-tracking
Author: Sebastian Jäger
Author-email: message@sebastian-jaeger.me
License: apache
Project-URL: Documentation, https://github.com/se-jaeger/health-tracking
Description: # Health Tracking
        
        Add a short description here!
        
        
        ## Description
        
        A longer description of your project goes here...
        
        
        ## Installation
        
        In order to set up the necessary environment:
        
        1. create an environment `health-tracking` with the help of [conda],
           ```
           conda env create -f environment.yaml
           ```
        2. activate the new environment with
           ```
           conda activate health-tracking
           ```
        3. install `health-tracking` with:
           ```
           python setup.py install # or `develop`
           ```
        
        Optional and needed only once after `git clone`:
        
        4. install several [pre-commit] git hooks with:
           ```
           pre-commit install
           ```
           and checkout the configuration under `.pre-commit-config.yaml`.
           The `-n, --no-verify` flag of `git commit` can be used to deactivate pre-commit hooks temporarily.
        
        5. install [nbstripout] git hooks to remove the output cells of committed notebooks with:
           ```
           nbstripout --install --attributes notebooks/.gitattributes
           ```
           This is useful to avoid large diffs due to plots in your notebooks.
           A simple `nbstripout --uninstall` will revert these changes.
        
        
        Then take a look into the `scripts` and `notebooks` folders.
        
        
        ## Dependency Management & Reproducibility
        
        1. Always keep your abstract (unpinned) dependencies updated in `environment.yaml` and eventually
           in `setup.cfg` if you want to ship and install your package via `pip` later on.
        2. Create concrete dependencies as `environment.lock.yaml` for the exact reproduction of your
           environment with:
           ```
           conda env export -n health-tracking -f environment.lock.yaml
           ```
           For multi-OS development, consider using `--no-builds` during the export.
        3. Update your current environment with respect to a new `environment.lock.yaml` using:
           ```
           conda env update -f environment.lock.yaml --prune
           ```
        
        
        ## Note
        
        This project has been set up using PyScaffold 3.2.3. For details and usage
        information on PyScaffold see https://pyscaffold.org/.
        
        
        [conda]: https://docs.conda.io/
        [pre-commit]: https://pre-commit.com/
        [Jupyter]: https://jupyter.org/
        [nbstripout]: https://github.com/kynan/nbstripout
        [Google style]: http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
        [dsproject extension]: https://github.com/pyscaffold/pyscaffoldext-dsproject
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >= 3.7
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Provides-Extra: testing
