Run TimeTagger by just timetagger

[AlexElvers]

Thank you for this great tool!

Currently, TimeTagger is started by python -m timetagger. I'd like to suggest adding a timetagger console script as an alternative. This command is easier to remember.

By having a console script with the same name as the package, it is possible to install and run TimeTagger using uvx, e.g.: uvx timetagger --version (automatically sets up a temporary venv, installs the package and runs the command) or if you want to try it as long as this change is not released on PyPI: uvx --from=. timetagger --version or uvx --from=git+https://github.com/AlexElvers/timetagger@console-script timetagger

Because the generated console script the imports the specified module (from timetagger.__main__ import main), __name__ is not "__main__" in this case. To support --version, I moved most of the previous __main__.py to _serve.py and added the version info handling and the import of _serve to the new timetagger.__main__:main function.

Please let me know if you generally like this change, if you'd want me to change something or if I missed something. :)

[almarklein]

Hi @AlexElvers thanks for this PR!

The timetagger command is already used by the timetagger_cli package, so we can perhaps call the command timetagger_server.

Could you also put a comment in __main__.py to direct ppl to _serve.py? I've been referring users to __main__.py as an example startup script, than can be copied to run timetagger in a custom way.

[AlexElvers]

Thanks for your response!

I've implemented your suggestions (and merged the changes of the main branch). Besides python -m timetagger, the server can now be started by timetagger_server (or if one want to use uvx when the change is released: uvx --from=timetagger timetagger_server).

Let me know if you have further suggestions. :)

I would suggest to make the simple timetagger_server the preferred way to run the server in the documentation (README.md and docstrings). What do you think?

One thing I noticed: Before my changes, the resources seem to be compiled/collected twice (I don't know why), after my change only once. I think, this is rather an improvement than a problem, right?

Before:

$ python -m timetagger
[INFO 2025-01-08 00:05:27] Collected 14 assets from /home/alex/dev/timetagger/timetagger/common
[INFO 2025-01-08 00:05:27] Compiled pscript from dialogs.py
[INFO 2025-01-08 00:05:27] Compiled pscript from dt.py
[INFO 2025-01-08 00:05:27] Compiled pscript from front.py
[INFO 2025-01-08 00:05:27] Compiled pscript from stores.py
[INFO 2025-01-08 00:05:27] Compiled pscript from tools.py
[INFO 2025-01-08 00:05:27] Compiled pscript from utils.py
[INFO 2025-01-08 00:05:27] Collected 13 assets from /home/alex/dev/timetagger/timetagger/app
[INFO 2025-01-08 00:05:27] Collected 26 assets from /home/alex/dev/timetagger/timetagger/images
[INFO 2025-01-08 00:05:27] Collected 4 assets from /home/alex/dev/timetagger/timetagger/pages
[INFO 2025-01-08 00:05:28] Collected 14 assets from /home/alex/dev/timetagger/timetagger/common
[INFO 2025-01-08 00:05:28] Compiled pscript from dialogs.py
[INFO 2025-01-08 00:05:28] Compiled pscript from dt.py
[INFO 2025-01-08 00:05:28] Compiled pscript from front.py
[INFO 2025-01-08 00:05:28] Compiled pscript from stores.py
[INFO 2025-01-08 00:05:28] Compiled pscript from tools.py
[INFO 2025-01-08 00:05:28] Compiled pscript from utils.py
[INFO 2025-01-08 00:05:28] Collected 13 assets from /home/alex/dev/timetagger/timetagger/app
[INFO 2025-01-08 00:05:28] Collected 26 assets from /home/alex/dev/timetagger/timetagger/images
[INFO 2025-01-08 00:05:28] Collected 4 assets from /home/alex/dev/timetagger/timetagger/pages
[INFO 2025-01-08 00:05:29] Server is starting up

After:

$ python -m timetagger
[INFO 2025-01-08 00:05:01] Collected 14 assets from /home/alex/dev/timetagger/timetagger/common
[INFO 2025-01-08 00:05:01] Compiled pscript from dialogs.py
[INFO 2025-01-08 00:05:01] Compiled pscript from dt.py
[INFO 2025-01-08 00:05:01] Compiled pscript from front.py
[INFO 2025-01-08 00:05:01] Compiled pscript from stores.py
[INFO 2025-01-08 00:05:01] Compiled pscript from tools.py
[INFO 2025-01-08 00:05:01] Compiled pscript from utils.py
[INFO 2025-01-08 00:05:01] Collected 13 assets from /home/alex/dev/timetagger/timetagger/app
[INFO 2025-01-08 00:05:01] Collected 26 assets from /home/alex/dev/timetagger/timetagger/images
[INFO 2025-01-08 00:05:01] Collected 4 assets from /home/alex/dev/timetagger/timetagger/pages
[INFO 2025-01-08 00:05:02] Server is starting up