feat: q3as in default use case template

[Angel-Dijoux]

No description provided.

[jpopesculian]

I like this idea of adding an extra notebook. I would probably rename it to q3as_demo.ipynb and just add some info to the README.md for what that file is. I probably wouldn't link it as a solution ref in the pyproject.toml because there's no input and output in there and that would probably mess people up, but having it as an extra notebook as an example is cool and they can just copy the relevant cells if they do want to use it

[jpopesculian]

hmm, this is a good point. unfortunately because the way that notebooks and the translation to scripts works, using things like importlib.resources is usually the best bet, but it requires that the file be in the package which means it would get uploaded. to handle this correctly, I would say we should make passing the credentials by environment variables possible which would require modifying the q3as client i believe.

[jpopesculian]

What would be really cool too if we use environment variables, is to automatically add q3as credentials to aqora with aqora q3as add-key <PUBLIC> <SECRET> and then have aqora inject it directly into the virtual environment paths when doing aqora install / test so the user just has to set it up once

[Angel-Dijoux]

hmm, this is a good point. unfortunately because the way that notebooks and the translation to scripts works, using things like importlib.resources is usually the best bet, but it requires that the file be in the package which means it would get uploaded. to handle this correctly, I would say we should make passing the credentials by environment variables possible which would require modifying the q3as client i believe.

But for now, the user doesn't send a file. Instead, I ask them to enter their credentials in the notebook. Shouldn't we handle it differently?

What would be really cool too if we use environment variables, is to automatically add q3as credentials to aqora with aqora q3as add-key <PUBLIC> <SECRET> and then have aqora inject it directly into the virtual environment paths when doing aqora install / test so the user just has to set it up once

Maybe is another story if that work for you?

[jpopesculian]

Looks awesome! Just the one thing

[jpopesculian]

i would just change this to import from the environment as a good standard practice for them not to include sensitive data and we can update the SDK to support it in the future. maybe even use python-dotenv?

[jpopesculian]

One last thing: I'd include a .env file at the root of the template with

# Copy your API key ID and secret into the following fields
Q3AS_ID = "<Your Q3AS API key ID>"
Q3AS_SECRET = "<Your Q3AS API key secret>"

[jpopesculian]

Change this to say paste into the .env

[jpopesculian]

Maybe remove this? It seems unnecessary and scary

[Angel-Dijoux]

Since you recommend using a .env file, I wouldn't remove it. I mean, sometimes users might accidentally push credentials! Well, it's fine, I think. I ended up removing it!