kellya/task-status
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Compare commits

base: kellya:main
Branches Tags
kellya:main
kellya:develop
kellya:v0.2.3
kellya:v0.2.2
kellya:v0.2.1
kellya:v0.2.0
kellya:v0.1.1
kellya:v0.1.0
..
compare: kellya:develop
Branches Tags
kellya:main
kellya:develop
kellya:v0.2.3
kellya:v0.2.2
kellya:v0.2.1
kellya:v0.2.0
kellya:v0.1.1
kellya:v0.1.0

No commits in common. "main" and "develop" have entirely different histories.
main ... develop

13 changed files with 12 additions and 2670 deletions
Download patch file Download diff file Expand all files Collapse all files

9
.coveragerc
View file

@ -1,9 +0,0 @@
[run]
source =
task_status
omit =
*/__init__.py
[report]
fail_under =
80

1
.envrc
View file

@ -1 +0,0 @@
layout poetry

1
.gitignore vendored
View file

@ -1,3 +1,2 @@
**__pycache__ **__pycache__
dist dist
.coverage

627
.pylintrc
View file

@ -1,627 +0,0 @@
[MASTER]
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code.
extension-pkg-allow-list=
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
# for backward compatibility.)
extension-pkg-whitelist=
# Return non-zero exit code if any of these messages/categories are detected,
# even if score is above --fail-under value. Syntax same as enable. Messages
# specified are enabled, while categories only check already-enabled messages.
fail-on=
# Specify a score threshold to be exceeded before program exits with error.
fail-under=10.0
# Files or directories to be skipped. They should be base names, not paths.
ignore=CVS
# Add files or directories matching the regex patterns to the ignore-list. The
# regex matches against paths.
ignore-paths=
# Files or directories matching the regex patterns are skipped. The regex
# matches against base names, not paths.
ignore-patterns=
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available to use.
jobs=1
# Control the amount of potential inferred values when inferring a single
# object. This can help the performance when dealing with large functions or
# complex, nested conditions.
limit-inference-results=100
# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=
# Pickle collected data for later comparisons.
persistent=yes
# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once). You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
old-raise-syntax,
backtick,
long-suffix,
old-ne-operator,
old-octal-literal,
import-star-module-level,
non-ascii-bytes-literal,
raw-checker-failed,
bad-inline-option,
locally-disabled,
file-ignored,
suppressed-message,
useless-suppression,
deprecated-pragma,
use-symbolic-message-instead,
apply-builtin,
basestring-builtin,
buffer-builtin,
cmp-builtin,
coerce-builtin,
execfile-builtin,
file-builtin,
long-builtin,
raw_input-builtin,
reduce-builtin,
standarderror-builtin,
unicode-builtin,
xrange-builtin,
coerce-method,
delslice-method,
getslice-method,
setslice-method,
no-absolute-import,
old-division,
dict-iter-method,
dict-view-method,
next-method-called,
metaclass-assignment,
indexing-exception,
raising-string,
reload-builtin,
oct-method,
hex-method,
nonzero-method,
cmp-method,
input-builtin,
round-builtin,
intern-builtin,
unichr-builtin,
map-builtin-not-iterating,
zip-builtin-not-iterating,
range-builtin-not-iterating,
filter-builtin-not-iterating,
using-cmp-argument,
eq-without-hash,
div-method,
idiv-method,
rdiv-method,
exception-message-attribute,
invalid-str-codec,
sys-max-int,
bad-python3-import,
deprecated-string-function,
deprecated-str-translate-call,
deprecated-itertools-function,
deprecated-types-field,
next-method-defined,
dict-items-not-iterating,
dict-keys-not-iterating,
dict-values-not-iterating,
deprecated-operator-function,
deprecated-urllib-function,
xreadlines-attribute,
deprecated-sys-function,
exception-escape,
comprehension-escape
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once). See also the "--disable" option for examples.
enable=c-extension-no-member
[REPORTS]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'error', 'warning', 'refactor', and 'convention'
# which contain the number of messages in each category, as well as 'statement'
# which is the total number of statements analyzed. This score is used by the
# global evaluation report (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details.
#msg-template=
# Set the output format. Available formats are text, parseable, colorized, json
# and msvs (visual studio). You can also give a reporter class, e.g.
# mypackage.mymodule.MyReporterClass.
output-format=text
# Tells whether to display a full report or only the messages.
reports=no
# Activate the evaluation score.
score=yes
[REFACTORING]
# Maximum number of nested blocks for function / method body
max-nested-blocks=5
# Complete name of functions that never returns. When checking for
# inconsistent-return-statements if a never returning function is called then
# it will be considered as an explicit return statement and no message will be
# printed.
never-returning-functions=sys.exit,argparse.parse_error
[BASIC]
# Naming style matching correct argument names.
argument-naming-style=snake_case
# Regular expression matching correct argument names. Overrides argument-
# naming-style.
#argument-rgx=
# Naming style matching correct attribute names.
attr-naming-style=snake_case
# Regular expression matching correct attribute names. Overrides attr-naming-
# style.
#attr-rgx=
# Bad variable names which should always be refused, separated by a comma.
bad-names=foo,
bar,
baz,
toto,
tutu,
tata
# Bad variable names regexes, separated by a comma. If names match any regex,
# they will always be refused
bad-names-rgxs=
# Naming style matching correct class attribute names.
class-attribute-naming-style=any
# Regular expression matching correct class attribute names. Overrides class-
# attribute-naming-style.
#class-attribute-rgx=
# Naming style matching correct class constant names.
class-const-naming-style=UPPER_CASE
# Regular expression matching correct class constant names. Overrides class-
# const-naming-style.
#class-const-rgx=
# Naming style matching correct class names.
class-naming-style=PascalCase
# Regular expression matching correct class names. Overrides class-naming-
# style.
#class-rgx=
# Naming style matching correct constant names.
const-naming-style=UPPER_CASE
# Regular expression matching correct constant names. Overrides const-naming-
# style.
#const-rgx=
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
# Naming style matching correct function names.
function-naming-style=snake_case
# Regular expression matching correct function names. Overrides function-
# naming-style.
#function-rgx=
# Good variable names which should always be accepted, separated by a comma.
good-names=i,
j,
k,
ex,
Run,
_
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted
good-names-rgxs=
# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no
# Naming style matching correct inline iteration names.
inlinevar-naming-style=any
# Regular expression matching correct inline iteration names. Overrides
# inlinevar-naming-style.
#inlinevar-rgx=
# Naming style matching correct method names.
method-naming-style=snake_case
# Regular expression matching correct method names. Overrides method-naming-
# style.
#method-rgx=
# Naming style matching correct module names.
module-naming-style=snake_case
# Regular expression matching correct module names. Overrides module-naming-
# style.
#module-rgx=
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
# These decorators are taken in consideration only for invalid-name.
property-classes=abc.abstractproperty
# Naming style matching correct variable names.
variable-naming-style=snake_case
# Regular expression matching correct variable names. Overrides variable-
# naming-style.
#variable-rgx=
[FORMAT]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
# Maximum number of characters on a single line.
max-line-length=100
# Maximum number of lines in a module.
max-module-lines=1000
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
[LOGGING]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `new` is for `{}` formatting.
logging-format-style=old
# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules=logging
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,
XXX,
TODO
# Regular expression of note tags to take in consideration.
#notes-rgx=
[SIMILARITIES]
# Comments are removed from the similarity computation
ignore-comments=yes
# Docstrings are removed from the similarity computation
ignore-docstrings=yes
# Imports are removed from the similarity computation
ignore-imports=no
# Signatures are removed from the similarity computation
ignore-signatures=no
# Minimum lines number of a similarity.
min-similarity-lines=4
[SPELLING]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4
# Spelling dictionary name. Available dictionaries: none. To make it work,
# install the 'python-enchant' package.
spelling-dict=
# List of comma separated words that should be considered directives if they
# appear and the beginning of a comment and should not be checked.
spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
# List of comma separated words that should not be checked.
spelling-ignore-words=
# A path to a file that contains the private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
spelling-store-unknown-words=no
[STRING]
# This flag controls whether inconsistent-quotes generates a warning when the
# character used as a quote delimiter is used inconsistently within a module.
check-quote-consistency=no
# This flag controls whether the implicit-str-concat should generate a warning
# on implicit string concatenation in sequences defined over several lines.
check-str-concat-over-line-jumps=no
[TYPECHECK]
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# Tells whether to warn about missing members when the owner of the attribute
# is inferred to be None.
ignore-none=yes
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference
# can return multiple potential results while evaluating a Python object, but
# some branches might not be evaluated, which results in partial inference. In
# that case, it might be useful to still emit no-member and other checks for
# the rest of the inferred objects.
ignore-on-opaque-inference=yes
# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes=optparse.Values,thread._local,_thread._local
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis). It
# supports qualified module names, as well as Unix pattern matching.
ignored-modules=
# Show a hint with possible names when a member name was not found. The aspect
# of finding the hint is based on edit distance.
missing-member-hint=yes
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance=1
# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices=1
# List of decorators that change the signature of a decorated function.
signature-mutators=
[VARIABLES]
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid defining new builtins when possible.
additional-builtins=
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes
# List of names allowed to shadow builtins
allowed-redefined-builtins=
# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=cb_,
_cb
# A regular expression matching the name of dummy variables (i.e. expected to
# not be used).
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
# Argument names that match this expression will be ignored. Default to name
# with leading underscore.
ignored-argument-names=_.*|^ignored_|^unused_
# Tells whether we should check for unused import in __init__ files.
init-import=no
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
[CLASSES]
# Warn about protected attribute access inside special methods
check-protected-access-in-special-methods=no
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,
__new__,
setUp,
__post_init__
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=_asdict,
_fields,
_replace,
_source,
_make
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=cls
[DESIGN]
# List of qualified class names to ignore when countint class parents (see
# R0901)
ignored-parents=
# Maximum number of arguments for function / method.
max-args=5
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr=5
# Maximum number of branch for function / method body.
max-branches=12
# Maximum number of locals for function / method body.
max-locals=15
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
# Maximum number of return / yield for function / method body.
max-returns=6
# Maximum number of statements in function / method body.
max-statements=50
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
[IMPORTS]
# List of modules that can be imported at any level, not just the top level
# one.
allow-any-import-level=
# Allow wildcard imports from modules that define __all__.
allow-wildcard-with-all=no
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
# Deprecated modules which should not be used, separated by a comma.
deprecated-modules=
# Output a graph (.gv or any supported image format) of external dependencies
# to the given file (report RP0402 must not be disabled).
ext-import-graph=
# Output a graph (.gv or any supported image format) of all (i.e. internal and
# external) dependencies to the given file (report RP0402 must not be
# disabled).
import-graph=
# Output a graph (.gv or any supported image format) of internal dependencies
# to the given file (report RP0402 must not be disabled).
int-import-graph=
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=
# Force import order to recognize a module as part of a third party library.
known-third-party=enchant
# Couples of modules and preferred modules, separated by a comma.
preferred-modules=
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception

