Skip to content

Financial Documentation and Tracking using CSV format and Chart.js directly in Obsidian

License

Notifications You must be signed in to change notification settings

yet-another-tool/obsidian-findoc

Repository files navigation

Findoc Logo

Yet Another Tool - Fin Doc

Obsidian.md plugin to read and edit a CSV file, then use it as a data source to generate charts.

I invite you to create PR and Issues with ideas, improvements and etc.

Report Bug · Request Feature


About

  • Open and Edit CSV Files in Obsidian
  • Generate Charts using the CSV File directly in Obsidian and a Custom Code Block
  • Generate Report using the CSV data.
  • Configurable using Few Settings
  • Support Desktop and Mobile (tested on Windows, MacOS and Iphone)
  • Using Chart.js
  • Line chart, Pie chart and Radar chart
  • Plugin for Obsidian.md
  • Evaluate mathematic expressions directly in the value column, powered by mathjs

Installation and Usage

Full Documentation is available here


Screenshots

See Screenshots here


Changelog

TODO

  • [-] Copy paste is broken while editing a CSV File (not able to reproduce)
  • [] Improve the setting tab (edit, add and remove models)
  • [] Add more functions to process and analyze the data
  • [POC] Add reports in table view

V0.7.2 - Beta - 2024-02-25

  • Fixed chart size, configurable in the style.css

See CHANGELOG


Releases and Github Actions

git tag -a X.Y.Z -m "Version X.Y.Z"
git push origin tags/X.Y.Z

Contributing

  1. Create a Feature Branch
  2. Commit your changes
  3. Push your changes
  4. Create a PR
Working with your local branch

Branch Checkout:

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

Your branch name must starts with [feature|fix|release|chore|hotfix] and use a / before the name; Use hyphens as separator; The prefix correspond to your Kanban tool id (e.g. abc-123)

Keep your branch synced:

git fetch origin
git rebase origin/master

Commit your changes:

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

Follow this convention commitlint for your commit message structure

Push your changes:

git push origin <feature|fix|release|chore|hotfix>/prefix-name

Examples:

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

Local Development

npm install
npm run build

License

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

Contact

| Buy Me A Coffee | Webux Logo Webux Lab |

About

Financial Documentation and Tracking using CSV format and Chart.js directly in Obsidian

Resources

License

Stars

Watchers

Forks

Packages

No packages published