Skip to content

Latest commit

 

History

History
235 lines (166 loc) · 7.74 KB

readme.md

File metadata and controls

235 lines (166 loc) · 7.74 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Year End Analysis

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

In the year 2023, I wanted to keep track of what I did with my year, and what I did at my desk. So I coupled the time keeping I needed to do for my day job along with what I did after work. I was also inspired by r/dataisbeautiful.

This is a personal project that will cover my personal notes from Obsidian and the time keep application Timeular. I wanted to be able to pull my own statisctics and create my own graphs for Timeular that they already provide as well as chart out some of my daily journal stats.

Timeular Summary

Timeular Summary per month

Timeular Summary per tag

(back to top)

Built With

(back to top)

Required Information

  • API Key and Secret from Timeular for the Token
    • This does require at least a personal pro account as of late 2023
    • Need the ability to export data (Stupid paywall if you have API access IMO)
  • Obsidian frontmatter (Now called properties) information.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

DotEnv

pip install python-dotenv

Plotly

pip install plotly

Matplotlib

pip install matplotlib

FrontMatter

pip install python-frontmatter

Jupyter

pip install jupyter

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get your Timeular API Key at https://app.timeular.com/#/settings/account or on the App itself and scroll down to the "API" section

  2. Clone the repo

git clone https://github.com/m1cypher/Year-end-analysis.git

  1. Install Python Modules listed above

  2. Execute Jupyter

jupyter notebook

NOTE You can either create a .env file to add the API information or just go through the prompts at the beginning of the note to have it all placed in for you. If a ".env" is already created, it will skip those prompts.

(back to top)

Usage You would use this to automate the create of yearly stats in your life, assuming you have been collecting them. Maybe post them to r/dataisbeautiful!

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Pull of data from Timeular
  • Pull data from Obsidian
  • Insert data into Jupyter
  • Display data as desired

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @mimircyber - [email protected]

Project Link: https://github.com/m1cypher/Year-end-analysis

(back to top)

Acknowledgments

(back to top)