88
CHANGELOG.md
View file

@ -1,88 +0,0 @@
# Changelog
## v0.3.0 (2021-10-26)
#### New Features
* add --bullet option to change char in front of list items
Full set of changes: [`v0.2.4...v0.3.0`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.2.4...v0.3.0)
## v0.2.4 (2021-10-25)
#### Fixes
* correct the -deleted to -DELETED to filter out tasks that were deleted
Full set of changes: [`v0.2.3...v0.2.4`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.2.3...v0.2.4)
## v0.2.3 (2021-10-18)
#### Fixes
* correct issue causing the status_report filter to not apply
#### Others
* added tests and configs for linting and coverage
* Updated dependant packages
* removed coveage of main in the if __name__ test
Full set of changes: [`v0.2.2...v0.2.3`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.2.2...v0.2.3)
## v0.2.2 (2021-08-26)
#### Fixes
* Corrected a missing elif that was causing duplicated output when --uuid was specified
* fixed duplicate project adding
#### Refactorings
* remove test dep on build task
#### Others
* Added coverage tests
* Added header and sort tests
Full set of changes: [`v0.2.1...v0.2.2`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.2.1...v0.2.2)
## v0.2.1 (2021-08-23)
#### Fixes
* corrected the issue causing split project entries closes [#1](https://git.admin.franklin.edu/kellya/task-status/issues/1)
* Added handling for empty/no project name
#### Others
* cleanup for linting errors
* Add directory to correct flakes flakiness
* attempt to fix [#1](https://git.admin.franklin.edu/kellya/task-status/issues/1), but instead made it fail the same way with completely different logic
* hopefully fixed tests adding ci tasks to my taskwarrior
* fixed the forced bad entry
* checking in invalid code to force a build fail
Full set of changes: [`v0.2.0...v0.2.1`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.2.0...v0.2.1)
## v0.2.0 (2021-08-19)
#### New Features
* added --header option to display start date of report
#### Others
* added taskrc config for base configuration
* added makefile
* Added __init__.py to try to clean up build errors
* added a useless --help test to verify commit message hook is working
Full set of changes: [`v0.1.1...v0.2.0`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.1.1...v0.2.0)
## v0.1.1 (2021-08-18)
Full set of changes: [`v0.1.0...v0.1.1`](https://git.admin.franklin.edu/kellya/task-status/compare/v0.1.0...v0.1.1)
## v0.1.0 (2021-08-18)
#### New Features
* Added click and --uuid to display task's uuid to aid in cleanup of tasks

43
Makefile
View file

@ -1,43 +0,0 @@
# Set output dir
BUILDDIR=dist
PROJECT_BASE=task_status
#GH/github command used to initiate a release
GH=/usr/bin/gh
test:
pytest -v
build: dir
poetry build
dir:
[ -d $(BUILDDIR) ] || mkdir -p $(BUILDDIR)
clean:
rm -rf $(BUILDDIR)
find . -name __pycache__|xargs rm -rf
poetry-release: build
poetry publish
coverage:
coverage run -m pytest
coverage report -m
pyflakes:
pyflakes ${PROJECT_BASE}
pylint:
pylint --load-plugins=pylint_django --django-settings-module=fam_mac.settings ${PROJECT_BASE}
gh-release: build
#Figure out what the last/most recent build is
$(eval LATEST = $(shell ls -t1 ${BUILDDIR}/*|head -n1))
$(eval TAG = $(shell git describe --abbrev=0))
@echo "Sending $(TAG) to github"
${GH} release create $(TAG) $(LATEST)
release: poetry-release gh-release
.PHONY: dir clean release gh-release poetry-release coverage

53
README.md
View file

@ -1,53 +0,0 @@
# task-status
This utility allows you to generate a list of tasks completed from task warrior
over the last week.
# Installation
Task-status is published in PyPi, so to install you just need to run `pip
install task-status`. This will give you the `task-status` entry point to
execute.
## Prerequirements
In order for this to work, you need to have taskwarrior installed to track
tasks. Addtitionally, taskwarrior needs an additiona "User Defined
Attribute"(UDA) to define the boolean for displaying a task in the report
### Taskwarrior
All of the data comes from taskwarrior, so In order for this to work, [Taskwarrior](https://taskwarrior.org/download/) must
be set up first.
### User-Defined Attribute
The following must be added to your taskrc file.
```
uda.status_report.type=string
uda.status_report.label=status_report
uda.status_report.values=display,hide
uda.status_report.default=display
```
You may either do that by copying and pasting that directly in your taskrc file,
or by running the following:
`task config uda.status_report.type string`
`task config uda.status_report.label status_report`
`task config uda.status_report.values display,hide`
`task config uda.status_report.default display`
This will create the attribute that is used to filter out tasks that are not
desired to show on the report
## Usage
The general usage is to just run `task-status`. It will automatically create a
list of tasks completed from last monday to the time the script is run. You may
run `task-status --help` to see the complete list of options and their
explanation

37
ci/taskrc
View file

@ -1,37 +0,0 @@
# [Created by task 2.6.0 8/19/2021 13:50:54]
# Taskwarrior program configuration file.
# For more documentation, see https://taskwarrior.org or try 'man task', 'man task-color',
# 'man task-sync' or 'man taskrc'
# Here is an example of entries that use the default, override and blank values
# variable=foo -- By specifying a value, this overrides the default
# variable= -- By specifying no value, this means no default
# #variable=foo -- By commenting out the line, or deleting it, this uses the default
# Use the command 'task show' to see all defaults and overrides
# Files
data.location=.task
# To use the default location of the XDG directories,
# move this configuration file from ~/.taskrc to ~/.config/task/taskrc and uncomment below
#data.location=~/.local/share/task
#hooks.location=~/.config/task/hooks
# Color theme (uncomment one to use)
#include light-16.theme
#include light-256.theme
#include dark-16.theme
#include dark-256.theme
#include dark-red-256.theme
#include dark-green-256.theme
#include dark-blue-256.theme
#include dark-violets-256.theme
#include dark-yellow-green.theme
#include dark-gray-256.theme
#include dark-gray-blue-256.theme
#include solarized-dark-256.theme
#include solarized-light-256.theme
#include no-color.theme

1680
poetry.lock generated
View file

File diff suppressed because it is too large Load diff

18
pyproject.toml
View file

@ -1,21 +1,13 @@
[tool.poetry] [tool.poetry]
name = "task-status" name = "task-status"
version = "0.4.1" version = "0.1.0"
description = "Utility to get status data built from taskwarrior" description = "Utility to get status data built from taskwarrior"
authors = ["Alex Kelly <alex.kelly@franklin.edu>"] authors = ["Alex Kelly <alex.kelly@franklin.edu>"]
[tool.poetry.dependencies] [tool.poetry.dependencies]
python = "^3.9" python = "^3.9"
click = "^8.0.1"
python-dateutil = "^2.8.2"
[tool.poetry.group.dev.dependencies] [tool.poetry.dev-dependencies]
pytest = "^6.2.4"
flake8 = "^3.9.2"
python-semantic-release = "^7.19.1"
pylint = "^2.9.6"
coverage = "^5.5"
pytest-cov = "^2.12.1"
[build-system] [build-system]
requires = ["poetry-core>=1.0.0"] requires = ["poetry-core>=1.0.0"]
@ -23,9 +15,3 @@ build-backend = "poetry.core.masonry.api"
[tool.poetry.scripts] [tool.poetry.scripts]
task-status = 'task_status.task_status:main' task-status = 'task_status.task_status:main'
[tool.semantic_release]
version_variable = [
"task_status/task_status.py:__version__",
"pyproject.toml:version"
]

74
task_status/task_status.py
View file

@ -1,80 +1,26 @@
#!/usr/bin/env python #!/usr/bin/env python
""" Get completed tasks from taskwarrior and output a simple report """
import subprocess import subprocess
import json import json
import itertools
import operator
from datetime import date from datetime import date
from dateutil.relativedelta import relativedelta, MO from dateutil.relativedelta import relativedelta, MO
import click
__version__ = "0.3.1"
def validate_tasks(tasks): def main():
""" Validate tasks have a proejct, inject "None" if they don't """
try:
for task in tasks:
test = task["project"]
except KeyError:
task["project"] = "None"
return tasks
@click.command()
@click.option("--bullet", default="*", help="Character to use for bullets in list")
@click.option("--header", is_flag=True, help="Display date header")
@click.option(
"--ignore", multiple=True, help="Project(s) to ignore in the report (can be used multiple times)"
)
@click.option(
"--sort", is_flag=True, default=True, help="Alphabetically sort by project"
)
@click.option("--uuid", is_flag=True, help="Display the task UUID")
@click.version_option(__version__, prog_name="task-status")
def main(uuid, header, bullet, sort, ignore):
"""Main function that does all the work for task_status"""
today = date.today() today = date.today()
last_monday = today + relativedelta(weekday=MO(-2)) last_monday = today + relativedelta(weekday=MO(-2))
task_command = [
"task",
f"end.after:{last_monday}",
"status_report:display",
"-home",
"-DELETED",
"-delegated",
"export",
]
tasks = subprocess.run( tasks = subprocess.run(
task_command, ["task", "+status", f"end.after:{last_monday}", "export"], capture_output=True
capture_output=True,
check=True,
) )
entries = validate_tasks(json.loads(tasks.stdout.decode()))
# Convert ignore tuple to set for faster lookup entries = json.loads(tasks.stdout.decode())
ignored_projects = set(ignore) last_project = ""
for entry in entries:
output_list = [] if entry["project"] != last_project:
project_list = [] last_project = entry["project"]
if header: print(f"* {entry['project']}")
print(f"Reporting from: {last_monday}") print(f"\t* {entry['description']}")
for status_projects, status_entries in itertools.groupby(
entries, key=operator.itemgetter("project")
):
# Skip ignored projects
if status_projects not in ignored_projects and status_projects not in project_list:
project_list.append(status_projects)
output_list.append(list(status_entries))
if sort:
project_list.sort()
for project in project_list:
print(f"{bullet} {project}")
for entry in entries:
if entry["project"] == project and uuid:
print(f'\t{bullet} {entry["description"]} ({entry["uuid"]})')
elif entry["project"] == project:
print(f'\t{bullet} {entry["description"]}')
if __name__ == "__main__": if __name__ == "__main__":
main() # pylint: disable=no-value-for-parameter # pragma: no cover main()

0
tests/__init__.py
View file

51
tests/test_status.py
View file

@ -1,51 +0,0 @@
""" Validate task-status options """
from click.testing import CliRunner
from task_status.task_status import main as task_main
from task_status.task_status import __version__ as task_version
runner = CliRunner()
def test_main():
"""Validate the basic command runs with a successful response"""
response = runner.invoke(task_main)
assert response.exit_code == 0
def test_version():
"""Verify that --version outputs the version and it matches
what the code says it should be"""
response = runner.invoke(task_main, ["--version"])
assert response.exit_code == 0
assert task_version in response.output
def test_uuid():
"""Validate the --uuid option returns successfully"""
response = runner.invoke(task_main, ["--uuid"])
assert response.exit_code == 0
def test_sort():
"""Validate --sort returns successfully"""
response = runner.invoke(task_main, ["--sort"])
assert response.exit_code == 0
def test_header():
"""Validate --header returns successfully"""
response = runner.invoke(task_main, ["--header"])
assert response.exit_code == 0
def test_help():
"""Validate --help returns successfully"""
response = runner.invoke(task_main, ["--help"])
assert response.exit_code == 0
def test_invalid_option():
"""Validate pasing a bad option returns an error"""
# check that task fails successfully!"
response = runner.invoke(task_main, ["--invalid"])
assert response.exit_code == 2