mirror of
https://gitlab.com/simple-stock-bots/simple-stock-bot.git
synced 2025-06-16 15:17:28 +00:00
add prettier
This commit is contained in:
parent
d352131b2e
commit
57967cde47
@ -21,7 +21,8 @@
|
|||||||
"ms-python.vscode-pylance",
|
"ms-python.vscode-pylance",
|
||||||
"ms-python.isort",
|
"ms-python.isort",
|
||||||
"charliermarsh.ruff",
|
"charliermarsh.ruff",
|
||||||
"ms-toolsai.jupyter"
|
"ms-toolsai.jupyter",
|
||||||
|
"esbenp.prettier-vscode"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,2 +1,3 @@
|
|||||||
__pycache__
|
__pycache__
|
||||||
.env
|
.env
|
||||||
|
node_modules
|
@ -19,6 +19,5 @@ ruff:
|
|||||||
- pip3 install ruff
|
- pip3 install ruff
|
||||||
- ruff --output-format gitlab .
|
- ruff --output-format gitlab .
|
||||||
|
|
||||||
|
|
||||||
include:
|
include:
|
||||||
- local: /site/.gitlab-ci.yml
|
- local: /site/.gitlab-ci.yml
|
||||||
|
@ -9,6 +9,7 @@ Enhance your group chats on Telegram and Discord with real-time stock and crypto
|
|||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
|
Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
|
||||||
|
|
||||||
- [Official Documentation](https://simplestockbot.com/)
|
- [Official Documentation](https://simplestockbot.com/)
|
||||||
- [Command Reference](https://simplestockbot.com/commands/)
|
- [Command Reference](https://simplestockbot.com/commands/)
|
||||||
|
|
||||||
@ -17,6 +18,7 @@ Comprehensive documentation is available to help you understand the features and
|
|||||||
Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||||
|
|
||||||
You can contribute by:
|
You can contribute by:
|
||||||
|
|
||||||
- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
|
- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
|
||||||
- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
|
- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
|
||||||
- [Getting in touch](contact.md) for any inquiries or suggestions.
|
- [Getting in touch](contact.md) for any inquiries or suggestions.
|
||||||
@ -32,11 +34,13 @@ You can contribute by:
|
|||||||
## Hosting
|
## Hosting
|
||||||
|
|
||||||
Self-hosting instructions are provided for those interested in running the bot on their own servers:
|
Self-hosting instructions are provided for those interested in running the bot on their own servers:
|
||||||
|
|
||||||
- [Hosting Guide](https://simplestockbot.com/hosting/)
|
- [Hosting Guide](https://simplestockbot.com/hosting/)
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
Reach out for bug reports, feature requests, or other inquiries:
|
Reach out for bug reports, feature requests, or other inquiries:
|
||||||
|
|
||||||
- [Contact Page](https://simplestockbot.com/contact/)
|
- [Contact Page](https://simplestockbot.com/contact/)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
version: '3'
|
version: "3"
|
||||||
services:
|
services:
|
||||||
telegram:
|
telegram:
|
||||||
build:
|
build:
|
||||||
|
27
package-lock.json
generated
Normal file
27
package-lock.json
generated
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"name": "simple-stock-bot",
|
||||||
|
"lockfileVersion": 3,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"devDependencies": {
|
||||||
|
"prettier": "3.0.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/prettier": {
|
||||||
|
"version": "3.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz",
|
||||||
|
"integrity": "sha512-L/4pUDMxcNa8R/EthV08Zt42WBO4h1rarVtK0K+QJG0X187OLo7l699jWw0GKuwzkPQ//jMFA/8Xm6Fh3J/DAg==",
|
||||||
|
"dev": true,
|
||||||
|
"bin": {
|
||||||
|
"prettier": "bin/prettier.cjs"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=14"
|
||||||
|
},
|
||||||
|
"funding": {
|
||||||
|
"url": "https://github.com/prettier/prettier?sponsor=1"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
5
package.json
Normal file
5
package.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"devDependencies": {
|
||||||
|
"prettier": "3.0.3"
|
||||||
|
}
|
||||||
|
}
|
@ -20,4 +20,4 @@ deploy_site:
|
|||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
rules:
|
rules:
|
||||||
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
- if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
|
||||||
|
@ -1,2 +1 @@
|
|||||||
# Blog
|
# Blog
|
||||||
|
|
||||||
|
@ -32,7 +32,6 @@ The Simple Stock Bot looks at every message it can see and tries to detect stock
|
|||||||
|
|
||||||
This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
|
This command allows you to query real-time data for stock options. By simply inputting the stock symbol, strike price, month, and specifying either a call or a put, you can get the latest options data right at your fingertips. For example, `AAPL $220 December call` will provide the current data for Apple's call option with a $220 strike price expiring in December.
|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
## `/donate [Amount in USD]` :fontawesome-brands-telegram-plane:
|
||||||
@ -104,7 +103,9 @@ Gets the latest trending stocks and their change in price
|
|||||||
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||||
$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%
|
||||||
|
|
||||||
@ -184,3 +185,4 @@ full list of stock symbols and return the price of the ticker. Then once you sel
|
|||||||
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.
|
||||||
|
$$
|
||||||
|
@ -17,17 +17,19 @@ Ensure the following are installed or obtained before proceeding:
|
|||||||
- **[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:
|
||||||
|
|
||||||
@ -41,6 +43,7 @@ Ensure the following are installed or obtained before proceeding:
|
|||||||
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:
|
||||||
|
|
||||||
|
@ -9,25 +9,31 @@ Discover a new level of financial discussion with Simple Stock Bot, your go-to s
|
|||||||
## [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
|
||||||
|
@ -7,7 +7,6 @@ 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
|
||||||
@ -55,19 +54,14 @@ extra:
|
|||||||
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:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user