-
Notifications
You must be signed in to change notification settings - Fork 2
- Update README and add more docstrings and comments in code #57
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
Conversation
README.md
Outdated
|
|
||
|
|
||
| ## Installation | ||
| Using uv (recommended): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's replace all this with simple
pip install portus-ai
README.md
Outdated
| ### 2) Open a Portus session and register sources | ||
|
|
||
| ```python | ||
| from portus.api import open_session |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's use instead
import portus
config = portus.LLMConfig(name="gpt-4o-mini", temperature=0)
session = portus.open_session(...)
README.md
Outdated
| ## Quickstart | ||
|
|
||
| ### 1) Create a database connection (SQLAlchemy) | ||
| Do not hard‑code credentials in code. Use env vars or a secret manager. Example with placeholders: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should not give advices in the doc.
We can just show how we read secrets from the env:
user = os.environ.get("DATABASE_USER")
...
url = f"postgresql://{user}:{password}@{host}/{database}"
README.md
Outdated
| ``` | ||
|
|
||
| ## Environment variables | ||
| Copy `.env.example` to `.env` and fill in your keys: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While we use not uv but pip install, there should be another way to specify keys.
Probably we can say:
Specify your API keys in the env vars:
- `OPENAI_API_KEY` — if using OpenAI models
- `ANTHROPIC_API_KEY` — if using Anthropic models
- Optional for local/OAI‑compatible servers:
- `OPENAI_BASE_URL` (aka `api_base_url` in code)
- `OLLAMA_HOST` (e.g., `127.0.0.1:11434`)
|
|
…-docs # Conflicts: # README.md # databao/core/pipe.py # databao/core/session.py
This is Junie-generated additions to project documentations, pls proof-read them before merging, they might have redundant/incorrect information