diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..b9c0bed --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "cSpell.ignoreWords": ["Yonghong", "setuptools", "stocksymbolsapi"] +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..aa51a49 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Yonghong Tan + +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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..5f7c19d --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include stock-symbols/data/*.csv +include stock-symbols/data/*.json \ No newline at end of file diff --git a/README.md b/README.md index 785b88b..073595a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -# How to use +# Introduction +This package connects to the stocksymbolsapi that I created and allows you to get list of stock symbols from all major stock exchanges over the world. +# How to use +You need to have an API key # Useful links - https://help.yahoo.com/kb/SLN2310.html diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d754819 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,6 @@ +[build-system] +requires = [ + "setuptools>=54", + "wheel" +] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/stock-symbols/__init__.py b/stock-symbols/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/stock-symbols/get_symbol.py b/stock-symbols/get_symbol.py new file mode 100644 index 0000000..c072ad8 --- /dev/null +++ b/stock-symbols/get_symbol.py @@ -0,0 +1,2 @@ +from importlib import resources +import io \ No newline at end of file