mirror of
https://gitlab.com/simple-stock-bots/simple-stock-bot.git
synced 2025-06-16 07:16:40 +00:00
rename docs to site
This commit is contained in:
parent
b7fc32d865
commit
81e433b08a
0
docs/.gitignore → site/.gitignore
vendored
0
docs/.gitignore → site/.gitignore
vendored
@ -1,23 +1,23 @@
|
|||||||
image: python:3.11
|
image: python:3.11
|
||||||
|
|
||||||
build_site:
|
build_site:
|
||||||
stage: build
|
stage: build
|
||||||
script:
|
script:
|
||||||
- cd ./docs
|
- cd ./site
|
||||||
- pip install -r requirements.txt
|
- pip install -r requirements.txt
|
||||||
- mkdocs build --site-dir ../public --verbose
|
- mkdocs build --site-dir ../public --verbose
|
||||||
artifacts:
|
artifacts:
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
|
|
||||||
deploy_site:
|
deploy_site:
|
||||||
stage: deploy
|
stage: deploy
|
||||||
script:
|
script:
|
||||||
- echo "Publishing site..."
|
- echo "Publishing site..."
|
||||||
dependencies:
|
dependencies:
|
||||||
- build_site
|
- build_site
|
||||||
artifacts:
|
artifacts:
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
rules:
|
rules:
|
||||||
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
||||||
@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"yaml.schemas": {
|
"yaml.schemas": {
|
||||||
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
|
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
|
||||||
},
|
},
|
||||||
"yaml.customTags": [
|
"yaml.customTags": [
|
||||||
"!ENV scalar",
|
"!ENV scalar",
|
||||||
"!ENV sequence",
|
"!ENV sequence",
|
||||||
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
|
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
|
||||||
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
|
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
|
||||||
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
|
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@ -1,21 +1,21 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2019 Anson Biggs
|
Copyright (c) 2019 Anson Biggs
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
in the Software without restriction, including without limitation the rights
|
in the Software without restriction, including without limitation the rights
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
furnished to do so, subject to the following conditions:
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The above copyright notice and this permission notice shall be included in all
|
||||||
copies or substantial portions of the Software.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
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
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
SOFTWARE.
|
SOFTWARE.
|
||||||
@ -1,23 +1,23 @@
|
|||||||
```
|
```
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2019 Anson Biggs
|
Copyright (c) 2019 Anson Biggs
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
in the Software without restriction, including without limitation the rights
|
in the Software without restriction, including without limitation the rights
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
furnished to do so, subject to the following conditions:
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The above copyright notice and this permission notice shall be included in all
|
||||||
copies or substantial portions of the Software.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
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
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
SOFTWARE.
|
SOFTWARE.
|
||||||
```
|
```
|
||||||
@ -1,176 +1,176 @@
|
|||||||
Symbols are used in headings to denote what platforms and symbol types a command supports.
|
Symbols are used in headings to denote what platforms and symbol types a command supports.
|
||||||
|
|
||||||
- Telegram Only :fontawesome-brands-telegram-plane:
|
- Telegram Only :fontawesome-brands-telegram-plane:
|
||||||
- Discord Only :fontawesome-brands-discord:
|
- Discord Only :fontawesome-brands-discord:
|
||||||
- Bot Commands :robot:
|
- Bot Commands :robot:
|
||||||
- Cryptocurrency Support :material-currency-btc:
|
- Cryptocurrency Support :material-currency-btc:
|
||||||
- Stock Market Support :bank:
|
- Stock Market Support :bank:
|
||||||
- OTC Support :dollar:
|
- OTC Support :dollar:
|
||||||
|
|
||||||
## Symbol Detection :material-currency-btc: :bank: :dollar:
|
## Symbol Detection :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
|
The Simple Stock Bot looks at every message it can see and tries to detect stock and cryptocurrency symbols. Stock market tickers are denoted with a single `$` and cryptocurrency coins are denoted with a double `$$`. So getting the price of Tesla is as simple as `$tsla` and Bitcoin `$$btc`. These symbols can be in any part of a message and there can be multiple of them aswell.
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
I wonder how $tsla is affecting the price of $$btc
|
I wonder how $tsla is affecting the price of $$btc
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
|
The current stock price of Tesla Inc is $866.57, the stock is currently up 1.68%
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
|
The current price of Bitcoin is $34,815, the coin is currently down -0.151% for today
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
||||||
|
|
||||||
The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
|
The donate command is used to send money to the bot to help keep it free. The premium stock market data and server rentals add up so any amount helps. See the [Donate](donate.md) page for more information.
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/donate
|
/donate
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
The current stock price of Tesla Inc is $664.315, the stock is
|
The current stock price of Tesla Inc is $664.315, the stock is
|
||||||
currently down -0.99%
|
currently down -0.99%
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## `/intra [symbol]` :bank: :material-currency-btc:
|
## `/intra [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
|
This command makes a chart of a stocks movement since the last market open, or the last 24 hours for cryptocurrency.
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/intra $astr
|
/intra $astr
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
<img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
|
<img src="/img/TgIntraChat.jpg" alt="Tesla Motors Chart" />
|
||||||
<p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
|
<p>Intraday chart for $ASTR from 06 Jul at 09:30 to 06 Jul at 15:59</p>
|
||||||
<p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
|
<p>The current stock price of Astra Space Inc - Class A is $12.47, the stock is currently down -19.39%</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## `/chart [symbol]` :bank: :material-currency-btc:
|
## `/chart [symbol]` :bank: :material-currency-btc:
|
||||||
|
|
||||||
This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
|
This command makes a chart of the last 1 month of trading data up until the day before. For example running it on May 5th creates a chart from April 5th to May 4th.
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/intra $astr
|
/intra $astr
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
<img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
|
<img src="/img/TgChartChat.jpg" alt="Tesla Motors Chart" />
|
||||||
<p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
|
<p>1 Month chart for Ethereum from 07, Jun 2021 to 07, Jul 2021</p>
|
||||||
<p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
|
<p>The current price of Ethereum is $2,389.62, the coin is currently up 2.485% for today</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## `/trending`
|
## `/trending`
|
||||||
|
|
||||||
Gets the latest trending stocks and their change in price
|
Gets the latest trending stocks and their change in price
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/trending
|
/trending
|
||||||
</div>
|
</div>
|
||||||
<pre class="message from">
|
<pre class="message from">
|
||||||
|
|
||||||
🦍Trending on the Stock Bot:
|
🦍Trending on the Stock Bot:
|
||||||
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
$GME: Gamestop Corporation - Class A, 5.06%
|
$GME: Gamestop Corporation - Class A, 5.06%
|
||||||
$MMAT: Meta Materials Inc, 4.77%
|
$MMAT: Meta Materials Inc, 4.77%
|
||||||
$$BTC: Bitcoin, -0.83%
|
$$BTC: Bitcoin, -0.83%
|
||||||
$$ETH: Ethereum, 6.06%
|
$$ETH: Ethereum, 6.06%
|
||||||
$$DOGE: Binance-Peg Dogecoin, 0.14%
|
$$DOGE: Binance-Peg Dogecoin, 0.14%
|
||||||
|
|
||||||
|
|
||||||
💵Trending Stocks:
|
💵Trending Stocks:
|
||||||
━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━
|
||||||
$BBIG: Vinco Ventures Inc, 15.44%
|
$BBIG: Vinco Ventures Inc, 15.44%
|
||||||
$GSAT: Globalstar Inc., -15.32%
|
$GSAT: Globalstar Inc., -15.32%
|
||||||
$AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
|
$AMC: AMC Entertainment Holdings Inc - Class A, 8.77%
|
||||||
$ACIU: AC Immune SA, 16.31%
|
$ACIU: AC Immune SA, 16.31%
|
||||||
$PLTR: Palantir Technologies Inc - Class A, 2.25%
|
$PLTR: Palantir Technologies Inc - Class A, 2.25%
|
||||||
$AAPL: Apple Inc, -0.84%
|
$AAPL: Apple Inc, -0.84%
|
||||||
$XELA: Exela Technologies Inc, 12.61%
|
$XELA: Exela Technologies Inc, 12.61%
|
||||||
$WFC: Wells Fargo & Co., -5.60%
|
$WFC: Wells Fargo & Co., -5.60%
|
||||||
$BAC: Bank Of America Corp., 0.22%
|
$BAC: Bank Of America Corp., 0.22%
|
||||||
$AMD: Advanced Micro Devices Inc., -0.54%
|
$AMD: Advanced Micro Devices Inc., -0.54%
|
||||||
|
|
||||||
|
|
||||||
🦎Trending Crypto:
|
🦎Trending Crypto:
|
||||||
━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━
|
||||||
$$NFD: Feisty Doge NFT, -34.32%
|
$$NFD: Feisty Doge NFT, -34.32%
|
||||||
$$SLP: Smooth Love Potion, -13.02%
|
$$SLP: Smooth Love Potion, -13.02%
|
||||||
$$PVU: Plant vs Undead Token, -1.27%
|
$$PVU: Plant vs Undead Token, -1.27%
|
||||||
$$XED: Exeedme, 1.02%
|
$$XED: Exeedme, 1.02%
|
||||||
$$SOL: Solana, -3.95%
|
$$SOL: Solana, -3.95%
|
||||||
$$BNB: Binance Coin, -0.25%
|
$$BNB: Binance Coin, -0.25%
|
||||||
$$EWT: Energy Web Token, 17.72%
|
$$EWT: Energy Web Token, 17.72%
|
||||||
|
|
||||||
</pre>
|
</pre>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## /help :robot:
|
## /help :robot:
|
||||||
|
|
||||||
Just a simple command to get help in app. Returns a more summarized version of this page.
|
Just a simple command to get help in app. Returns a more summarized version of this page.
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/help
|
/help
|
||||||
</div>
|
</div>
|
||||||
<div class="message from">
|
<div class="message from">
|
||||||
The current stock price of Tesla Inc is $664.315, the stock is
|
The current stock price of Tesla Inc is $664.315, the stock is
|
||||||
currently down -0.99%
|
currently down -0.99%
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## `/status` :robot:
|
## `/status` :robot:
|
||||||
|
|
||||||
This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
|
This command is to get diagnostic information about the bot and the services it is dependant on in order to operate. Any issues should be reported to me. [Contact](contact.md)
|
||||||
|
|
||||||
<div class="phone">
|
<div class="phone">
|
||||||
<div class="messages-wrapper">
|
<div class="messages-wrapper">
|
||||||
<div class="message to">
|
<div class="message to">
|
||||||
/status
|
/status
|
||||||
</div>
|
</div>
|
||||||
<pre class="message from">
|
<pre class="message from">
|
||||||
Bot Status:
|
Bot Status:
|
||||||
It took 0.783369 seconds for the bot to get your message.
|
It took 0.783369 seconds for the bot to get your message.
|
||||||
|
|
||||||
Stock Market Data:
|
Stock Market Data:
|
||||||
marketdata.app is currently not reporting any issues with its API.
|
marketdata.app is currently not reporting any issues with its API.
|
||||||
|
|
||||||
Cryptocurrency Data:
|
Cryptocurrency Data:
|
||||||
CoinGecko API responded that it was OK in 0.160962 Seconds.
|
CoinGecko API responded that it was OK in 0.160962 Seconds.
|
||||||
</pre>
|
</pre>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
|
## Inline Features :fontawesome-brands-telegram: :material-currency-btc: :bank: :dollar:
|
||||||
|
|
||||||
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
|
You can type @SimpleStockBot `[search]` in any chat or direct message to search for the stock bots
|
||||||
full list of stock symbols and return the price of the ticker. Then once you select the ticker
|
full list of stock symbols and return the price of the ticker. Then once you select the ticker
|
||||||
want the bot will send a message as you in that chat with the latest stock price.
|
want the bot will send a message as you in that chat with the latest stock price.
|
||||||
The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
|
The bot also looks at every message in any chat it is in for stock symbols.Symbols start with a
|
||||||
`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
|
`$` followed by the stock symbol. For example:$tsla would return price information for Tesla Motors.
|
||||||
@ -1,8 +1,8 @@
|
|||||||
# I Would Love to Hear From You!
|
# I Would Love to Hear From You!
|
||||||
|
|
||||||
Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
|
Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
|
||||||
|
|
||||||
- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
|
- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
|
||||||
- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
|
- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
|
||||||
- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
|
- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
|
||||||
- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).
|
- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).
|
||||||
@ -1,21 +1,21 @@
|
|||||||
# Support Simple Stock Bot
|
# Support Simple Stock Bot
|
||||||
|
|
||||||
Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
|
Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
|
||||||
|
|
||||||
Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
|
Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
|
||||||
|
|
||||||
For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
|
For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||||
|
|
||||||
Should you have any inquiries, feel free to get in [touch](contact.md).
|
Should you have any inquiries, feel free to get in [touch](contact.md).
|
||||||
|
|
||||||
## Additional Support:
|
## Additional Support:
|
||||||
|
|
||||||
Your engagement also counts as support! Here are other ways to contribute:
|
Your engagement also counts as support! Here are other ways to contribute:
|
||||||
|
|
||||||
- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
|
- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
|
||||||
- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
|
- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
|
||||||
- If you plan to host your own bot, consider using my referral links:
|
- If you plan to host your own bot, consider using my referral links:
|
||||||
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
|
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
|
||||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||||
|
|
||||||
Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.
|
Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.
|
||||||
@ -1,47 +1,47 @@
|
|||||||
# Self-Hosting Guide
|
# Self-Hosting Guide
|
||||||
|
|
||||||
This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
|
This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
|
||||||
|
|
||||||
## Pre-requisites
|
## Pre-requisites
|
||||||
|
|
||||||
Ensure the following are installed or obtained before proceeding:
|
Ensure the following are installed or obtained before proceeding:
|
||||||
|
|
||||||
- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
|
- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
|
||||||
- **API Keys**:
|
- **API Keys**:
|
||||||
- **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
|
- **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
|
||||||
- **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
|
- **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
|
||||||
- **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
- **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||||
|
|
||||||
!!! tip
|
!!! tip
|
||||||
The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
|
The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
|
To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
|
||||||
|
|
||||||
## Setup Instructions
|
## Setup Instructions
|
||||||
|
|
||||||
1. **Download/Clone the Repository**:
|
1. **Download/Clone the Repository**:
|
||||||
- Download or clone this repository to your local machine.
|
- Download or clone this repository to your local machine.
|
||||||
|
|
||||||
2. **Configure Environment Variables**:
|
2. **Configure Environment Variables**:
|
||||||
- Navigate to the project directory and locate the `.env` file.
|
- Navigate to the project directory and locate the `.env` file.
|
||||||
- Fill in the `.env` file with your obtained API keys:
|
- Fill in the `.env` file with your obtained API keys:
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
MARKETDATA=your_marketdata_api_key
|
MARKETDATA=your_marketdata_api_key
|
||||||
STRIPE=your_stripe_api_key
|
STRIPE=your_stripe_api_key
|
||||||
TELEGRAM=your_telegram_api_key
|
TELEGRAM=your_telegram_api_key
|
||||||
DISCORD=your_discord_api_key
|
DISCORD=your_discord_api_key
|
||||||
```
|
```
|
||||||
|
|
||||||
Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
|
Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
|
||||||
|
|
||||||
3. **Build and Run the Bot:**
|
3. **Build and Run the Bot:**
|
||||||
- Open a terminal in the project directory.
|
- Open a terminal in the project directory.
|
||||||
- Build and run both bots using Docker Compose:
|
- Build and run both bots using Docker Compose:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose up
|
docker-compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.
|
Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.
|
||||||
|
Before Width: | Height: | Size: 467 KiB After Width: | Height: | Size: 467 KiB |
|
Before Width: | Height: | Size: 433 KiB After Width: | Height: | Size: 433 KiB |
|
Before Width: | Height: | Size: 455 KiB After Width: | Height: | Size: 455 KiB |
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 486 KiB |
|
Before Width: | Height: | Size: 490 KiB After Width: | Height: | Size: 490 KiB |
|
Before Width: | Height: | Size: 474 KiB After Width: | Height: | Size: 474 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
@ -1,31 +1,31 @@
|
|||||||
# Elevate Your Groupchats with Real-time Stock Insights
|
# Elevate Your Groupchats with Real-time Stock Insights
|
||||||
|
|
||||||
Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
|
Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
|
||||||
|
|
||||||
## [Commands](commands.md)
|
## [Commands](commands.md)
|
||||||
|
|
||||||
### Real-Time Stock and Cryptocurrency Updates
|
### Real-Time Stock and Cryptocurrency Updates
|
||||||
- Get live price updates of stocks and cryptocurrencies.
|
- Get live price updates of stocks and cryptocurrencies.
|
||||||
- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
|
- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
|
||||||
|
|
||||||
### Intraday and Historical Data Visualization
|
### Intraday and Historical Data Visualization
|
||||||
- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
|
- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
|
||||||
- `/chart`: Provides a chart of the last month's trading data up till the day before.
|
- `/chart`: Provides a chart of the last month's trading data up till the day before.
|
||||||
|
|
||||||
### Trending Assets Awareness
|
### Trending Assets Awareness
|
||||||
- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
|
- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
|
||||||
|
|
||||||
### In-App Assistance and Support
|
### In-App Assistance and Support
|
||||||
- `/help`: Provides a quick summary of available commands for easy reference.
|
- `/help`: Provides a quick summary of available commands for easy reference.
|
||||||
- `/donate`: Support the maintenance of the bot to ensure continued free access.
|
- `/donate`: Support the maintenance of the bot to ensure continued free access.
|
||||||
|
|
||||||
### User-Friendly Interaction
|
### User-Friendly Interaction
|
||||||
- Easy symbol and command usage for a smooth user experience.
|
- Easy symbol and command usage for a smooth user experience.
|
||||||
- Engage with a community of financial enthusiasts and share insights effortlessly.
|
- Engage with a community of financial enthusiasts and share insights effortlessly.
|
||||||
|
|
||||||
## [Contact](contact.md)
|
## [Contact](contact.md)
|
||||||
Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
|
Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
|
||||||
|
|
||||||
## Powered by MarketData.app
|
## Powered by MarketData.app
|
||||||
|
|
||||||
Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.
|
Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.
|
||||||
@ -1,40 +1,40 @@
|
|||||||
/* https://codepen.io/RG/pen/bdfDI */
|
/* https://codepen.io/RG/pen/bdfDI */
|
||||||
.phone {
|
.phone {
|
||||||
background: none repeat scroll 0 0 #fff;
|
background: none repeat scroll 0 0 #fff;
|
||||||
/*border-left: 1px solid #ccc;
|
/*border-left: 1px solid #ccc;
|
||||||
border-right: 1px solid #ccc;*/
|
border-right: 1px solid #ccc;*/
|
||||||
color: #ffffff;
|
color: #ffffff;
|
||||||
font-family: sans-serif;
|
font-family: sans-serif;
|
||||||
line-height: 20px;
|
line-height: 20px;
|
||||||
width: 80%;
|
width: 80%;
|
||||||
margin: 0 auto;
|
margin: 0 auto;
|
||||||
overflow-x: hidden;
|
overflow-x: hidden;
|
||||||
position: relative;
|
position: relative;
|
||||||
border-radius: 10px;
|
border-radius: 10px;
|
||||||
margin: 50px;
|
margin: 50px;
|
||||||
}
|
}
|
||||||
.messages-wrapper {
|
.messages-wrapper {
|
||||||
position: relative;
|
position: relative;
|
||||||
}
|
}
|
||||||
.message {
|
.message {
|
||||||
margin: 10px;
|
margin: 10px;
|
||||||
padding: 15px 20px;
|
padding: 15px 20px;
|
||||||
position: relative;
|
position: relative;
|
||||||
overflow-x: auto;
|
overflow-x: auto;
|
||||||
}
|
}
|
||||||
.message.to {
|
.message.to {
|
||||||
border-radius: 20px 0px 20px 20px;
|
border-radius: 20px 0px 20px 20px;
|
||||||
background-color: #2095fe;
|
background-color: #2095fe;
|
||||||
color: #fff;
|
color: #fff;
|
||||||
margin-left: 20%;
|
margin-left: 20%;
|
||||||
}
|
}
|
||||||
.message.from {
|
.message.from {
|
||||||
border-radius: 20px 20px 20px 0px;
|
border-radius: 20px 20px 20px 0px;
|
||||||
background-color: #e5e4e9;
|
background-color: #e5e4e9;
|
||||||
color: #363636;
|
color: #363636;
|
||||||
margin-right: 20%;
|
margin-right: 20%;
|
||||||
}
|
}
|
||||||
.message.to + .message.to,
|
.message.to + .message.to,
|
||||||
.message.from + .message.from {
|
.message.from + .message.from {
|
||||||
margin-top: -7px;
|
margin-top: -7px;
|
||||||
}
|
}
|
||||||
@ -1,79 +1,79 @@
|
|||||||
site_name: Simple Stock Bot
|
site_name: Simple Stock Bot
|
||||||
site_url: https://simplestockbot.com
|
site_url: https://simplestockbot.com
|
||||||
edit_uri: /simple-stock-bots/site/tree/master/docs
|
edit_uri: /simple-stock-bots/site/tree/master/site
|
||||||
repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
|
repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
|
||||||
repo_name: Simple Stock Bots
|
repo_name: Simple Stock Bots
|
||||||
|
|
||||||
site_description: Simple Discord and Telegram chat bots for Stock Market Data.
|
site_description: Simple Discord and Telegram chat bots for Stock Market Data.
|
||||||
site_author: Anson Biggs
|
site_author: Anson Biggs
|
||||||
copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
|
copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available Under an <a href="/LICENSE/">MIT LICENSE</a> </br>
|
||||||
|
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Commands: commands.md
|
- Commands: commands.md
|
||||||
- Self-Host: host.md
|
- Self-Host: host.md
|
||||||
- Donate: donate.md
|
- Donate: donate.md
|
||||||
- Contact: contact.md
|
- Contact: contact.md
|
||||||
- Blog: /blog
|
- Blog: /blog
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
language: en
|
language: en
|
||||||
features:
|
features:
|
||||||
- navigation.instant
|
- navigation.instant
|
||||||
- navigation.tracking
|
- navigation.tracking
|
||||||
- navigation.tabs
|
- navigation.tabs
|
||||||
- navigation.tabs.sticky
|
- navigation.tabs.sticky
|
||||||
- content.code.copy
|
- content.code.copy
|
||||||
icon:
|
icon:
|
||||||
logo: material/robot-love
|
logo: material/robot-love
|
||||||
palette:
|
palette:
|
||||||
- media: "(prefers-color-scheme: light)"
|
- media: "(prefers-color-scheme: light)"
|
||||||
primary: green
|
primary: green
|
||||||
scheme: default
|
scheme: default
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/lightbulb-outline
|
icon: material/lightbulb-outline
|
||||||
name: Switch to dark mode
|
name: Switch to dark mode
|
||||||
- media: "(prefers-color-scheme: dark)"
|
- media: "(prefers-color-scheme: dark)"
|
||||||
primary: green
|
primary: green
|
||||||
scheme: slate
|
scheme: slate
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/lightbulb
|
icon: material/lightbulb
|
||||||
name: Switch to light mode
|
name: Switch to light mode
|
||||||
|
|
||||||
extra:
|
extra:
|
||||||
social:
|
social:
|
||||||
- icon: fontawesome/solid/house
|
- icon: fontawesome/solid/house
|
||||||
link: https://simplestockbot.com/
|
link: https://simplestockbot.com/
|
||||||
- icon: fontawesome/brands/telegram
|
- icon: fontawesome/brands/telegram
|
||||||
link: https://t.me/SimpleStockBot
|
link: https://t.me/SimpleStockBot
|
||||||
name: Get the Telegram bot
|
name: Get the Telegram bot
|
||||||
- icon: fontawesome/brands/discord
|
- icon: fontawesome/brands/discord
|
||||||
link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
|
link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
|
||||||
name: Get the Discord Bot
|
name: Get the Discord Bot
|
||||||
- icon: material/chart-line-stacked
|
- icon: material/chart-line-stacked
|
||||||
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
|
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
|
||||||
name: MarketData.app for stock data
|
name: MarketData.app for stock data
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
extra_css:
|
extra_css:
|
||||||
- stylesheets/phone.css
|
- stylesheets/phone.css
|
||||||
|
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- search
|
- search
|
||||||
- social
|
- social
|
||||||
- blog
|
- blog
|
||||||
|
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- attr_list
|
- attr_list
|
||||||
- pymdownx.emoji:
|
- pymdownx.emoji:
|
||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
- admonition
|
- admonition
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
@ -1,5 +1,5 @@
|
|||||||
mkdocs-material==9.4.4
|
mkdocs-material==9.4.4
|
||||||
|
|
||||||
# Required for Social Cards
|
# Required for Social Cards
|
||||||
Pillow==10.0.1
|
Pillow==10.0.1
|
||||||
CairoSVG==2.7.1
|
CairoSVG==2.7.1
|
||||||
Loading…
x
Reference in New Issue
Block a user