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

Jump to bottom

Rename CLI to blueapi and deprecate old one #163

Merged
merged 3 commits into from
May 3, 2023
Merged

Rename CLI to blueapi and deprecate old one #163

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
752e975
Deprecated bluesky command and rename it to blueapi
callumforrester May 3, 2023
6f7ca1d
Run new command in container
callumforrester May 3, 2023
ee68030
Change CLI name in docs
callumforrester May 3, 2023
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
2 changes: 1 addition & 1 deletion .devcontainer/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ COPY --from=build /venv/ /venv/
ENV PATH=/venv/bin:$PATH

# change this entrypoint if it is not the same as the repo
ENTRYPOINT ["bluesky"]
ENTRYPOINT ["blueapi"]
CMD ["worker"]
2 changes: 1 addition & 1 deletion docs/developer/tutorials/dev-run.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Start the worker from the command line or vscode:

.. code:: shell

bluesky worker
blueapi worker

.. tab-item:: VSCode

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ dev = [
]

[project.scripts]
bluesky = "blueapi.cli:main"
blueapi = "blueapi.cli:main"
bluesky = "blueapi.cli._deprecated:main"

[project.urls]
GitHub = "https://github.com/DiamondLightSource/blueapi"
Expand Down
11 changes: 11 additions & 0 deletions src/blueapi/cli/_deprecated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from .cli import main

__all__ = ["main"]

DEPRECATION_MESSAGE = (
"WARNING! This command is deprecated, please use >>blueapi instead!"
)

print("*" * len(DEPRECATION_MESSAGE))
print(DEPRECATION_MESSAGE)
print("*" * len(DEPRECATION_MESSAGE))