Update readme
Project description
## How to use
This package provided function *install_magento* for install magento using [magento-apache](https://gitlab.com/general-oil/infrastructure/tree/master/Environment/Magento/DemoPortalApache) running on docker engine.
The function has required params:
+ **env_params**: (type:dict), must contains all below keys:
+ *magento_version*: (type:str) 'x.x.x'
e.g: 2.2.5
+ *sample_data*: (type:bool) True or False
+ *performance_test*: (type:bool) True or False (this key only has effective and required when sample_data is False)
+ *peformance_test_profile*: (type:str) (this key only has effective and required when sample_data is False and performance_test is True)
valid values : 'small', 'medium', 'medium_msite', 'large', 'extra_large'
+ *php_version*: (type:str) 'x.x.x'
e.g: 7.1.20
+ **server_params**: (type:dict) must contains all below keys:
+ *host*: (type:str) remove server ip address
+ *user*: (type:str) remote server username
+ *password*: (type:str) remote server password (if 'KEY_PATH' has value, this key is optional)
+ *key_path*: (type:str) local private key file path to conect to remote server
+ **gitlab_access_token**: (type:str) gitlab_access_token that have permission to access to [infrastructure](https://gitlab.com/general-oil/infrastructure) repo
[How to get gitlab access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
1. Install package *magestore-aim*
2. Import function to other file
```python
from magestore_aim import install_magento
```
3. Execute it and wait for result
This package provided function *install_magento* for install magento using [magento-apache](https://gitlab.com/general-oil/infrastructure/tree/master/Environment/Magento/DemoPortalApache) running on docker engine.
The function has required params:
+ **env_params**: (type:dict), must contains all below keys:
+ *magento_version*: (type:str) 'x.x.x'
e.g: 2.2.5
+ *sample_data*: (type:bool) True or False
+ *performance_test*: (type:bool) True or False (this key only has effective and required when sample_data is False)
+ *peformance_test_profile*: (type:str) (this key only has effective and required when sample_data is False and performance_test is True)
valid values : 'small', 'medium', 'medium_msite', 'large', 'extra_large'
+ *php_version*: (type:str) 'x.x.x'
e.g: 7.1.20
+ **server_params**: (type:dict) must contains all below keys:
+ *host*: (type:str) remove server ip address
+ *user*: (type:str) remote server username
+ *password*: (type:str) remote server password (if 'KEY_PATH' has value, this key is optional)
+ *key_path*: (type:str) local private key file path to conect to remote server
+ **gitlab_access_token**: (type:str) gitlab_access_token that have permission to access to [infrastructure](https://gitlab.com/general-oil/infrastructure) repo
[How to get gitlab access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)
1. Install package *magestore-aim*
2. Import function to other file
```python
from magestore_aim import install_magento
```
3. Execute it and wait for result
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
magestore_aim-1.4.7.tar.gz
(7.4 kB
view hashes)
Built Distribution
Close
Hashes for magestore_aim-1.4.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0267cce70d2cf17ce893b81dbd41b811f9f4ba8eceb4ca7cf6627467de318ebe |
|
MD5 | 9b5920d427d3837df07a4398eeaf752c |
|
BLAKE2b-256 | b81efe13a6fdd2cbcb499f8b8e9770108a9cdf4cfbb973e753e4fc80dec3f083 |