adding an env example file

bespokelabsai / curator

Synthetic Data curation for post-training and structured data extraction

https://docs.bespokelabs.ai/bespoke-curator

Apache License 2.0

23 stars 2 forks source link

adding an env example file #133

Open lavishsaluja opened 1 week ago

CharlieJCJ commented 1 week ago

TODO here

[x] update __main__.py for curator-viewer to take environment variables if these exist (but I think perhaps the CLI defaults here are sufficient as well?, I think over configuring in environment variables may cause unnecessary confusions)
[ ] update README for cp .env.example .env operation and how to use .env

lavishsaluja commented 1 week ago

updating main.py task -> yes CLI variables are sufficient, should not over engineer this, removed the viewer config variables
for now skipping adding this on README as a lot more people will be visiting the repo for documentation of package instead of development so should avoid all noise for them. what do you think?

CharlieJCJ commented 1 week ago

for now skipping adding this on README as a lot more people will be visiting the repo for documentation of package instead of development so should avoid all noise for them. what do you think?

I think should place it somewhere on README to reduce onboarding frictions for less experienced developers and have a few words for its purpose can help a lot when we introduce new things that can be configurable.

lavishsaluja commented 1 week ago

@CharlieJCJ just made the change of changing collapsible, thanks for the input. it looks better now.

CharlieJCJ commented 1 week ago

Thanks!

We can merge this after #140 merge, and include part of 0.1.10, since there are some frontend path changes need to address if we introduce the environment variable, and additional testings. In the meantime, can you resolve merge conflict to dev in README.md, thanks

CharlieJCJ commented 1 week ago

A question I'm thinking of is how the README would structure after introducing .env because the current workflow is to do pip install, and no where in prompter and viewer do load_env. Another thing is if user chooses to do the .env thing they would git clone the repo first and the prompter and viewer needs to know where this .env is, which users would poetry install, etc, but then poetry isn't been mentioned at all in the README. Trying to think what's the best way to do here. cc @madiator

lavishsaluja commented 2 days ago

fair @CharlieJCJ - I was just thinking of adding an env for people who want to contribute but I guess best to just totally skip this for now - most people will just use with pip and won't need development side information in README