.. DirectReport documentation master file, created by
   sphinx-quickstart on Wed Apr 12 17:35:15 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 3
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`

#############
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
*************

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