Skip to content

Conversation

@dmzolotarev
Copy link
Contributor

This is Junie-generated additions to project documentations, pls proof-read them before merging, they might have redundant/incorrect information

@dmzolotarev dmzolotarev requested a review from kosstbarz October 30, 2025 15:27
README.md Outdated


## Installation
Using uv (recommended):
Copy link
Contributor

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
Copy link
Contributor

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:
Copy link
Contributor

@kosstbarz kosstbarz Nov 3, 2025

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:
Copy link
Contributor

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`)

@mare5x
Copy link
Contributor

mare5x commented Nov 3, 2025

portus to databao 😃 😇

…-docs

# Conflicts:
#	README.md
#	databao/core/pipe.py
#	databao/core/session.py
@dmzolotarev dmzolotarev merged commit dfd1774 into main Nov 3, 2025
1 of 2 checks passed
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.

4 participants