8000 Refactor Makefile, Update Documentation, and Enhance Functionality by asdf8601 · Pull Request #5 · asdf8601/takt · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Refactor Makefile, Update Documentation, and Enhance Functionality #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 10 commits into from
Nov 21, 2023
Merged

Refactor Makefile, Update Documentation, and Enhance Functionality #5

merged 10 commits into from
Nov 21, 2023

Conversation

asdf8601
Copy link
Owner
@asdf8601 asdf8601 commented Nov 18, 2023 •
edited
Loading

This pull request introduces several updates and enhancements to the project. The changes are outlined below:

Makefile Refactoring

  • The Makefile has been refactored to include variables for Python version, virtual environment, and paths to Python and pip within the virtual environment.
  • The help target has been updated to provide a better-formatted output.
  • The build system has been switched from using flit to setuptools.
  • New targets for setting up the development environment, running tests, linting, and formatting code have been added.
  • The release process has been updated to modify the pyproject.toml file with the new version number and to push tags to the repository.

Documentation Improvements

  • The README.md file has been updated to include information about extensibility through plugins and a new section on how to create and share plugins.
  • The usage section has been updated to reflect the new way to display the help message using takt --help.
  • The examples section has been simplified, and the import command has been removed.
  • A new Plugins section has been added to the README.md to encourage users to extend the functionality of the tool.

Code Enhancements

  • The pyproject.toml file now uses setuptools as the build backend and includes a new development version number.
  • The takt.py script has been significantly refactored to improve code organization and readability.
  • New classes and methods have been introduced to handle file management, data aggregation, and command registration.
  • The check-in and check-out functionality has been updated to infer the kind of entry based on the last recorded entry.
  • The summary, wtd (week to date), ytd (year to date), and mtd (month to date) commands have been updated to use the new aggregation logic.
  • Plugin support has been added, 8000 allowing users to extend the functionality of the tool with custom plugins.

These changes aim to improve the maintainability of the codebase, provide clearer documentation for users, and introduce new features that enhance the overall functionality of the tool.

@asdf8601 asdf8601 changed the title enh: refactor Refactor Makefile, Update Documentation, and Enhance Functionality Nov 21, 2023
@asdf8601 asdf8601 merged commit d6021d3 into master Nov 21, 2023
@asdf8601 asdf8601 deleted the enh/plugin-support branch November 21, 2023 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@asdf8601
0