projecthamster / hamster-cli Goto Github PK

Depends on hamsterlib providing a corresponding writer class.

For now, it will suffice to dump config.ini with the main package.

hamsterlib 0.0.3 requires an aditional config setting which we need to provide.

• config contains a treshold value
• facts below this value will not be saved but discarded.
• option to warn userser about that?!

Depends on hamsterlib providing a corresponding writer class.

Refactor hamstercli to reflect our current best knowlege about our expectations / the backend.

We need to check if our workdir exists, and if not, create it.
While we are at it we should adjust the default config.ini to a saner value.

Command to launch specific gtk windows.

• overview
• statistics
• about

Currently the fixtures has its values hardcoded. By this it douplicates client_config and lib_config fixtures.
It would be desireable if it would construct the file from those two already existing fixtues instead.

While we are at it, we can do a general cleanup of all those config fixtures, removing deprecated keys.

after a temp fact has been started with hamsterlib-cli, it apears this tmp-fact already gets anPK assigned. Once the fact is saved to persistent storage, this obviously breaks...

Right now, if we pass an empty string to start we go all the way until Fact-instantiation until we raise an exception.
We should at least veryfy that we get some string.

See here.

Command to stop tracking of current ongoing fact.

If hamster-gtk is present, provide a way to launch various sub-windows on demand.

Commands like start and list often ask for multiple arguments. Instead treating them as one huge chunk, maybe it is more viable to use Clicks veradic argmuments?!

Arguments containing whitespace needs to be wrapped in quotes, as usual. Main use cases are

• raw_fact
• start (when date-time)
• end (when date-time)

Click allows for one veradic argument. It seems sensible to make use of that for raw_fact. That means that any date-time specified will still have to be wrapped in quotes, but raw facts can be unquoted as CLICK will just assume all extra arguments to be part of raw_fact.

Remove from codebase if not.

Our relevant commands used to handle 'ongoings facts' as part of the client. Now that this functionality is provided by the backend they need to be adjusted.

• stop
• current
• cancel
• start

config options should be renamed "day_start" and "day_end"!

Quite a few tests are without docstring. This should be fixed. :)

Command to list all activities stored in the backend.
ordered by lower(category.name)

cancel -> https://github.com/elbenfreund/hamsterlib/blob/develop/hamsterlib/objects.py#L19

Initial tests offen use 'foobar'-like strings for random content. This should be substitured by apropiate faker instances.
Times will not be trivial to change due to internal logic, but at least simple strings should be trivial.

When no categories are to be returned, still show a short and friendly feedback message.

Right now the export path is equal the work_dir. The resulting files extension is given by the export format.
Its name is static: report.

It would be nice to allow users greater control over these settings.

Command to write facts of a specified timeframe to a file of specified format.
Format:

• html
• tsv
• ical
• xml

Provide basic ways to start and stop recording a new fact. For convinience, also provivde a way to get info on our current fact status.

Mechanics to deal with 'ongoing facts' has been moved to thehamslib backend. As a consequence any reference should be removed from the CLi.

command that lists all activities matching a given term within a given timeframe
This is different to the legacy list command which does not filter by search term but just timeframe.

Parameters:

• start time, optional
• end time, optional
• search terms, optional

Returns:

• A list of Fact instances

Post-legacy releases shoudl unify this command with lists functionality.

right now we only implement "installed mode" via dbus.
the original implementation also provides a "devel mode".
Although we most likly will abandon both of those, for compatibilit reasons want to keep both around.

Our test suite should make use of;

• flake8-debugger
• flake8-print
• flake8-naming

Right now we still carry some older tests that are marked as 'xfail'.
Before release those should be either made functional or removed.

Right now our initial version is set to '0.0.1'.
It would be better to start at '0.1.0' so allow for easier hotfixes after release.

Right now start does two distinct things.

• Add a new complete fact to the backend.
• Start tracking a new ongoing fact.

Both functionalities should be represented by distinct commands.

Depends on hamsterlib providing a corresponding writer class.

the user feedback displayed has a type: 'tracked'

Right now we just assume that config.ini is part of our package.

It would be preferable if
a)
Our client crawl various standart config locations to look for an appropiate config file.
b)
Uses the packaged config file as a template to create a new user specific config file at a fixed location.

It is worth noting that the legacy CLI's list does only allow for a timeframe and not for a search term.
This extended functionality is instread provided by the search (#21) command.

Command to list all categories stored in the backend.

During the broken 0.0.2 release of hamsterlib we disabled proper testing with tox.
Now that 0.0.3 has been released, we can bring it back.

should be checked against the activity name.