catapulta confortável
1.0.0
?Home • ?Recursos • ?Instalação • ?Uso • Documentação • ?API
✅Requisitos • CLI • ?Docker • ?Limitações
Biblioteca Python para agendar programaticamente fluxos de trabalho ComfyUI por meio da API ComfyUI
| Filial | Status de construção | Compromete-se desde | Última confirmação |
|---|---|---|---|
| Mestre | |||
| Desenvolver |
ComfyUI API Endpoint <| <= Comfy Catapult <=> HTTP Server <| <= Public users
<| <|
<| Your python program <| Your Webui/JS frontend
<| <|
<| Your workflows <|
<| Your HTTP server <|
Comfy Catapult é uma biblioteca para agendar e executar fluxos de trabalho ComfyUI a partir de um programa Python, por meio do endpoint de API existente. O ComfyUI normalmente funciona hospedando esse endpoint de API para sua interface de usuário.
Isso torna mais fácil criar fluxos de trabalho por meio da IU e usá-los em um programa.
# Inside your environment:
# From pypi:
pip install comfy_catapult
# From git:
pip install git+https://github.com/realazthat/[email protected]| Projeto | Wrapper de API ComfyUI | Terceirizar back-end | Distribuir Execução | Encerrar fluxo de trabalho | Estúdio |
|---|---|---|---|---|---|
| CushyStudio | ? | ? | ? | ? | Sim |
| Kit de ferramentas de serviço ComfyUI | X | ? | ? | Sim | ? |
| ComfyUI_NetDist | X | ? | Sim | ? | ? |
| Script_examples do ComfyUI | Sim | Não | Não | Não | Não |
| confortávelui-python-api | ? | ? | ? | Sim | ? |
| comfyui-deploy | ? | ? | ? | Sim | ? |
| Extensão ComfyUI para Python | ? | ? | ? | Sim | ? |
| ComfyScript | ? | ? | ? | Sim | ? |
| hordelib | ? | Sim | ? | ? | ? |
| nuvem confortável | ? | Sim | ? | ? | ? |
| corredor confortável | ? | ? | ? | ? | ? |
| ComfyUI-ComfyRun | ? | ? | ? | ? | ? |
De comfy_catapult/catapult_base.py :
async def Catapult (
self ,
* ,
job_id : JobID ,
prepared_workflow : dict ,
important : Sequence [ APINodeID ],
use_future_api : Literal [ True ],
job_debug_path : Optional [ Path ] = None
) -> Tuple [ JobStatus , 'asyncio.Future[dict]' ]: De examples/sdxlturbo_example_catapulter.py :
class ExampleWorkflowInfo :
# Direct wrapper around the ComfyUI API.
client : ComfyAPIClientBase
# Job scheduler (the main point of this library).
catapult : ComfyCatapultBase
# Something to help with retrieving files from the ComfyUI storage.
remote : RemoteFileAPIBase
comfy_api_url : str
# This should be the workflow json as a dict.
workflow_template_dict : dict
# This should begin as a deep copy of the template.
workflow_dict : dict
# This will hold the node ids that we must have results for.
important : List [ APINodeID ]
# Make this any string unique to this job.
job_id : str
# When the job is complete, this will be the `/history` json/dictionary for
# this job.
job_history_dict : Optional [ dict ]
# These are inputs that modify this particular workflow.
ckpt_name : Optional [ str ]
positive_prompt : str
negative_prompt : str
# For this particular workflow, this will define the path to the output image.
output_path : Path async def RunExampleWorkflow ( * , job_info : ExampleWorkflowInfo ):
# You have to write this function, to change the workflow_dict as you like.
await PrepareWorkflow ( job_info = job_info )
job_id : str = job_info . job_id
workflow_dict : dict = job_info . workflow_dict
important : List [ APINodeID ] = job_info . important
# Here the magic happens, the job is submitted to the ComfyUI server.
status , future = await job_info . catapult . Catapult (
job_id = job_id ,
prepared_workflow = workflow_dict ,
important = important ,
use_future_api = True )
# Wait for the job to complete.
while not future . done ():
status , _ = await job_info . catapult . GetStatus ( job_id = job_id )
print ( f'status: { status } ' , file = sys . stderr )
await asyncio . sleep ( 3 )
job_info . job_history_dict = await future
# Now that the job is done, you have to write something that will go and get
# the results you care about, if necessary.
await DownloadResults ( job_info = job_info )Na interface da web ComfyUI:
Enable Dev mode Options .Save (API format) . opções execute :
Exemplo de uso:
python -m comfy_catapult.cli
execute --workflow-path ./test_data/sdxlturbo_example_api.json
3.8.0, 3.9.0, 3.10.0, 3.11.0, 3.12.0 , testado no fluxo de trabalho do GitHub Actions (./.github/workflows/build-and-test.yml). As imagens do Docker são publicadas em ghcr.io/realazthat/comfy-catapult em cada tag.
# Use the published images at https://ghcr.io/realazthat/comfy-catapult.
docker run --rm --tty ghcr.io/realazthat/comfy-catapult:v3.0.0 --help
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty
-v " ${PWD} :/data "
-e " COMFY_API_URL= ${COMFY_API_URL} "
ghcr.io/realazthat/comfy-catapult:v3.0.0
execute --workflow-path ./test_data/sdxlturbo_example_api.jsonSe você quiser construir a imagem sozinho, poderá usar o Dockerfile no repositório.
# Build the docker image.
docker build -t my-comfy-catapult-image .
# Print usage.
docker run --rm --tty my-comfy-catapult-image --help
# /data in the docker image is the working directory, so paths are simpler.
docker run --rm --tty
-v " ${PWD} :/data "
-e " COMFY_API_URL= ${COMFY_API_URL} "
my-comfy-catapult-image
execute --workflow-path ./test_data/sdxlturbo_example_api.json
Para executar pre.sh (ambiente semelhante ao Linux).
De ./.github/dependencies.yml, que é usado para o GH Action fazer uma nova instalação de tudo:
bash : scripts.
findutils : scripts.
grep : tests.
xxd : tests.
git : scripts, tests.
xxhash : scripts (changeguard).
rsync : out-of-directory test.
jq : dependency for [yq](https://github.com/kislyuk/yq), which is used to generate
the README; the README generator needs to use `tomlq` (which is a part of `yq`)
to query `pyproject.toml`.
Requer pyenv ou uma versão de correspondência exata de python como em ./.python-version.
jq , (instalação) necessário para yq, que é necessário para nossa geração ./README.md , que usa tomlq (do pacote yq) para incluir strings de versão de ./pyproject.toml.
act (para executar a ação GH localmente):
Gerar animação:
docker (para construir a imagem do docker).
develop .git add path/to/file.py .bash scripts/pre.sh , isso irá formatar, lint e testar o código.git status verifique se algo mudou (gerado ./README.md por exemplo), em caso afirmativo, git add as alterações e volte para a etapa anterior.git commit -m "..." .develop (ou pressione para desenvolver se você tiver os direitos). Estas instruções são para mantenedores do projeto.
develop branch: Execute bash ./scripts/pre.sh para garantir que tudo esteja em ordem.develop : coloque a versão em ./pyproject.toml, seguindo os princípios de controle de versão semântico. Modifique também last_release e last_stable_release na tabela [tool.comfy_catapult-project-metadata] conforme apropriado.develop : confirme essas alterações com uma mensagem como "Prepare a versão XYZ". (Veja a seção de contribuições acima).master : mescla o branch develop com o branch master : git checkout master && git merge develop --no-ff .master : Marque o lançamento: Crie uma tag git para o lançamento com git tag -a vX.YZ -m "Version XYZ" .bash ./scripts/utilities/deploy-to-pypi.sh .git push e git push --tags .git checkout develop && git merge master A opção --no-ff adiciona um commit ao branch master para a mesclagem, então reformule o branch de desenvolvimento do branch master.git push origin develop Envie o branch de desenvolvimento para o GitHub.
