Skip to content

Commit 2ffaf5a

Browse files
authored
Merge pull request #46 from upstox/feature/reorganizing-as-upstox-client
feat: changing sdk name
2 parents f7fc193 + 4eb2d15 commit 2ffaf5a

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Upstox Python SDK for API v2
22

3+
[![PyPI](https://img.shields.io/pypi/v/upstox-python-sdk?label=upstox-python-sdk)](https://pypi.python.org/pypi/upstox-python-sdk)
4+
35
## Introduction
46

57
The official Python client for communicating with the <a href="https://upstox.com/uplink/">Upstox API</a>.
@@ -26,9 +28,9 @@ Python 2.7 and 3.4+
2628
If the python package is hosted on Github, you can install directly from Github
2729

2830
```sh
29-
pip install upstox-python
31+
pip install upstox-python-sdk
3032
```
31-
(you may need to run `pip` with root permission: `sudo pip install upstox-python`)
33+
(you may need to run `pip` with root permission: `sudo pip install upstox-python-sdk`)
3234

3335
Then import the package:
3436
```python

setup.cfg

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[metadata]
2+
description-file=README.md
3+
license_files=LICENSE.txt

setup.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@
1212

1313
from setuptools import setup, find_packages # noqa: H301
1414

15-
NAME = "upstox-python"
15+
# read the contents of your README file
16+
from pathlib import Path
17+
this_directory = Path(__file__).parent
18+
long_description = (this_directory / "README.md").read_text()
19+
20+
NAME = "upstox-python-sdk"
1621
VERSION = "2.0.0"
1722
# To install the library, run the following
1823
#
@@ -28,12 +33,11 @@
2833
version=VERSION,
2934
license='MIT',
3035
description="Upstox Developer API",
31-
url="https://upstox.com/uplink/",
36+
url="https://github.com/upstox/upstox-python",
3237
keywords=["Upstox Developer API"],
3338
install_requires=REQUIRES,
3439
packages=find_packages(),
3540
include_package_data=True,
36-
long_description="""\
37-
Build your App on the Upstox platform ![Banner](https://api-v2.upstox.com/api-docs/images/banner.jpg \&quot;banner\&quot;) # Introduction Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection. All requests are over HTTPS and the requests are sent with the content-type ‘application/json’. Developers have the option of choosing the response type as JSON or CSV for a few API calls. To be able to use these APIs you need to create an App in the Developer Console and generate your **apiKey** and **apiSecret**. You can use a redirect URL which will be called after the login flow. If you are a **trader**, you can directly create apps from Upstox mobile app or the desktop platform itself from **Apps** sections inside the **Account** Tab. Head over to &lt;a href&#x3D;\&quot;http://account.upstox.com/developer/apps\&quot; target&#x3D;\&quot;_blank\&quot;&gt;account.upstox.com/developer/apps&lt;/a&gt;.&lt;/br&gt; If you are a **business** looking to integrate Upstox APIs, reach out to us and we will get a custom app created for you in no time. It is highly recommended that you do not embed the **apiSecret** in your frontend app. Create a remote backend which does the handshake on behalf of the frontend app. Marking the apiSecret in the frontend app will make your app vulnerable to threats and potential issues. # noqa: E501
38-
"""
41+
long_description=long_description,
42+
long_description_content_type='text/markdown'
3943
)

0 commit comments

Comments
 (0)