Skip to content

Commit bd9dac3

Browse files
committed
readme updated
1 parent 0d685f7 commit bd9dac3

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Table of contents -
2525
* [File Management](#file-management)
2626
* [Utility Functions](#utility-functions)
2727
* [Handling errors](#handling-errors)
28+
* [Development](#development)
2829
* [Support](#support)
2930
* [Links](#links)
3031

@@ -1230,6 +1231,43 @@ except UnknownException, e:
12301231
# Something else happened, which can be unrelated to ImageKit; the reason will be indicated in the message field
12311232
```
12321233

1234+
## Development
1235+
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
1238+
1239+
You will find `sample.py` in root folder.
1240+
1241+
Open `python/sample.py` file and replace placeholder credentials with actual values. You can get the value of [URL-endpoint](https://imagekit.io/dashboard#url-endpoints) from your ImageKit dashboard. API keys can be obtained from the [developer](https://imagekit.io/dashboard/developer/api-keys) section in your ImageKit dashboard.
1242+
1243+
In `sample.py` file, set the following parameters for authentication:
1244+
1245+
```python
1246+
from imagekitio import ImageKit
1247+
imagekit = ImageKit(
1248+
private_key='your private_key',
1249+
public_key='your public_key',
1250+
url_endpoint = 'your url_endpoint'
1251+
)
1252+
```
1253+
1254+
- You will find the dependencies in `python/requirements.txt` file.
1255+
1256+
## Install dependencies
1257+
1258+
To install dependencies that are in the `requirements.txt` file can fire this command to install them:
1259+
1260+
```shell
1261+
pip install -r requirements.txt
1262+
```
1263+
1264+
Now run `sample.py`. If you are using CLI Tool (Terminal/Command prompt), open the project in CLI and execute it.
1265+
1266+
```shell
1267+
cd project-name
1268+
pip install imagekitio # if not installed already
1269+
python sample.py # to run sample.py file
1270+
```
12331271
## Support
12341272

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

0 commit comments

Comments
 (0)