Skip to main content

Direct Report

Project description

DirectReport

License Issues codecov build GitHub Latest Release ReadTheDocs

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.

Documentation

Github Page

Installing

From Package Manager

Using pip: pip install DirectReport

From Project Files:

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 list

All

$ python DirectReport list --all

Daily

$ python DirectReport list --day

Weekly


$ python DirectReport list --week

Web Interface

Home

Web interface home page - WIP

Screenshot home page for web interface.

List

Web interface for list page - WIP

Screenshot list page for web interface.

Detail

Screenshot detail page for web interface.

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

DirectReport-1.0.0.tar.gz (24.4 kB view hashes)

Uploaded Source

Built Distribution

DirectReport-1.0.0-py3-none-any.whl (33.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page