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.

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

feat: update python sdk docs #272

Merged
merged 3 commits into from
Apr 18, 2024
Merged

feat: update python sdk docs #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b73f799
feat: update python sdk docs
philipbalbas Apr 18, 2024
8941e8d
feat: auto generate python docs
philipbalbas Apr 18, 2024
7fc7dd3
fix: remove unused outdated types in docs
philipbalbas Apr 18, 2024
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
49 changes: 49 additions & 0 deletions .github/workflows/generate-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,55 @@ jobs:
commit_message: "doc(sdks/ts): Generate docs for sdks/ts (CI)"
branch: ${{ github.head_ref }}

Generate-Docs-For-Python-SDK:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'actions/setup-python' action is used with version 'v5', which is not a valid release. The latest release of 'actions/setup-python' is 'v3'. Please update the version.

Suggested change
- uses: actions/setup-python@v5
- uses: actions/setup-python@v3

with:
python-version: "3.10"

- name: Install and configure Poetry
uses: snok/install-poetry@v1

- name: Configure Poetry to use .venv
run: |
cd sdks/python
poetry config virtualenvs.in-project true

- name: Cache Poetry virtualenv
uses: actions/cache@v4
with:
path: sdks/python/.venv
key: ${{ runner.os }}-sdks-python-poetry-${{ hashFiles('sdks/python/poetry.lock') }}
restore-keys: |
${{ runner.os }}-sdks-python-poetry-

- name: Cache pytype
uses: actions/cache@v4
with:
path: sdks/python/.pytype
key: ${{ runner.os }}-sdks-python-pytype-${{ hashFiles('sdks/python/**/*.py') }}
restore-keys: |
${{ runner.os }}-sdks-python-pytype-

- name: Install dependencies
run: |
cd sdks/python
poetry install

- name: Generate docs
run: |
cd sdks/python
poetry run poe generate-docs

- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "doc(sdks/python): Generate docs for sdks/python (CI)"
branch: ${{ github.head_ref }}

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
30 changes: 26 additions & 4 deletions docs/python-sdk-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A full list of `Julep Python SDK` project modules.
- [Agent](julep/api/types/agent.md#agent)
- [AgentDefaultSettings](julep/api/types/agent_default_settings.md#agentdefaultsettings)
- [AgentDefaultSettingsPreset](julep/api/types/agent_default_settings_preset.md#agentdefaultsettingspreset)
- [Belief](julep/api/types/belief.md#belief)
- [AgentMetadata](julep/api/types/agent_metadata.md#agentmetadata)
- [ChatInputData](julep/api/types/chat_input_data.md#chatinputdata)
- [Chat Input Data Tool Choice](julep/api/types/chat_input_data_tool_choice.md#chat-input-data-tool-choice)
- [ChatMlMessage](julep/api/types/chat_ml_message.md#chatmlmessage)
Expand All @@ -32,43 +32,65 @@ A full list of `Julep Python SDK` project modules.
- [ChatSettingsResponseFormatType](julep/api/types/chat_settings_response_format_type.md#chatsettingsresponseformattype)
- [Chat Settings Stop](julep/api/types/chat_settings_stop.md#chat-settings-stop)
- [CompletionUsage](julep/api/types/completion_usage.md#completionusage)
- [CreateAgentRequestMetadata](julep/api/types/create_agent_request_metadata.md#createagentrequestmetadata)
- [CreateDoc](julep/api/types/create_doc.md#createdoc)
- [CreateDocMetadata](julep/api/types/create_doc_metadata.md#createdocmetadata)
- [CreateSessionRequestMetadata](julep/api/types/create_session_request_metadata.md#createsessionrequestmetadata)
- [CreateToolRequest](julep/api/types/create_tool_request.md#createtoolrequest)
- [CreateToolRequestType](julep/api/types/create_tool_request_type.md#createtoolrequesttype)
- [CreateUserRequestMetadata](julep/api/types/create_user_request_metadata.md#createuserrequestmetadata)
- [Doc](julep/api/types/doc.md#doc)
- [Entity](julep/api/types/entity.md#entity)
- [Episode](julep/api/types/episode.md#episode)
- [DocMetadata](julep/api/types/doc_metadata.md#docmetadata)
- [FunctionCallOption](julep/api/types/function_call_option.md#functioncalloption)
- [FunctionDef](julep/api/types/function_def.md#functiondef)
- [Function Parameters](julep/api/types/function_parameters.md#function-parameters)
- [GetAgentDocsRequestOrder](julep/api/types/get_agent_docs_request_order.md#getagentdocsrequestorder)
- [GetAgentDocsRequestSortBy](julep/api/types/get_agent_docs_request_sort_by.md#getagentdocsrequestsortby)
- [GetAgentDocsResponse](julep/api/types/get_agent_docs_response.md#getagentdocsresponse)
- [GetAgentMemoriesResponse](julep/api/types/get_agent_memories_response.md#getagentmemoriesresponse)
- [GetAgentToolsResponse](julep/api/types/get_agent_tools_response.md#getagenttoolsresponse)
- [GetHistoryResponse](julep/api/types/get_history_response.md#gethistoryresponse)
- [GetSuggestionsResponse](julep/api/types/get_suggestions_response.md#getsuggestionsresponse)
- [GetUserDocsRequestOrder](julep/api/types/get_user_docs_request_order.md#getuserdocsrequestorder)
- [GetUserDocsRequestSortBy](julep/api/types/get_user_docs_request_sort_by.md#getuserdocsrequestsortby)
- [GetUserDocsResponse](julep/api/types/get_user_docs_response.md#getuserdocsresponse)
- [InputChatMlMessage](julep/api/types/input_chat_ml_message.md#inputchatmlmessage)
- [InputChatMlMessageRole](julep/api/types/input_chat_ml_message_role.md#inputchatmlmessagerole)
- [Instruction](julep/api/types/instruction.md#instruction)
- [JobStatus](julep/api/types/job_status.md#jobstatus)
- [JobStatusState](julep/api/types/job_status_state.md#jobstatusstate)
- [ListAgentsRequestOrder](julep/api/types/list_agents_request_order.md#listagentsrequestorder)
- [ListAgentsRequestSortBy](julep/api/types/list_agents_request_sort_by.md#listagentsrequestsortby)
- [ListAgentsResponse](julep/api/types/list_agents_response.md#listagentsresponse)
- [ListSessionsRequestOrder](julep/api/types/list_sessions_request_order.md#listsessionsrequestorder)
- [ListSessionsRequestSortBy](julep/api/types/list_sessions_request_sort_by.md#listsessionsrequestsortby)
- [ListSessionsResponse](julep/api/types/list_sessions_response.md#listsessionsresponse)
- [ListUsersRequestOrder](julep/api/types/list_users_request_order.md#listusersrequestorder)
- [ListUsersRequestSortBy](julep/api/types/list_users_request_sort_by.md#listusersrequestsortby)
- [ListUsersResponse](julep/api/types/list_users_response.md#listusersresponse)
- [Memory](julep/api/types/memory.md#memory)
- [MemoryAccessOptions](julep/api/types/memory_access_options.md#memoryaccessoptions)
- [MemoryEntitiesItem](julep/api/types/memory_entities_item.md#memoryentitiesitem)
- [NamedToolChoice](julep/api/types/named_tool_choice.md#namedtoolchoice)
- [NamedToolChoiceFunction](julep/api/types/named_tool_choice_function.md#namedtoolchoicefunction)
- [PartialFunctionDef](julep/api/types/partial_function_def.md#partialfunctiondef)
- [PatchAgentRequestMetadata](julep/api/types/patch_agent_request_metadata.md#patchagentrequestmetadata)
- [PatchSessionRequestMetadata](julep/api/types/patch_session_request_metadata.md#patchsessionrequestmetadata)
- [PatchUserRequestMetadata](julep/api/types/patch_user_request_metadata.md#patchuserrequestmetadata)
- [ResourceCreatedResponse](julep/api/types/resource_created_response.md#resourcecreatedresponse)
- [ResourceDeletedResponse](julep/api/types/resource_deleted_response.md#resourcedeletedresponse)
- [ResourceUpdatedResponse](julep/api/types/resource_updated_response.md#resourceupdatedresponse)
- [Session](julep/api/types/session.md#session)
- [SessionMetadata](julep/api/types/session_metadata.md#sessionmetadata)
- [Suggestion](julep/api/types/suggestion.md#suggestion)
- [SuggestionTarget](julep/api/types/suggestion_target.md#suggestiontarget)
- [Tool](julep/api/types/tool.md#tool)
- [Tool Choice Option](julep/api/types/tool_choice_option.md#tool-choice-option)
- [ToolType](julep/api/types/tool_type.md#tooltype)
- [UpdateAgentRequestMetadata](julep/api/types/update_agent_request_metadata.md#updateagentrequestmetadata)
- [UpdateSessionRequestMetadata](julep/api/types/update_session_request_metadata.md#updatesessionrequestmetadata)
- [UpdateUserRequestMetadata](julep/api/types/update_user_request_metadata.md#updateuserrequestmetadata)
- [User](julep/api/types/user.md#user)
- [UserMetadata](julep/api/types/user_metadata.md#usermetadata)
- [Client](julep/client.md#client)
- [Env](julep/env.md#env)
- [Managers](julep/managers/index.md#managers)
Expand Down
Loading
Loading