Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance configuration management and expand documentation #55

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

jcp
Copy link

@jcp jcp commented Mar 17, 2024

This PR adds a more robust configuration system with a standard naming convention. The main changes are:

  • Added python-dotenv in the main __init__.py to load environment variables.
  • Created a .config directory containing sample configuration files (sample-config.yaml and sample-env.env). Each includes a full list of all possible configuration options.
  • Added an owl setup command to automatically generate config.yaml and .env files in the root directory. Users are prompted to provide their name, and a secure client_token is generated.
  • Introduced export_config_to_env and apply_env_overrides utility functions to enhance the Configuration base model. Configuration options from the config.yaml file are exported as environment variables. The .env takes precedence.
  • Minor changes and improvements to accommodate the configuration adjustments.
  • Added tests to new functionality and the LLMService class.
  • Expanded the documentation, including sections on getting started, server configuration, configuration options, and various installation guides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant