Metadata-Version: 2.1
Name: nostalgia
Version: 0.1.42
Summary: nostalgia enables to self-track and gain insights into your life
Home-page: https://github.com/nostalgia-dev/nostalgia
Author: Pascal van Kooten
Author-email: kootenpv@gmail.com
License: MIT
Description: <p align="center">
          <img src="https://nostalgia-dev.github.io/assets/images/biglogo.png" width="200px" alt="nostalgia"/>
        </p>
        
        [![PyPI](https://img.shields.io/pypi/v/nostalgia.svg?style=flat-square)](https://pypi.python.org/pypi/nostalgia/)
        [![PyPI](https://img.shields.io/pypi/pyversions/nostalgia.svg?style=flat-square)](https://pypi.python.org/pypi/nostalgia/)
        
        ### Ecosystem for combining personal data
        
        Nostalgia will help with gathering data from a variety of sources and enable you to combine them easily.
        
        It's much like [Home Assistant](https://github.com/home-assistant/home-assistant), providing a platform, but then for connecting data instead of IoT devices.
        
        Afterwards, it will help you filter and visualize the data.
        
        The architecture is as follows. You're looking at the core which contains the code for ingesting sources, installing the backend system and allows you to write scripts using Nostalgia Query Language.
        
        If you want to add your own data that is not supported, please for now contact us directly in either [discord](https://discord.gg/nJQfM2A) or [slack](https://bit.ly/2Yre09N) and we'll help you get started. You can also look at the [open issues](https://github.com/nostalgia-dev/nostalgia/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see suggestions for new sources.
        
        
        |Quick Actions:  |   run the timeline  |   query my data  |   contribute  |
        |----------------|---------------------|------------------|---------------|
        
        ### Available Data Bindings
        
        Full list of current [sources](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources).
        
        - Heartrate ([Fitbit](https://github.com/nostalgia-dev/nostalgia_fitbit), [Samsung Watch](https://github.com/nostalgia-dev/nostalgia/blob/master/nostalgia/sources/samsung/README.md))
        - Sleep ([Fitbit](https://github.com/kootenpv/nostalgia_fitbit), [Samsung Watch](https://github.com/nostalgia-dev/nostalgia/blob/master/nostalgia/sources/samsung/README.md), SleepCycle)
        - Places (Google Timeline)
        - Bank Payments (ING)
        - Pictures ([Google Photos](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/google/photos.py))
        - Emails ([Gmail](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/google/gmail.py))
        - App Usage ([Android](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/google/app_usage.py))
        - Calendar ([Google](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/google/calendar.py))
        - Chat Conversations ([WhatsApp](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/whatsapp.py), [Facebook Messages](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/facebook/messages.py))
        - Music listening ([Google Play Music](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/google/play_music.py))
        - Music identification ([Shazam](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/shazam.py))
        - Posts ([Reddit](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/reddit_posts.py), [Facebook](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/facebook/messages.py))
        - File Visits ([Emacs](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/emacs_file_visits.py))
        - Annotated Screenshots (Tesseract)
        - Web ([Nostalgia Chrome Plugin](https://github.com/nostalgia-dev/nostalgia_chrome))
          - Products
          - Events
          - Videos
          - Google Search
          - People
        - Indoor Positioning ([whereami](https://github.com/nostalgia-dev/nostalgia/tree/master/nostalgia/sources/whereami/scheduler.py))
        - Public Transport (MijnOV)
        
        ### Getting started
        
        1. `pip install nostalgia`
        
        1. Follow the instructions for a [source of interest](#available-data-bindings) to ensure it is loaded
        
        1. Use the data in an interactive session (run Python) OR [run the timeline](https://github.com/nostalgia-dev/timeline)
        
        ### Nostalgia Query Language - extending pandas
        
        Given that you have payments, heartrate and google places set up, you could start Python and run:
        
        ```python
        In [15]: from nostalgia.sources.ing_banking.mijn_ing import Payments
        
        payments = Payments.load()
        
        payments.by_card\
                .last_year\
                .in_office_days\
                .during_hours(7, 12)\
                .by_me()\
                .heartrate_above(100)\
                .when_at("amsterdam")\
                .sum()
        
        Out[15]: 7.65 # in euros
        ```
        
        
        This will give the total expenses by card in the last week, but only on work days, at night, when my heart rate is above 80 and I'm in Amsterdam.
        It combined the generic class functionality, together with data from:
        
        - A Payments provider
        - A Location provider
        - A Heartrate provider
        
        ### Contributing
        
        Please contribute the data sources that others could use as well!
        
Platform: any
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: Microsoft
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
