Start working with ttrack integration #2

luabida · 2022-06-08T19:14:31Z

Pull Request description

This is a initial branch meant to saving my work for today, but furthermore it will be the implementation of ttrack in the invoices
Working on #1

How to test these changes

Uncomment ttrack.py
copy your .timetrackdb into data_test/
run $python invoicex/ttrack.py from the root of the project

Pull Request checklists

This PR is a:

bug-fix
new feature
maintenance

About this PR:

it includes tests.
the tests are executed on CI.
the tests generate log file(s) (path).
pre-commit hooks were executed locally.
this PR requires a project documentation update.

Author's checklist:

I have reviewed the changes and it contains no misspelling. (DRAFT)
The code is well commented, especially in the parts that contain more complexity. (DRAFT)
New and old tests passed locally. (DRAFT)

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

luabida · 2022-06-14T00:25:56Z

How to test these changes
OPT: choose the month in df = self._filter_by_month()
OPT: choose the tasks in self._get_query()
run $python invoicex/ttrack.py from the root of the project

OBS: If the output is TypeError: 'NoneType' object cannot be interpreted as an integer, you should stop the current task from TTrack and recopy the database.

xmnlab · 2022-06-14T00:36:46Z

pyproject.toml

@@ -26,6 +26,7 @@ black = "^22.3.0"
 flake8 = "^4.0.1"
 isort = "^5.10.1"
 pre-commit = "^2.18.1"
+humanfriendly = "^10.0"


any reason for including this new dep?

btw, adding a new dep to a project could be very impacting ..
be very careful adding a new dep to a project, normally you should have a very good reason for that.

xmnlab · 2022-06-14T00:37:53Z

.gitignore

@@ -1,2 +1,4 @@
 *.env*
 __pycache__
+.vscode/
+data_test/.timetrackdb*


if you will have a sample for tests, (for python projects) you normally add it to/tests/data

xmnlab · 2022-06-14T21:28:47Z

README.md

@@ -24,7 +24,7 @@ Example:
 ```bash
 python invoicex/main.py \
  --year-month 2022-04 \
-  --gh-user xmnlab \
+  --gh-user $USER \


this is just an example, it is not a problem to have a fixed user here.
$USER is a system user, not a gh user, so it will be more confusing

please check this comment

xmnlab · 2022-06-14T21:32:16Z

invoicex/main.py

@@ -5,8 +5,9 @@
 import os
 import time

-import reader
+import invoicex.reader.github as github


Suggested change

import invoicex.reader.github as github

from invoicex.reader import ComposeReader

the idea is to hide all the complexity and use ComposeReader as the main interface for the reading.

ComposeReader will receive the parameters about which datasets/data-sources will be used (for now, we just have github and ttrack)

please check this comment

xmnlab · 2022-06-14T21:32:59Z

invoicex/main.py

 import report
+import invoicex.reader.ttrack as ttrack


Suggested change

import invoicex.reader.ttrack as ttrack

in main.py we don't need to access ttrack nor github .. just ComposeReader

please check this comment

xmnlab · 2022-06-14T21:33:37Z

invoicex/main.py


    return parser


 async def main():
    args = cli_parser().parse_args()
-    results = await reader.get_data(args)
+    results = await github.get_data(args)


ComposeReader will return the data from ttrack and github combined

xmnlab · 2022-06-14T21:35:16Z

invoicex/reader/ttrack.py


-# e = TTrack(TTRACK_DB)
-# print(e())
+def get_data(args) -> pd.DataFrame:


keep in mind that it would be just temporary because ComposeReader will instantiate TTrack inside (probably an attribute called ttrack inside the ComposeReader class)

I'll handle all the comments in next commits, sending now what I got while trying to async TTrack to see if it is correct before externalizing it in ComposeReader

luabida · 2022-06-16T01:24:27Z

How to test these changes

run make ttrack-db
run python invoicex/main.py \
--year-month 2022-06 \
--gh-user $USER \
--gh-org osl-incubator/invoicex \
--timezone "-0400"
--ttrack-task <task>

OBS: If the output is TypeError: 'NoneType' object cannot be interpreted as an integer, you should stop the current task from TTrack and recopy the database.

xmnlab · 2022-06-16T02:14:31Z

.gitignore

@@ -1,2 +1,4 @@
 *.env*
 __pycache__
+.vscode/
+data_test/


if you want a test data folder change it to:

Suggested change

data_test/

tests/data

it is the most common way to do that

xmnlab · 2022-06-16T02:16:18Z

Makefile

+.ONESHELL:
+
+.PHONY:ttrack-db
+ttrack-db:


is it used just for development right? if yes, better to have a name that forces this idea:

Suggested change

ttrack-db:

dev-dump-ttrack-db:

xmnlab · 2022-06-16T02:16:31Z

README.md

@@ -24,7 +24,7 @@ Example:
 ```bash
 python invoicex/main.py \
  --year-month 2022-04 \
-  --gh-user xmnlab \
+  --gh-user $USER \


please check this comment

xmnlab · 2022-06-16T02:16:58Z

invoicex/main.py

@@ -5,8 +5,9 @@
 import os
 import time

-import reader
+import invoicex.reader.github as github


please check this comment

xmnlab · 2022-06-16T02:17:10Z

invoicex/main.py

 import report
+import invoicex.reader.ttrack as ttrack


please check this comment

xmnlab · 2022-06-16T02:17:55Z

invoicex/main.py


    return parser


 async def main():
    args = cli_parser().parse_args()
-    results = await reader.get_data(args)
-    await report.generate(results, args)
+    results = await ttrack.get_data(args)


here you should instantiate the ComposeReader, not the ttrack class

xmnlab · 2022-06-16T02:18:35Z

invoicex/reader/ttrack.py

+        return df_grouped
+
+
+async def get_data(args) -> pd.DataFrame:


you probably will not need this function because all the construction should be done by the ComposeReader

Start working with ttrack integration

fdbc36f

xmnlab reviewed Jun 14, 2022

View reviewed changes

Prepare TTrack to receive external func calls

3924192

luabida force-pushed the ttrack-integration branch from 4fc6257 to 3924192 Compare June 14, 2022 00:38

Isolate reader features

d5139d9

xmnlab reviewed Jun 14, 2022

View reviewed changes

Async TTrack, preparing to integrate with github.py in ComposeReader

695e2fd

xmnlab reviewed Jun 16, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start working with ttrack integration #2

Start working with ttrack integration #2

luabida commented Jun 8, 2022 •

edited

Loading

luabida commented Jun 14, 2022 •

edited

Loading

xmnlab Jun 14, 2022

xmnlab Jun 14, 2022

xmnlab Jun 14, 2022

xmnlab Jun 16, 2022

xmnlab Jun 14, 2022

xmnlab Jun 16, 2022

xmnlab Jun 14, 2022

xmnlab Jun 16, 2022

xmnlab Jun 14, 2022

xmnlab Jun 14, 2022

luabida Jun 16, 2022

luabida commented Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

xmnlab Jun 16, 2022

	import invoicex.reader.github as github
	from invoicex.reader import ComposeReader

Start working with ttrack integration #2

Are you sure you want to change the base?

Start working with ttrack integration #2

Conversation

luabida commented Jun 8, 2022 • edited Loading

Pull Request description

How to test these changes

Pull Request checklists

Additional information

Reviewer's checklist

luabida commented Jun 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luabida commented Jun 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luabida commented Jun 8, 2022 •

edited

Loading

luabida commented Jun 14, 2022 •

edited

Loading