DirectReport 0.1.0

Direct Report

DirectReport

Overview

Keep track of your accomplishments each day of the workweek, create a report of things you accomplished at the end of the week that you can email to manager. Review progress each quarterly for more effective performance review.

Installing

This project uses a Makefile as a command registry, with the following commands:

• make: list available commands
• make develop: install and build this library and its dependencies using pip
• make build: build the library using setuptools
• make lint: perform static analysis of this library with flake8 and black
• make format: autoformat this library using black
• make annotate: run type checking using mypy
• make test: run automated tests with pytest
• make coverage: run automated tests with pytest and collect coverage information
• make dist: package library for distribution

Adapted From: https://github.com/ColumbiaOSS/example-project-python

Running Direct Report

Overview

Usage: python -m DirectReport [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  launch
  new
  show-list
  

Launch

$ python DirectReport launch

Show-List

Basic

 $ python DirectReport show-list

All

$ python DirectReport show-list --all

Daily

$ python DirectReport show-list --daily

Weekly

$ python DirectReport show-list --weekly