Skip to content

Commit cece192

Browse files
authored
update readme.
1 parent e4ab6c2 commit cece192

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ Table of contents -
2525
* [File Management](#file-management)
2626
* [Utility Functions](#utility-functions)
2727
* [Handling errors](#handling-errors)
28+
<<<<<<< HEAD
29+
* [Sample](#sample)
30+
=======
2831
* [Development](#development)
32+
>>>>>>> e4ab6c21b8eab0a3dd2cddb179907bce3f8d5221
2933
* [Support](#support)
3034
* [Links](#links)
3135

@@ -1231,10 +1235,18 @@ except UnknownException, e:
12311235
# Something else happened, which can be unrelated to ImageKit; the reason will be indicated in the message field
12321236
```
12331237

1234-
## Development
1238+
## Sample
12351239

1236-
To integrate ImageKit in the Python, the code samples covered here are hosted on Github - https://github.com/imagekit-samples/quickstart/tree/master/python.
1237-
## How to run locally
1240+
### Get & Install local ImageKit Python SDK
1241+
1242+
```bash
1243+
$ git clone https://github.com/imagekit-developer/imagekit-python && cd imagekit-python
1244+
$ pip install -e .
1245+
```
1246+
1247+
### Get samples
1248+
1249+
To integrate ImageKit Samples in the Python, the code samples covered here are hosted on Github - https://github.com/imagekit-samples/quickstart/tree/master/python.
12381250

12391251
You will find `sample.py` in root folder.
12401252

@@ -1250,24 +1262,27 @@ imagekit = ImageKit(
12501262
url_endpoint = 'your url_endpoint'
12511263
)
12521264
```
1253-
1254-
- You will find the dependencies in `python/requirements.txt` file.
1255-
1256-
## Install dependencies
1257-
1265+
12581266
To install dependencies that are in the `requirements.txt` file can fire this command to install them:
12591267

12601268
```shell
1261-
pip install -r requirements.txt
1269+
# You will find the dependencies in `python/requirements.txt` file.
1270+
pip install -r python/requirements.txt
12621271
```
12631272

12641273
Now run `sample.py`. If you are using CLI Tool (Terminal/Command prompt), open the project in CLI and execute it.
12651274

12661275
```shell
1267-
cd project-name
1268-
pip install imagekitio # if not installed already
1269-
python sample.py # to run sample.py file
1276+
# if not installed already
1277+
pip install imagekitio
1278+
1279+
# if installing local sdk
1280+
pip install -e <path_to_local_sdk>
1281+
1282+
# to run sample.py file
1283+
python3 python/sample.py
12701284
```
1285+
12711286
## Support
12721287

12731288
For any feedback or to report any issues or general implementation support, please reach out

0 commit comments

Comments
 (0)