Skip to main content

A simple command line app for generating progress report for contributions in the Obsidian vault

Project description


A simple command line app for generating progress report for contributions in the Obsidian vault


Using Pip

$ pip install obsidian-progress-report


$ git clone
$ cd obsidian-progress-report
$ python install


Run with defaults (generate report of all created and updated files for the current month and save in vault's root):

$ obsidian-progress-report <vault>

where vault is a path to the Obsidian's vault directory.

You can also change defaults:

  • -o <name> save to subdirectory of vault, for example: -o Reports
  • -s 2020-01-04 and -e 2020-09-05 to change reporting period
  • -i created or -i updated to include only specific sections
  • -c createdAt for specifying custom frontmatter field on Linux


Since there is no robust way to get file creation date on Linux, you must use YAML frontmatter in your markdown files.

By default the script is searching for created field, but you can change it with -c option. Example:

created: 2020-08-31T00:05:23
# or created: 2020-08-31


# Some note

Report structure

# 2020-08-31 – 2020-08-31

## Created

- [[Test note]]

## Updated

- [[Second note]]
- [[Third note]]


Test locally: python install

Create build: python sdist bdist_wheel

Upload build: twine upload dist/*

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obsidian-progress-report-0.3.0.tar.gz (4.2 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page