Should init_api be part of the library?

[stdedos]

Hello there,

Thank you for the big work on the library - I am super-new here.

I was wondering if e.g.

python-garminconnect/demo.py

Line 4701 in 414b540

def init_api(email: str | None = None, password: str | None = None) -> Garmin | None:

should be a part of the library.

It has a lot of details, handling, and logic (use tokenstore, try to login, explain errors to user) - that people should not implement themselves.

I did a cursory search of the repository - but I didn't find such function as part of the library, e.g.:

• https://github.com/cyberjunky/python-garminconnect/issues?q=sort%3Aupdated-desc%20is%3Aissue%20authenticate
• https://github.com/cyberjunky/python-garminconnect/blob/414b54023a31259232744bb67f00a2aa71065e09/garminconnect/client.py
• https://github.com/cyberjunky/python-garminconnect/blob/414b54023a31259232744bb67f00a2aa71065e09/garminconnect/__init__.py

[cyberjunky]

I don't think so, maybe the retry part, but the rest (token storage, getting MFA code from user) is project specific.
Some wants to store tokens on disks, others in a database, and also the MFA code insertion is different.
I cannot put it in the library.

demo is to demonstrate all possible scenarios.

The real 'init' is :

garmin = Garmin(
    email=email, password=password, is_cn=False, return_on_mfa=True
)

[stdedos]

I get that

garmin = Garmin(
    email=email, password=password, is_cn=False, return_on_mfa=True
)

aka

garmin = Garmin(
    email=os.getenv("GARMIN_EMAIL") or input("Email: ").strip(),
    password=os.getenv("GARMIN_PASSWORD") or getpass("Password: "),
    prompt_mfa=lambda: input("MFA code: ").strip(),
)

could be user-specific.

But also auto-using tokenstorage (if user is using one), and/or storing username/password/token in a credential helper (like https://python-gitlab.readthedocs.io/en/stable/cli-usage.html#credential-helpers) instead of "plaintext" could be offloaded to the library? 😕

But anyway up to you 🙏 I just wanted to surface it

[cyberjunky]

Credential helper using os keyrings would be a good addition yes.

[cyberjunky]

Its kind of legacy, I created this library for my home assistant integration, but created a smaller spinnoff ha-garmin, there i dont store the tokens to file at all (only for testing), its stored in home assistant storage