mirror of
https://git.datalinker.icu/ltdrdata/ComfyUI-Manager
synced 2025-12-08 21:54:26 +08:00
add development guide
This commit is contained in:
parent
7fc8ba587e
commit
8159ca5875
1
.env.example
Normal file
1
.env.example
Normal file
@ -0,0 +1 @@
|
|||||||
|
PYPI_TOKEN=your-pypi-token
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -20,3 +20,4 @@ check2.sh
|
|||||||
/venv/
|
/venv/
|
||||||
build
|
build
|
||||||
*.egg-info
|
*.egg-info
|
||||||
|
.env
|
||||||
47
CONTRIBUTING.md
Normal file
47
CONTRIBUTING.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
## Testing Changes
|
||||||
|
|
||||||
|
1. Activate the ComfyUI environment.
|
||||||
|
|
||||||
|
2. Build package locally after making changes.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# from inside the ComfyUI-Manager directory, with the ComfyUI environment activated
|
||||||
|
python -m build
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Install the package locally in the ComfyUI environment.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Uninstall existing package
|
||||||
|
pip uninstall comfyui-manager
|
||||||
|
|
||||||
|
# Install the locale package
|
||||||
|
pip install dist/comfyui-manager-*.whl
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Start ComfyUI.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# after navigating to the ComfyUI directory
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## Manually Publish Test Version to PyPi
|
||||||
|
|
||||||
|
1. Set the `PYPI_TOKEN` environment variable in env file.
|
||||||
|
|
||||||
|
2. If manually publishing, you likely want to use a release candidate version, so set the version in [pyproject.toml](pyproject.toml) to something like `0.0.1rc1`.
|
||||||
|
|
||||||
|
3. Build the package.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m build
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Upload the package to PyPi.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m twine upload dist/* --username __token__ --password $PYPI_TOKEN
|
||||||
|
```
|
||||||
|
|
||||||
|
5. View at https://pypi.org/project/comfyui-manager/
|
||||||
@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
[project]
|
[project]
|
||||||
name = "comfyui-manager"
|
name = "comfyui-manager"
|
||||||
license = { text = "GPL-3.0-only" }
|
license = { text = "GPL-3.0-only" }
|
||||||
version = "4.0"
|
version = "4.0.0-beta.1"
|
||||||
requires-python = ">= 3.9"
|
requires-python = ">= 3.9"
|
||||||
description = "ComfyUI-Manager provides features to install and manage custom nodes for ComfyUI, as well as various functionalities to assist with ComfyUI."
|
description = "ComfyUI-Manager provides features to install and manage custom nodes for ComfyUI, as well as various functionalities to assist with ComfyUI."
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user