Skip to main content

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

Project description

obsidian-progress-report

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

Installation

Using Pip

$ pip install obsidian-progress-report

Manual

$ git clone https://github.com/aviskase/obsidian-progress-report
$ cd obsidian-progress-report
$ python setup.py install

Usage

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

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]]

Building

Test locally: python setup.py install

Create build: python setup.py 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.

Files for obsidian-progress-report, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size obsidian_progress_report-0.3.0-py3-none-any.whl (4.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size obsidian-progress-report-0.3.0.tar.gz (4.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page