feat: initial CLI commit #127

alexandreteles · 2023-11-23T21:24:58Z

for more information, see https://pre-commit.ci

codecov · 2023-11-23T21:28:47Z

Codecov Report

Attention: 187 lines in your changes are missing coverage. Please review.

Comparison is base (71f81f7) 84.35% compared to head (4938fce) 71.51%.

Files	Patch %	Lines
api/github.py	15.62%	81 Missing ⚠️
cli.py	50.00%	50 Missing ⚠️
api/manager.py	25.00%	21 Missing ⚠️
api/compat.py	50.00%	14 Missing ⚠️
api/donations.py	46.15%	7 Missing ⚠️
api/info.py	46.15%	7 Missing ⚠️
api/socials.py	46.15%	7 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##              dev     #127       +/-   ##
===========================================
- Coverage   84.35%   71.51%   -12.84%     
===========================================
  Files          35       37        +2     
  Lines         818     1106      +288     
===========================================
+ Hits          690      791      +101     
- Misses        128      315      +187

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

api/github.py

cli.py

alexandreteles · 2023-11-23T21:54:59Z

Imagine being stopped by code coverage. It couldn't be me.

Anyway, to use the CLI, you will need the following:

The obvious

Install all dependencies. Use poetry install, poetry update, or install from the requirements files.

The not so obvious

Export a GitHub token to your env: export GITHUB_TOKEN=my_amazing_token

Then just ./cli.py

Everything else should be exploratory. The CLI uses the docstrings to generate help, so rewriting is trivial if something isn't clear. I will write instrumentation around it so it can be used from actions, but the design decision about how that can be achieved adequately from calling repositories needs more consideration.

I think the @ReVanced/infrastructure team also lacks people with experience in writing Github actions, so @PalmDevs, I might need your help with this.

oSumAtrIX

Are internal types such as JSONResponse or "dictionary" to be documented in places such as the command spec instead of saying "A json string" or "key value pair"?
I have not reviewed all CLI command descriptions but many were incomplete/incorrect and need to be looked into
Instead of having a release and releases command you should only provide "releases" with additional arguments to specify the tag (including the alias tag "latest") and a list of releases
What is the purpose of the options "get_file_path", "get_filitered_repositories" or "scaffold"?
May be out of scope but, the routes contributors and team could be merged with an argument to only retrieve the contributors that are present in the org (aka the team)

oSumAtrIX · 2023-11-23T23:00:17Z

cli.py

+
+class CLI(object):
+    """
+    CLI for the ReVanced API.


Suggested change

CLI for the ReVanced API.

CLI for ReVanced API.

oSumAtrIX · 2023-11-23T23:00:32Z

cli.py

+            )
+        )
+
+    def get_filtered_repositories(self) -> list[str]:


Missing comment

oSumAtrIX · 2023-11-23T23:00:56Z

cli.py

+                        setattr(self, attr.cli_name or attr_name, attr)
+                        self.__imported_methods.append(attr.cli_name or attr_name)
+
+    def helper(self, name=None):


Missing comment

oSumAtrIX · 2023-11-23T23:01:26Z

api/manager.py

+@cli.helper(name="manager")
+async def cli_root(bootstrap=None, custom_source=None, dev=False) -> dict[str, dict]:
+    """
+    Returns a dictionary containing a list of the main ReVanced tools.


This description is incorrect

oSumAtrIX · 2023-11-23T23:03:04Z

api/compat.py

+@cli.helper(name="tools")
+async def cli_tools() -> dict[str, dict]:
+    """
+    Retrieve a list of releases for a GitHub repository.


Incorrect description

oSumAtrIX · 2023-11-23T23:03:10Z

api/compat.py

+@cli.helper(name="contributors")
+async def cli_contributors() -> dict[str, dict]:
+    """
+    Retrieve a list of releases for a GitHub repository.


Incorrect description

oSumAtrIX · 2023-11-23T23:03:17Z

api/github.py

+    repository: str, per_page: int = 100, page: int = 1
+) -> dict[str, dict]:
+    """
+    Retrieve a list of releases for a GitHub repository.


Incorrect description

oSumAtrIX · 2023-11-23T23:04:11Z

api/github.py

@@ -161,6 +301,42 @@ async def get_contributors(request: Request, repo: str) -> JSONResponse:
    return json(data, status=200)


+@cli.helper(name="project-contributors")


Simplify to "contributors"

oSumAtrIX · 2023-11-23T23:05:45Z

api/github.py

@@ -218,3 +440,31 @@ async def get_team_members(request: Request) -> JSONResponse:
    }

    return json(data, status=200)
+
+
+@cli.helper(name="team-members")


Simplify to "team"

oSumAtrIX · 2023-11-23T23:06:15Z

api/compat.py

+    return json(await generate_contributors_data(), status=200)
+
+
+@cli.helper(name="tools")


May be out of scope for this PR but with the routes manager and patches this route is obsolete

alexandreteles added 2 commits November 23, 2023 18:16

feat: initial CLI commit

08c4a36

chore(deps): bump

42099b4

alexandreteles added the wip This issue relates to something that is still work in progress label Nov 23, 2023

alexandreteles self-assigned this Nov 23, 2023

pre-commit-ci bot and others added 2 commits November 23, 2023 21:25

[pre-commit.ci] auto fixes from pre-commit.com hooks

a10bf73

for more information, see https://pre-commit.ci

fix: requirements.txt

b8f8a8c

alexandreteles requested a review from oSumAtrIX November 23, 2023 21:28

github-advanced-security bot found potential problems Nov 23, 2023

View reviewed changes

api/github.py Dismissed Show dismissed Hide dismissed

api/github.py Dismissed Show dismissed Hide dismissed

api/github.py Dismissed Show dismissed Hide dismissed

cli.py Dismissed Show dismissed Hide dismissed

cli.py Fixed Show fixed Hide fixed

oSumAtrIX removed their request for review November 23, 2023 21:38

fix: remove unused global variable

4938fce

alexandreteles requested a review from a team November 23, 2023 21:44

alexandreteles added testing-needed More testing is needed for this issue wip This issue relates to something that is still work in progress and removed wip This issue relates to something that is still work in progress labels Nov 23, 2023

oSumAtrIX self-requested a review November 23, 2023 22:59

oSumAtrIX requested changes Nov 23, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: initial CLI commit #127

feat: initial CLI commit #127

alexandreteles commented Nov 23, 2023

codecov bot commented Nov 23, 2023 •

edited

alexandreteles commented Nov 23, 2023

oSumAtrIX left a comment

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

oSumAtrIX Nov 23, 2023

		@@ -161,6 +301,42 @@ async def get_contributors(request: Request, repo: str) -> JSONResponse:
		return json(data, status=200)


		@cli.helper(name="project-contributors")

		return json(await generate_contributors_data(), status=200)


		@cli.helper(name="tools")

feat: initial CLI commit #127

Are you sure you want to change the base?

feat: initial CLI commit #127

Conversation

alexandreteles commented Nov 23, 2023

codecov bot commented Nov 23, 2023 • edited

Codecov Report

alexandreteles commented Nov 23, 2023

The obvious

The not so obvious

oSumAtrIX left a 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

Choose a reason for hiding this comment

codecov bot commented Nov 23, 2023 •

edited