Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@manzt
manzt committed Oct 28, 2024
1 parent f7d499b commit 00b105a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 66 deletions.
90 changes: 30 additions & 60 deletions packages/create-anywidget/__tests__/__snapshots__/index.test.js.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -239,27 +236,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -496,27 +490,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -717,27 +708,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
Open \`example.ipynb\` in JupyterLab, VS Code, or your favorite editor
Expand Down Expand Up @@ -934,27 +922,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -1194,27 +1179,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -1420,27 +1402,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -1678,27 +1657,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down Expand Up @@ -1901,27 +1877,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
Open \`example.ipynb\` in JupyterLab, VS Code, or your favorite editor
Expand Down Expand Up @@ -2118,27 +2091,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ipyfoo
uv add --script foo.py ipyfoo # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
You then need to install the JavaScript dependencies and run the development server.
Expand Down
9 changes: 3 additions & 6 deletions packages/create-anywidget/create.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,27 +168,24 @@ or with [uv](https://github.com/astral-sh/uv):
\`\`\`sh
uv add ${name}
uv add --script foo.py ${name} # add to a standalone script
\`\`\`
## Development
We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.
\`\`\`
\`\`\`sh
uv run jupyter lab example.ipynb
\`\`\`
You can create a .venv for your editor with \`uv sync\`.
Alternatively, you can create a virtual environment and install the package in
*editable* mode with the optional development dependencies:
Alternatively, create and manage your own virtual environment:
\`\`\`sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab
\`\`\`
`;
Expand Down

0 comments on commit 00b105a

Please sign in to comment.