From c3ea5e1698beb351bb66796cbb7a7538cc3589e6 Mon Sep 17 00:00:00 2001 From: uJhin Date: Tue, 12 Jan 2021 04:01:47 +0900 Subject: [PATCH] Update Version 1.1.6.13 --- client/python/.gitignore | 132 +++++++++++++++++++++++++++++++++++++++ client/python/LICENSE | 21 +++++++ client/python/README.md | 78 ----------------------- client/python/README.rst | 92 +++++++++++++++++++++++++++ client/python/setup.cfg | 2 +- client/python/setup.py | 3 +- 6 files changed, 248 insertions(+), 80 deletions(-) create mode 100644 client/python/.gitignore create mode 100644 client/python/LICENSE delete mode 100644 client/python/README.md create mode 100644 client/python/README.rst diff --git a/client/python/.gitignore b/client/python/.gitignore new file mode 100644 index 0000000..e02647d --- /dev/null +++ b/client/python/.gitignore @@ -0,0 +1,132 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# vscode settings +.vscode/ \ No newline at end of file diff --git a/client/python/LICENSE b/client/python/LICENSE new file mode 100644 index 0000000..46d4a75 --- /dev/null +++ b/client/python/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 You Jhin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/client/python/README.md b/client/python/README.md deleted file mode 100644 index 0743c62..0000000 --- a/client/python/README.md +++ /dev/null @@ -1,78 +0,0 @@ -![logo](https://raw.githubusercontent.com/uJhin/upbit-client/main/logo/logo.png) - -[Base Repository](https://github.com/uJhin/upbit-client/) - -# Upbit OPEN API Client -- @Author: [ujhin](https://github.com/uJhin) -- @GitHub: https://github.com/uJhin/upbit-client/ -- @Official Documents: https://ujhin.github.io/upbit-client-docs/ - -## Install -- `pip` command -```console -pip install upbit-client -``` - -- `git` command -```console -git clone https://github.com/uJhin/upbit-client.git -``` - -## Simple Examples - -- Check Your API Keys -```python -# /v1/api_keys - -from upbit.client import Upbit - -access_key = "Your Access Key" -secret_key = "Your Secret Key" - -client = Upbit(access_key, secret_key) -print(client.APIKey.APIKey_info().result()) -``` - -- Buy Currency -```python -# /v1/orders - -from upbit.client import Upbit - -access_key = "Your Access Key" -secret_key = "Your Secret Key" - -client = Upbit(access_key, secret_key) -order = client.Order.Order_new( - market='KRW-BTC', - side='bid', - volume='0.1', - price='3000000', - ord_type='limit' -).result() -print(order) -``` - -- Sell Currency -```python -# /v1/orders - -from upbit.client import Upbit - -access_key = "Your Access Key" -secret_key = "Your Secret Key" - -client = Upbit(access_key, secret_key) -order = client.Order.Order_new( - market='KRW-BTC', - side='ask', - volume='0.1', - price='3000000', - ord_type='limit' -).result() -print(order) -``` - -# Donation -- BTC: 3NVw2seiTQddGQwc1apqudKxuTqebpyL3s -- ETH: 0x60dd373f59862d9df776596889b997e24bee42eb diff --git a/client/python/README.rst b/client/python/README.rst new file mode 100644 index 0000000..9346130 --- /dev/null +++ b/client/python/README.rst @@ -0,0 +1,92 @@ +.. image:: https://raw.githubusercontent.com/uJhin/upbit-client/main/logo/logo.png + :align: center + +- `Base Repository `_ +- `Python Upbit Client Repository `_ + +Upbit OPEN API Client +********************** +- @Author: `uJhin `_ +- @GitHub: https://github.com/uJhin/upbit-client/ +- @Official Documents: https://ujhin.github.io/upbit-client-docs/ + +Install +======== +- pip command + +.. code:: console + + pip install upbit-client + +- git command + +.. code:: console + + git clone https://github.com/uJhin/python-upbit-client.git + + +Simple Examples +=============== + +- Check Your API Keys + +.. code:: python + + # /v1/api_keys + + from upbit.client import Upbit + + access_key = "Your Access Key" + secret_key = "Your Secret Key" + + client = Upbit(access_key, secret_key) + print(client.APIKey.APIKey_info().result()) + + +- Buy Currency + +.. code:: python + + # /v1/orders + + from upbit.client import Upbit + + access_key = "Your Access Key" + secret_key = "Your Secret Key" + + client = Upbit(access_key, secret_key) + order = client.Order.Order_new( + market='KRW-BTC', + side='bid', + volume='0.1', + price='3000000', + ord_type='limit' + ).result() + print(order) + + +- Sell Currency + +.. code:: python + + # /v1/orders + + from upbit.client import Upbit + + access_key = "Your Access Key" + secret_key = "Your Secret Key" + + client = Upbit(access_key, secret_key) + order = client.Order.Order_new( + market='KRW-BTC', + side='ask', + volume='0.1', + price='3000000', + ord_type='limit' + ).result() + print(order) + +Donation +********* +- BTC: 3NVw2seiTQddGQwc1apqudKxuTqebpyL3s +- ETH: 0x60dd373f59862d9df776596889b997e24bee42eb diff --git a/client/python/setup.cfg b/client/python/setup.cfg index ade81cd..7226479 100644 --- a/client/python/setup.cfg +++ b/client/python/setup.cfg @@ -1,5 +1,5 @@ [metadata] -description-file = README.md +description-file = README.rst [wheel] universal = True \ No newline at end of file diff --git a/client/python/setup.py b/client/python/setup.py index ee6157b..d89d07b 100644 --- a/client/python/setup.py +++ b/client/python/setup.py @@ -2,7 +2,7 @@ from setuptools import find_packages -with open('README.md') as readme: +with open('README.rst') as readme: long_description = readme.read() setup( @@ -33,5 +33,6 @@ author='ujhin', author_email='ujhin942@gmail.com', description='Upbit OPEN API Client', + long_description_content_type='text/x-rst', long_description=long_description )