Skip to content

Update example in Quickstart #45

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.

Sign up for GitHub

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

Merged
chiragjn merged 2 commits into from
Nov 4, 2025
Merged

Update example in Quickstart #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
478c4cf
Update example in Quickstart
chiragjn Nov 4, 2025
dc4517a
Update script
chiragjn Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions generate_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1170,22 +1170,28 @@ def _generate_home_page(self, client_modules: Dict[str, ClientModuleInfo], outpu

template = Template("""---
title: "TrueFoundry Python SDK"
description: "Complete Python SDK for TrueFoundry - Build, deploy, and manage ML applications"
description: "Complete Python SDK for TrueFoundry - Access and manage resources on TrueFoundry"
---
## Installation

```bash
pip install truefoundry
```

<Tip>
Looking for TypeScript SDK? Check out the [TrueFoundry TypeScript SDK](https://www.npmjs.com/package/truefoundry-sdk)
</Tip>

## Quick Example

```python lines
<CodeGroup>

```python Initialize With API Key lines
from truefoundry import TrueFoundry

# Initialize the client
client = TrueFoundry(
base_url="https://api.truefoundry.com",
base_url="https://your-control-plane-url.truefoundry.com",
api_key="your_api_key"
)

Expand All @@ -1195,6 +1201,17 @@ def _generate_home_page(self, client_modules: Dict[str, ClientModuleInfo], outpu
print(f"Application: {app.name}")
```

```python Using Existing Login Session lines
from truefoundry import client

# List your applications
applications = client.applications.list()
for app in applications:
print(f"Application: {app.name}")
```

</CodeGroup>

## Available Clients

<div className="space-y-0">
Expand Down Expand Up @@ -1235,12 +1252,6 @@ def _generate_home_page(self, client_modules: Dict[str, ClientModuleInfo], outpu
- **Documentation**: Browse through the client documentation above
- **GitHub**: [TrueFoundry Python SDK](https://github.com/truefoundry/truefoundry-python-sdk)
- **Support**: Reach out to our support team for assistance

---

<div className="text-center text-sm text-gray-500 mt-12">
Built with ❤️ by the TrueFoundry team
</div>
""")

content = template.render(
Expand Down