Skip to content

Commit 76406d8

Browse files
author
bshifaw
authored
Appended 'alpha' to entrypoint name, added to installation instructions to ReadMe (#180)
* Appended 'alpha' to entrypoint name, added to the current installation instructions, adding '-alpha' in the readme
1 parent 369fcd9 commit 76406d8

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Current version: 2.0.0
1717
## Examples:
1818

1919
```
20-
cromshell submit workflow.wdl inputs.json options.json dependencies.zip
21-
cromshell status
22-
cromshell -t 20 metadata
23-
cromshell logs -2
20+
cromshell-alpha submit workflow.wdl inputs.json options.json dependencies.zip
21+
cromshell-alpha status
22+
cromshell-alpha -t 20 metadata
23+
cromshell-alpha logs -2
2424
```
2525

2626
## Supported Flags:
@@ -99,8 +99,17 @@ Current version: 2.0.0
9999

100100
## Installation
101101

102+
git clone [email protected]:broadinstitute/cromshell.git
103+
cd cromshell
104+
git checkout cromshell_2.0
102105
pip install .
103106

107+
cromshell-alpha --help
108+
109+
## Uninstallation
110+
111+
pip uninstall cromshell-alpha
112+
104113
## Development
105114

106115
To do development in this codebase, the python3 development package must
@@ -118,7 +127,7 @@ the following commands:
118127

119128
After following the above development environment setup steps, simply type
120129
```
121-
cromshell
130+
cromshell-alpha
122131
```
123132
Note that there is no leading `./` in this command. This is due to the
124133
development setup adding the cromshell python script to your path.

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@
3838
"Programming Language :: Python :: 3.9",
3939
"Programming Language :: Python :: Implementation :: CPython",
4040
],
41-
entry_points={"console_scripts": ["cromshell=cromshell.__main__:main_entry"]},
41+
entry_points={"console_scripts": ["cromshell-alpha=cromshell.__main__:main_entry"]},
4242
include_package_data=True,
4343
)

0 commit comments

Comments
 (0)