Skip to content

Commit 3cefaeb

Browse files
committed
doc: Update README.md.
1 parent ea04544 commit 3cefaeb

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# pylocatable
22
makes PYthon environment reLOCATABLE.
3-
By running `python pack.py`, you can get a locatable to anywhere python environment tar.gz file. You can control which kind python environment you want by customize your config file.
3+
4+
By running `pack.py` or `pylocatable.sh`, you can get a locatable to anywhere python environment tar.gz file. You can control which kind python environment you want by customize your config file.
5+
6+
BTW, don't worry this will mess your current directory up, since all files and all operations will be handled or executed under `build.path` defined by config file.
47

58

69
## Using Scenarios
7-
* Needs a customized python environment running pyspark job on yarn cluster.
8-
* Needs a specific python environment on a server without a `sudo` account.
9-
* Build a unify python environment both on offline and online environment.
10-
* Build a pre-built python runtime to avoid packaging process when launching a python program.
10+
* Needs a customized python runtime for pyspark job on yarn cluster.
11+
* Needs a specific python runtime on a server without a `sudo` account.
12+
* Builds an unified python runtime both for offline/online/ environment, one-time's packaging, multi-scenarios' using.
13+
* Builds a pre-built python runtime to avoid packaging process when launching a python program.
1114

1215

1316
## How to Run?
1417
Using demo config file and requirements.txt file located at `./files` as example, run
15-
```
18+
```bash
1619
python pack.py --conf_path ./files/centos_config.json
1720
# or
1821
python pack.py --conf_path ./files/ubuntu_config.json
@@ -36,10 +39,10 @@ curl -s https://ghproxy.com/https://raw.githubusercontent.com/innerNULL/pylocata
3639
* **python**:
3740
* **version**: Target python environment version.
3841
* **env_name**: Target python environment name.
39-
* **dep**: Target python environment's dependencies packages, which is, requirement.txt path.
42+
* **dep**: Target python environment's dependencies packages, which is, `requirement.txt` path. Note, no matter you use `pack.py` or `pylocatable.sh`, this path should be an absolute path or **a relative path refer to your current path (the path you execute packaging command)**.
4043
* **post_running**: The command should be executed after `pip install`.
4144
* **build**:
42-
* **path**: The path used to build target python environment. This should be a new path.
45+
* **path**: The directroy under which to execute building target python environment. This should be a new path.
4346
* **pre_running**: The commands should be executed before docker-building stage, usually includes specific file/data movement process.
4447

4548

0 commit comments

Comments
 (0)