mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-15 22:02:31 +00:00
* bump * Update ALL the exports with sheet name option * Update contributing too * Add in sheet name to each docstring * Update tests * Fix the small things for tests * Converting CONTRIBUTING.md back since I put minimal changes in and it complains * Fix terminal exit after `--sort p/e` (#4013) * fix scr sort exit * rewrite unit test output * rewind slash replace * rewind slash replace * fix regex * rewrite expected scr tests * black Co-authored-by: James Maslek <jmaslek11@gmail.com> * fix: small typo (#4036) * fix income comparison error (#4029) * Update tests due to yfinance error * I broke tests and fixed them * Fix tests? * Missed a few sheet name additions * missed one more * Fix some missing sheet_name parameters * Fix a test I broke * Update tests due to changes with sheet_name * Update stocks and common * Mutual funds just because * Portfolio update * Update Forecast * Update Futures * Update ETF * Update Economy * Update Crypto * Update others * Update documentation to explain --sheet-name * It should be None test * Add None for sheet_name since empty string can result in errors * Formatting * Fix tests * Update documentation * Also update the image * Add back to options commands Co-authored-by: james <jmaslek11@gmail.com> Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: teh_coderer <me@tehcoderer.com>
54 lines
1.6 KiB
Python
54 lines
1.6 KiB
Python
import os
|
|
|
|
from openbb_terminal.helper_funcs import print_rich_table, export_data
|
|
from openbb_terminal.cryptocurrency import crypto_models
|
|
|
|
|
|
def find(
|
|
query: str,
|
|
source: str = "CoinGecko",
|
|
key: str = "symbol",
|
|
limit: int = 10,
|
|
export: str = "",
|
|
sheet_name: str = None,
|
|
) -> None:
|
|
"""Find similar coin by coin name,symbol or id.
|
|
|
|
If you don't know exact name or id of the Coin at CoinGecko CoinPaprika, Binance or Coinbase
|
|
you use this command to display coins with similar name, symbol or id to your search query.
|
|
Example: coin name is something like "polka". So I can try: find -c polka -k name -t 25
|
|
It will search for coin that has similar name to polka and display top 25 matches.
|
|
|
|
-c, --coin stands for coin - you provide here your search query
|
|
-k, --key it's a searching key. You can search by symbol, id or name of coin
|
|
-t, --top it displays top N number of records.
|
|
|
|
Parameters
|
|
----------
|
|
query: str
|
|
Cryptocurrency
|
|
source: str
|
|
Data source of coins. CoinGecko or CoinPaprika or Binance or Coinbase
|
|
key: str
|
|
Searching key (symbol, id, name)
|
|
limit: int
|
|
Number of records to display
|
|
export : str
|
|
Export dataframe data to csv,json,xlsx file
|
|
"""
|
|
|
|
df = crypto_models.find(query=query, source=source, key=key, limit=limit)
|
|
|
|
if not df.empty:
|
|
print_rich_table(
|
|
df, headers=list(df.columns), show_index=False, title="Similar Coins"
|
|
)
|
|
|
|
export_data(
|
|
export,
|
|
os.path.dirname(os.path.abspath(__file__)),
|
|
"find",
|
|
df,
|
|
sheet_name,
|
|
)
|