tessa

https://github.com/ymyke/tessa
Admin
tessa is a Python library designed for easily retrieving price information of financial assets from...
Tokens:130,782
Snippets:446
Trust Score:6.2
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Setup Guards API

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/low_level_rate_limiter.html

Endpoint for setting up guards.

```APIDOC
## /api/setup/guards

### Description
This endpoint is used to configure and set up guards within the Tessa system. It allows for the initialization and activation of guards based on provided parameters.

### Method
POST

### Endpoint
/api/setup/guards

### Request Body
- **guard_ids** (array[string]) - Required - A list of guard IDs to set up.
- **settings** (object) - Optional - Additional settings for the setup process.

### Request Example
```json
{
  "guard_ids": ["guard-12345", "guard-67890"],
  "settings": {
    "mode": "active"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the setup operation.
- **message** (string) - A message providing details about the setup.

#### Response Example
```json
{
  "status": "success",
  "message": "Guards have been successfully set up."
}
```
```

--------------------------------

### Tessa Search Example using Python

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/search/search_result.html

Demonstrates how to perform a search using the tessa library, review results, and filter them by source. This example requires the 'tessa' library to be installed.

```python
from tessa import search
r = search("harmony")

# Review results:
r.p()

# Get the 1 symbol from source "coingecko" in the best bucket (i.e., bucket 0):
s = r.filter(source="coingecko").buckets[0].symbols[0]
s.price_latest()
```

--------------------------------

### Setup Request Guards from Configuration (Python)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/low_level_rate_limiter.html

This function initializes and applies guards based on a predefined 'guards' dictionary. It sets initial call times, resets wait times, and dynamically replaces original functions with their guarded versions using eval and exec. This setup ensures that subsequent calls to the specified functions will be subject to the defined rate limiting.

```python
def setup_guards() -> None:
    """Set up guards."""
    for guard in guards.values():
        guard["last_call"] = pendulum.parse("1900")
        guard["wait_seconds"] = guard["initial_wait_seconds"]
        guard["func_orig"] = eval(guard["func_name"])
        exec(f"{guard['func_name']} = create_guard({guard['func_name']}, guard)")
```

--------------------------------

### Tessa Package Installation

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa.html

Provides the command to install the Tessa Python package using pip. This command fetches and installs the latest version of the library and its dependencies.

```bash
pip install tessa
```

--------------------------------

### Set Start Date for Historical Data

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/yahoo.html

Defines the starting date for retrieving historical financial data. Extending this date may increase load on Yahoo Finance servers. This constant is used by the `get_price_history` function.

```python
START_FROM = '2000-01-01'
```

--------------------------------

### Python Symbol and SymbolCollection Example

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol.html

Demonstrates basic usage of the Symbol and SymbolCollection classes from the tessa library. It shows how to create Symbol objects, fetch latest prices, add symbols to a collection, retrieve price graphs, and save the collection to a YAML file.

```python
from tessa import Symbol, SymbolCollection
s1 = Symbol("MSFT")                 # will use "yahoo" as the default source
s1.price_latest()                   # get latest price
sc = SymbolCollection([s1])         # create collection
sc.add(Symbol("ethereum", source="coingecko"))       # add another symbol
sc.find_one("ethereum").price_graph(monthsback=6)    # graph of 6 past months
sc.save_yaml("my_symbols.yaml")     # save
```

--------------------------------

### Syntax Highlighting CSS

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/search/coingecko.html

This CSS snippet provides styling for code syntax highlighting, commonly used in documentation or code examples. It defines styles for different token types like comments and errors.

```css
/*
 * syntax-highlighting.css
 */
pre{
  line-height:125%;
}
span.linenos{
  color: inherit;
  background-color: transparent;
  padding-left:5px;
  padding-right:20px;
}
.pdoc-code .hll{
  background-color:#49483e
}
.pdoc-code{
  background:#272822;
  color:#f8f8f2
}
.pdoc-code .c{
  color:#75715e
}
.pdoc-code .err{
  color:#960050;
  backgr
```

--------------------------------

### Initialize SymbolCollection (Python)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol/symbolcollection.html

Initializes a new SymbolCollection. It can optionally take a list of Symbol objects during initialization to populate the collection immediately. Otherwise, it starts with an empty list of symbols.

```python
def __init__(self, symbols: Optional[List[Symbol]] = None) -> None:
    """Initializer. Use `symbols` to add symbols immediately and/or use `add` method
    later.
    """
    self.symbols = []
    if symbols is not None:
        self.add(symbols)
```

--------------------------------

### JavaScript Initial Search Trigger and Event Listener Setup

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa.html

Initializes the search functionality if a search term is present in the URL on page load. It also sets up an event listener to initialize the search when the search box first receives focus.

```javascript
if (getSearchTerm()) {
  initialize();
  searchBox.value = getSearchTerm();
  onInput();
} else {
  searchBox.addEventListener("focus", initialize, {once: true});
}
```

--------------------------------

### Create Symbol from Coingecko and Get Price Graph

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa.html

Illustrates creating a Symbol object for a cryptocurrency (bitcoin) from the 'coingecko' source and retrieving its price graph. This demonstrates using a different data source and accessing graphical price data.

```python
from tessa import Symbol

s3 = Symbol("bitcoin", source="coingecko")
print(s3.price_graph())  # show price graph
```

--------------------------------

### Bootstrap Reboot CSS Stylesheet

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources_directory.html

The Bootstrap Reboot CSS provides a consistent, baseline-to-baseline CSS reset and extension. It normalizes styles across browsers and devices, ensuring a predictable starting point for web development. Dependencies include standard CSS practices.

```css
/*\n * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/)\n * Copyright 2011-2021 The Bootstrap Authors\n * Copyright 2011-2021 Twitter, Inc.\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)\n * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md)\n */
,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not(\[size\]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr\[data-bs-original-title\],abbr\[title\]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not(\[href\]):not(\[class\]),a:not(\[href\]):not(\[class\]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}
```

--------------------------------

### Create Symbol with Specific Source and Get Price Point

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa.html

Shows how to create a Symbol object for a specific asset (SREN.SW) and retrieve its price at a particular historical date. This example illustrates accessing historical price data for a symbol.

```python
from tessa import Symbol

s2 = Symbol("SREN.SW")
print(s2.price_point("2022-06-30"))  # get price at specific point in time
```

--------------------------------

### Run pdoc Documentation Locally (Shell)

Source: https://github.com/ymyke/tessa/blob/master/DEVNOTES.md

Command to run pdoc documentation locally without specifying an output directory, using a dark mode theme. This is a simplified way to preview the documentation.

```shell
pdoc -t docs/pdoc-dark-mode tessa
```

--------------------------------

### Python: Get Latest Asset Price

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price.html

Retrieves the most recent price for a given asset. This function supports specifying a data source (e.g., 'coingecko', 'yahoo') and currency preference. Examples demonstrate successful calls and potential errors due to symbol not being found on a source.

```python
from tessa import price_history, price_point, price_point_strict, price_latest

price_latest("ethereum", source="coingecko", currency_preference="CHF")
price_latest("ETH-EUR", source="yahoo")
# price_latest("ethereum", source="yahoo")    # error b/c symbol not found on yahoo
# price_latest("ETH-EUR", source="coingecko") # error b/c symbol not found on coingecko
```

--------------------------------

### Search Index Initialization and Loading

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/coingecko.html

The `initialize` function dynamically loads an external JavaScript file (`search.js`) which is assumed to contain the search index and search functionality. It handles potential errors during script loading and then calls `onInput` to perform an initial search if a search term is present in the URL. It also sets up event listeners for navigation clicks and search box focus.

```javascript
let search, searchErr;
async function initialize() {
  try {
    search = await new Promise((resolve, reject) => {
      const script = document.createElement("script");
      script.type = "text/javascript";
      script.async = true;
      script.onload = () => resolve(window.pdocSearch);
      script.onerror = (e) => reject(e);
      script.src = "../../search.js";
      document.getElementsByTagName("head")[0].appendChild(script);
    });
  } catch (e) {
    console.error("Cannot fetch pdoc search index");
    searchErr = "Cannot fetch search index.";
  }
  onInput();
  document.querySelector("nav.pdoc").addEventListener("click", e => {
    if (e.target.hash) {
      searchBox.value = "";
      searchBox.dispatchEvent(new Event("input"));
    }
  });
}

if (getSearchTerm()) {
  initialize();
  searchBox.value = getSearchTerm();
  onInput();
} else {
  searchBox.addEventListener("focus", initialize, {once: true});
}
```

--------------------------------

### Build pdoc Documentation (Shell)

Source: https://github.com/ymyke/tessa/blob/master/DEVNOTES.md

Command to build pdoc documentation for the 'tessa' project, outputting to the 'docs' directory with a dark mode theme. This is useful for generating project documentation locally.

```shell
pdoc -o docs -t docs/pdoc-dark-mode tessa
```

--------------------------------

### Get Currency for Symbol

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol/symbol.html

Retrieves the currency associated with a symbol's latest price information. It fetches the latest price and returns its currency in uppercase. This method relies on the `price_latest` method to get the currency information.

```python
def currency(self) -> str:
    """Return currency for this symbol."""
    currency = self.price_latest().currency
    return currency and currency.upper()
```

--------------------------------

### Initialize Search Functionality (JavaScript)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/yahoo.html

Initializes the search functionality for the documentation. This involves dynamically loading a search script and setting up event listeners for the search input and window navigation. It handles errors during script loading and updates the displayed content based on search terms.

```javascript
function escapeHTML(html) { return document.createElement('div').appendChild(document.createTextNode(html)).parentNode.innerHTML; }
const originalContent = document.querySelector("main.pdoc");
let currentContent = originalContent;

function setContent(innerHTML) {
    let elem;
    if (innerHTML) {
        elem = document.createElement("main");
        elem.classList.add("pdoc");
        elem.innerHTML = innerHTML;
    } else {
        elem = originalContent;
    }
    if (currentContent !== elem) {
        currentContent.replaceWith(elem);
        currentContent = elem;
    }
}

function getSearchTerm() {
    return (new URL(window.location)).searchParams.get("search");
}

const searchBox = document.querySelector(".pdoc input[type=search]");
searchBox.addEventListener("input", function () {
    let url = new URL(window.location);
    if (searchBox.value.trim()) {
        url.hash = "";
        url.searchParams.set("search", searchBox.value);
    } else {
        url.searchParams.delete("search");
    }
    history.replaceState("", "", url.toString());
    onInput();
});
window.addEventListener("popstate", onInput);

let search, searchErr;

async function initialize() {
    try {
        search = await new Promise((resolve, reject) => {
            const script = document.createElement("script");
            script.type = "text/javascript";
            script.async = true;
            script.onload = () => resolve(window.pdocSearch);
            script.onerror = (e) => reject(e);
            script.src = "../../search.js";
            document.getElementsByTagName("head")[0].appendChild(script);
        });
    } catch (e) {
        console.error("Cannot fetch pdoc search index");
        searchErr = "Cannot fetch search index.";
    }
    onInput();
    document.querySelector("nav.pdoc").addEventListener("click", e => {
        if (e.target.hash) {
            searchBox.value = "";
            searchBox.dispatchEvent(new Event("input"));
        }
    });
}

function onInput() {
    setContent((() => {
        const term = getSearchTerm();
        if (!term) {
            return null
        }
        if (searchErr) {
            return `<h3>Error: ${searchErr}</h3>`
        }
        if (!search) {
            return "<h3>Searching...</h3>"
        }
        window.scrollTo({
            top: 0,
            left: 0,
            behavior: 'auto'
        });
        const results = search(term);
        let html;
        if (results.length === 0) {
            html = `No search results for '${escapeHTML(term)}'.`
        } else {
            html = `<h4>${results.length} search result${results.length > 1 ? "s" : ""} for '${escapeHTML(term)}'.</h4>`;
        }
        for (let result of results.slice(0, 10)) {
            let doc = result.doc;
            let url = `../../${doc.modulename.replaceAll(".", "/")}.html`;
            if (doc.qualname) {
                url += `#${doc.qualname}`;
            }
            let heading;
            switch (result.doc.kind) {
                case "function":
                    if (doc.fullname.endsWith(".__init__")) {
                        heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
                    } else {
                        heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
                    }
                    break;
                case "class":
                    heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
                    if (doc.bases) heading += `<wbr>(<span class="base">${doc.bases}</span>)`;
                    heading += `:`;
                    break;
                case "variable":
                    heading = `<span class="name">${doc.fullname}</span>`;
                    if (doc.annotation) heading += `<span class="annotation">${doc.annotation}</span>`;
                    if (doc.default_value) heading += `<span class="default_value"> = ${doc.default_value}</span>`;
                    break;
                default:
                    heading = `<span class="name">${doc.fullname}</span>`;
                    break;
            }
            html += ` <section class="search-result"> <a href="${url}" class="attr ${doc.kind}">${heading}</a> <div class="docstring">${doc.doc}</div> </section> `;
        }
        return html;
    })());
}

if (getSearchTerm()) {
    initialize();
    searchBox.value = getSearchTerm();
    onInput();
} else {
    searchBox.addEventListener("focus", initialize, {once: true});
}
searchBox.addEventLis
```

--------------------------------

### Get Price History with Retry Logic (Brute Force)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources.html

Implements a brute-force method to get price history, retrying requests that encounter specific HTTP errors (504, 503, 502) or `RateLimitHitError`. It includes a maximum retry limit and warnings for retries.

```python
import warnings
import requests

# Assuming RateLimiter, PriceHistory, and SourceType are defined elsewhere
# from .rate_limiter import RateLimiter
# from .price_history import PriceHistory
# from .source_type import SourceType
# class RateLimitHitError(Exception): pass # Placeholder for RateLimitHitError

class Source:
    # ... (previous parts of the class definition)

    def get_price_history_bruteforcefully(
        self, query: str, currency_preference: str = "USD"
    ) -> 'PriceHistory':
        """Variant of `get_price_history` that will ignore some server-side errors
        (which often seem to be intermittent, at least on Coingecko) and just
        retries.
        """
        max_tries = 100
        tries = 0
        while True:
            tries += 1
            try:
                res = self.get_price_history(query, currency_preference)
                self.rate_limiter.reset_back_off()
                return res
            except requests.HTTPError as exc:
                if exc.response.status_code not in [504, 503, 502]:
                    raise exc
                if tries > max_tries:
                    raise ConnectionError(
                        f"Cannot access source, even after {max_tries} tries. "
                        "(Reraising from latest exception, there might have been "
                        "several.)"
                    ) from exc
                warnings.warn(
                    f"Latest request raised for status code {exc.response.status_code}."
                    f" Retrying ({tries}/{max_tries}).",
                    RuntimeWarning,
                )
            except RateLimitHitError:
                warnings.warn(
                    "Rate limit hit (429). "
                    f"Backing off {self.rate_limiter.back_off_time} seconds."
                )
                self.rate_limiter.back_off()

```

--------------------------------

### Initialize Search Functionality (JavaScript)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/search/coingecko.html

Asynchronously loads the search script and initializes the search functionality. It handles potential errors during script loading and sets up event listeners for navigation and search input. This function prepares the page for interactive search.

```javascript
let search, searchErr;
async function initialize() {
    try {
        search = await new Promise((resolve, reject) => {
            const script = document.createElement("script");
            script.type = "text/javascript";
            script.async = true;
            script.onload = () => resolve(window.pdocSearch);
            script.onerror = (e) => reject(e);
            script.src = "../../search.js";
            document.getElementsByTagName("head")[0].appendChild(script);
        });
    } catch (e) {
        console.error("Cannot fetch pdoc search index");
        searchErr = "Cannot fetch search index.";
    }
    onInput();
    document.querySelector("nav.pdoc").addEventListener("click", e => {
        if (e.target.hash) {
            searchBox.value = "";
            searchBox.dispatchEvent(new Event("input"));
        }
    });
}
```

--------------------------------

### Generate Price Graph

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol/symbol.html

Generates and displays a price graph for a symbol over a specified period. It fetches price history, calculates the start date based on `monthsback`, and plots the closing prices using `seaborn` and `matplotlib`. The function returns the start date, figure, and axes for potential further customization.

```python
def price_graph(self, monthsback: int = 6) -> tuple:
    """Display this symbol's price graph over the last monthsback months.

    Returns from_date, fig, and ax in order for subclass functions to add to the
    information and even the graph displayed here.
    """
    fig, ax = plt.subplots(figsize=(16, 8))
    hist = self.price_history().df

    # Calc start date:
    from_date = datetime.date.today() - pd.offsets.DateOffset(months=monthsback)
    from_date = from_date.strftime("%Y-%m-%d")

    # Plot the prices:
    sns.lineplot(ax=ax, data=hist.loc[from_date:, "close"], marker="o").set(
        title=self.name
    )
```

--------------------------------

### Initialize and Handle Search Input - JavaScript

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/search/coingecko.html

This snippet initializes the search functionality, sets the search box value if a search term is present, and adds event listeners for focus and input. It also handles keyboard navigation within the search results.

```javascript
if (getSearchTerm()) { initialize(); searchBox.value = getSearchTerm(); onInput(); } else { searchBox.addEventListener("focus", initialize, {once: true}); }
searchBox.addEventListener("keydown", e => {
  if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
    let focused = currentContent.querySelector(".search-result.focused");
    if (!focused) {
      currentContent.querySelector(".search-result").classList.add("focused");
    } else if ( e.key === "ArrowDown" && focused.nextElementSibling && focused.nextElementSibling.classList.contains("search-result") ) {
      focused.classList.remove("focused");
      focused.nextElementSibling.classList.add("focused");
      focused.nextElementSibling.scrollIntoView({ behavior: "smooth", block: "nearest", inline: "nearest" });
    } else if ( e.key === "ArrowUp" && focused.previousElementSibling && focused.previousElementSibling.classList.contains("search-result") ) {
      focused.classList.remove("focused");
      focused.previousElementSibling.classList.add("focused");
      focused.previousElementSibling.scrollIntoView({ behavior: "smooth", block: "nearest", inline: "nearest" });
    } else if ( e.key === "Enter" ) {
      focused.querySelector("a").click();
    }
  }
});
```

--------------------------------

### GET /price

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/price.html

Retrieves price information.

```APIDOC
## GET /price

### Description
Retrieves price information.

### Method
GET

### Endpoint
/price

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **price** (number) - The current price.

#### Response Example
```json
{
  "price": 123.45
}
```
```

--------------------------------

### JavaScript Search Initialization and Execution

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources_directory.html

Asynchronously loads the search index script and initializes the search functionality. It defines the `onInput` function to process search queries, format results, and update the page content. It also includes event handling for navigation and keyboard input within search results.

```javascript
let search, searchErr;
async function initialize() {
    try {
        search = await new Promise((resolve, reject) => {
            const script = document.createElement("script");
            script.type = "text/javascript";
            script.async = true;
            script.onload = () => resolve(window.pdocSearch);
            script.onerror = (e) => reject(e);
            script.src = "../../search.js";
            document.getElementsByTagName("head")[0].appendChild(script);
        });
    } catch (e) {
        console.error("Cannot fetch pdoc search index");
        searchErr = "Cannot fetch search index.";
    }
    onInput();
    document.querySelector("nav.pdoc").addEventListener("click", e => {
        if (e.target.hash) {
            searchBox.value = "";
            searchBox.dispatchEvent(new Event("input"));
        }
    });
}
function onInput() {
    setContent((() => {
        const term = getSearchTerm();
        if (!term) {
            return null
        }
        if (searchErr) {
            return `<h3>Error: ${searchErr}</h3>`
        }
        if (!search) {
            return "<h3>Searching...</h3>"
        }
        window.scrollTo({
            top: 0,
            left: 0,
            behavior: 'auto'
        });
        const results = search(term);
        let html;
        if (results.length === 0) {
            html = `No search results for '${escapeHTML(term)}'.`
        } else {
            html = `<h4>${results.length} search result${results.length > 1 ? "s" : ""} for '${escapeHTML(term)}'.</h4>`
        }
        for (let result of results.slice(0, 10)) {
            let doc = result.doc;
            let url = `../../${doc.modulename.replaceAll(".", "/")}.html`;
            if (doc.qualname) {
                url += `#${doc.qualname}`;
            }
            let heading;
            switch (result.doc.kind) {
                case "function":
                    if (doc.fullname.endsWith(".__init__")) {
                        heading = `<span class="name">${doc.fullname.replace(/\.__init__$/, "")}</span>${doc.signature}`;
                    } else {
                        heading = `<span class="def">${doc.funcdef}</span> <span class="name">${doc.fullname}</span>${doc.signature}`;
                    }
                    break;
                case "class":
                    heading = `<span class="def">class</span> <span class="name">${doc.fullname}</span>`;
                    if (doc.bases) heading += `<wbr>(<span class="base">${doc.bases}</span>)`;
                    heading += `:
`;
                    break;
                case "variable":
                    heading = `<span class="name">${doc.fullname}</span>`;
                    if (doc.annotation) heading += `<span class="annotation">${doc.annotation}</span>`
                    if (doc.default_value) heading += `<span class="default_value"> = ${doc.default_value}</span>`
                    break;
                default:
                    heading = `<span class="name">${doc.fullname}</span>`;
                    break;
            }
            html += ` <section class="search-result"> <a href="${url}" class="attr ${doc.kind}">${heading}</a> <div class="docstring">${doc.doc}</div> </section> `;
        }
        return html;
    })());
}
if (getSearchTerm()) {
    initialize();
    searchBox.value = getSearchTerm();
    onInput();
} else {
    searchBox.addEventListener("focus", initialize, {once: true});
}
searchBox.addEventListener("keydown", e => {
    if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
        let focused = currentContent.querySelector(".search-result.focused");
        if (!focused) {
            currentContent.querySelector(".search-result").classList.add("focused");
        } else if ( e.key === "ArrowDown" && focused.nextElementSibling && focused.nextElementSibling.classList.contains("search-result") ) {
            focused.classList.remove("focused");
            focused.nextElementSibling.classList.add("focused");
            focused.nextElementSibling.scrollIntoView({
                behavior: "smooth",
                block: "nearest",
                inline: "nearest"
            });
        } else if ( e.key === "ArrowUp" && focused.previousElementSibling
```

--------------------------------

### ExtendedSymbol - Get Strategy String

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol/extended_symbol.html

Retrieves a string representation of the investment strategy for a symbol.

```APIDOC
## ExtendedSymbol.get_strategy_string

### Description
Retrieves a string representation of the investment strategy for a symbol.

### Method
GET

### Endpoint
/api/symbol/strategy/string/{symbol_id}

### Parameters
#### Path Parameters
- **symbol_id** (string) - Required - The unique identifier for the symbol.

### Response
#### Success Response (200)
- **strategy_string** (string) - The string representation of the symbol's strategy.

#### Response Example
```json
{
  "strategy_string": "HoldForGrowth,EnterIf"
}
```
```

--------------------------------

### JavaScript Search Index Initialization and Loading

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/search.html

Asynchronously loads the search index script ('search.js') and handles potential errors during loading. It resolves a promise with the search functionality or rejects with an error. It also sets up an event listener for navigation clicks to clear the search box.

```javascript
let search, searchErr;
async function initialize() {
  try {
    search = await new Promise((resolve, reject) => {
      const script = document.createElement("script");
      script.type = "text/javascript";
      script.async = true;
      script.onload = () => resolve(window.pdocSearch);
      script.onerror = (e) => reject(e);
      script.src = "../search.js";
      document.getElementsByTagName("head")[0].appendChild(script);
    });
  } catch (e) {
    console.error("Cannot fetch pdoc search index");
    searchErr = "Cannot fetch search index.";
  }
  onInput();
  document.querySelector("nav.pdoc").addEventListener("click", e => {
    if (e.target.hash) {
      searchBox.value = "";
      searchBox.dispatchEvent(new Event("input"));
    }
  });
}

if (getSearchTerm()) {
  initialize();
  searchBox.value = getSearchTerm();
  onInput();
} else {
  searchBox.addEventListener("focus", initialize, {once: true});
}
```

--------------------------------

### Get Latest Price

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/price.html

Retrieves the most recent available price for a given query, source, and currency preference.

```APIDOC
## GET /price/latest

### Description
Same as `price_point` but will return the latest price.

### Method
GET

### Endpoint
/price/latest

### Parameters
#### Query Parameters
- **query** (string) - Required - A query string that makes sense in combination with the source. E.g., "BTC-USD" for "yahoo" or "bitcoin" for "coingecko".
- **source** (string) - Optional - The source to query. Defaults to "yahoo". Supported values: 'yahoo', 'coingecko'.
- **currency_preference** (string) - Optional - The currency the prices should be returned in; defaults to "USD".

### Response
#### Success Response (200)
- **when** (Timestamp) - The timestamp of the latest price.
- **price** (float) - The latest price.
- **currency** (string) - The currency of the latest price.

#### Response Example
```json
{
  "when": "2023-10-27T10:00:00Z",
  "price": 1500.50,
  "currency": "USD"
}
```
```

--------------------------------

### JavaScript: Initialize and Load Search Index

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/utils.html

Asynchronously loads the `search.js` script, which contains the search index and search function. It handles potential errors during script loading and initializes the search functionality once the index is available.

```javascript
let search, searchErr;
async function initialize() {
  try {
    search = await new Promise((resolve, reject) => {
      const script = document.createElement("script");
      script.type = "text/javascript";
      script.async = true;
      script.onload = () => resolve(window.pdocSearch);
      script.onerror = (e) => reject(e);
      script.src = "../search.js";
      document.getElementsByTagName("head")[0].appendChild(script);
    });
  } catch (e) {
    console.error("Cannot fetch pdoc search index");
    searchErr = "Cannot fetch search index.";
  }
  onInput();
  document.querySelector("nav.pdoc").addEventListener("click", e => {
    if (e.target.hash) {
      searchBox.value = "";
      searchBox.dispatchEvent(new Event("input"));
    }
  });
}
```

--------------------------------

### Get ExtendedSymbol Description

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/symbol/extended_symbol.html

Retrieves the description associated with an ExtendedSymbol instance. This attribute is informational and provides a textual explanation of the symbol.

```python
description: Optional[str] = None
```

--------------------------------

### Get All Available Sources

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources.html

Yields all available data source objects from the `SOURCES_DIRECTORY`. This function is useful for iterating through all configured sources.

```python
# Assuming SourceType is defined elsewhere
# from .source_type import SourceType
from typing import Generator

def get_all_sources() -> Generator['Source', None, None]:
    """Get all the known sources."""
    # Prevent circular dependencies -- pylint: disable=import-outside-toplevel
    from .sources_directory import SOURCES_DIRECTORY

    for source in SOURCES_DIRECTORY.values():
        yield source

```

--------------------------------

### JavaScript: Search Initialization

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources.html

Asynchronously loads the search index script and initializes the search functionality. It handles potential errors during script loading and sets up event listeners for search box interactions and page navigation.

```javascript
async function initialize() {
    try {
        search = await new Promise((resolve, reject) => {
            const script = document.createElement("script");
            script.type = "text/javascript";
            script.async = true;
            script.onload = () => resolve(window.pdocSearch);
            script.onerror = (e) => reject(e);
            script.src = "../../search.js";
            document.getElementsByTagName("head")[0].appendChild(script);
        });
    } catch (e) {
        console.error("Cannot fetch pdoc search index");
        searchErr = "Cannot fetch search index.";
    }
    onInput();
    document.querySelector("nav.pdoc").addEventListener("click", e => {
        if (e.target.hash) {
            searchBox.value = "";
            searchBox.dispatchEvent(new Event("input"));
        }
    });
}
```

--------------------------------

### Search Box Initialization and Keyboard Navigation (JavaScript)

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/rate_limiter.html

Handles the initialization of the search box when it gains focus and manages keyboard events for navigating through search results. It supports arrow key navigation and triggering a selection with the Enter key. Dependencies include DOM manipulation and event listeners.

```javascript
function initialize() {
  resize();
  searchBox.value = getSearchTerm();
  onInput();
} else {
  searchBox.addEventListener("focus", initialize, {once: true});
}

searchBox.addEventListener("keydown", e => {
  if (["ArrowDown", "ArrowUp", "Enter"].includes(e.key)) {
    let focused = currentContent.querySelector(".search-result.focused");
    if (!focused) {
      currentContent.querySelector(".search-result").classList.add("focused");
    } else if ( e.key === "ArrowDown" && focused.nextElementSibling && focused.nextElementSibling.classList.contains("search-result") ) {
      focused.classList.remove("focused");
      focused.nextElementSibling.classList.add("focused");
      focused.nextElementSibling.scrollIntoView({ behavior: "smooth", block: "nearest", inline: "nearest" });
    } else if ( e.key === "ArrowUp" && focused.previousElementSibling && focused.previousElementSibling.classList.contains("search-result") ) {
      focused.classList.remove("focused");
      focused.previousElementSibling.classList.add("focused");
      focused.previousElementSibling.scrollIntoView({ behavior: "smooth", block: "nearest", inline: "nearest" });
    } else if ( e.key === "Enter" ) {
      focused.querySelector("a").click();
    }
  }
});
```

--------------------------------

### Get Price Point

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/price.html

Retrieves the price for a specific point in time. If the exact timestamp is not found, it searches for the closest available price.

```APIDOC
## GET /price/point

### Description
Return the price at a given point in time given by `when`. Look for the closest point in time if the exact point in time is not found. Returns a `PricePoint`, i.e., a tuple of the price, the effective timestamp of the price, and the currency.

### Method
GET

### Endpoint
/price/point

### Parameters
#### Query Parameters
- **query** (string) - Required - A query string that makes sense in combination with the source. E.g., "BTC-USD" for "yahoo" or "bitcoin" for "coingecko".
- **when** (string or Timestamp) - Required - The desired point in time for the price.
- **source** (string) - Optional - The source to query. Defaults to "yahoo". Supported values: 'yahoo', 'coingecko'.
- **currency_preference** (string) - Optional - The currency the prices should be returned in; defaults to "USD".
- **max_date_deviation_days** (integer) - Optional - The maximum number of days to deviate from the specified `when` to find a price. Defaults to 10.

### Response
#### Success Response (200)
- **when** (Timestamp) - The effective timestamp of the price.
- **price** (float) - The price at the specified point in time.
- **currency** (string) - The currency of the price.

#### Response Example
```json
{
  "when": "2023-10-27T10:00:00Z",
  "price": 1500.50,
  "currency": "USD"
}
```
```

--------------------------------

### Get Price History

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/price/coingecko.html

Retrieves the historical price data for a specified cryptocurrency against a preferred currency. The data is limited to the last 365 days on a daily interval.

```APIDOC
## GET /api/coingecko/price_history

### Description
Retrieves the historical price data for a specified cryptocurrency against a preferred currency. The data is limited to the last 365 days on a daily interval.

### Method
GET

### Endpoint
/api/coingecko/price_history

### Parameters
#### Query Parameters
- **query** (string) - Required - The ID or symbol of the cryptocurrency (e.g., 'bitcoin', 'btc').
- **currency_preference** (string) - Optional - The currency to compare the cryptocurrency against (default: 'USD').

### Request Example
```json
{
  "query": "bitcoin",
  "currency_preference": "USD"
}
```

### Response
#### Success Response (200)
- **PriceHistory** (object) - An object containing the historical price data.
  - **prices** (list) - A list of price points, where each point is a list containing a timestamp and the price.

#### Response Example
```json
{
  "prices": [
    [1678886400000, 50000.12],
    [1678972800000, 51000.34]
  ]
}
```

#### Error Responses
- **SymbolNotFoundError**: If the provided cryptocurrency symbol is not found.
- **CurrencyPreferenceNotFoundError**: If the specified currency preference is invalid.
- **RateLimitHitError**: If the CoinGecko API rate limit is exceeded.
```

--------------------------------

### Manage and Use Symbol Collections in Tessa

Source: https://github.com/ymyke/tessa/blob/master/README.md

Shows how to create a SymbolCollection from existing symbols, add new symbols, find and use symbols within the collection, and persist the collection to a YAML file and load it back.

```python
sc = SymbolCollection([s1, s2, s3, s4])   # create a collection w/ symbols from above
sc.add(Symbol("AAPL"))                    # add another one
sc.find_one("SREN").price_graph()
```

```python
sc.save_yaml("my_symbols.yaml")
sc_new = SymbolCollection()
sc_new.load_yaml("my_symbols.yaml")
```

--------------------------------

### Get Specific Source by Name

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa/sources/sources.html

Retrieves a specific data source object from the `SOURCES_DIRECTORY` using its name. Raises a `ValueError` if the source name is not found.

```python
# Assuming SourceType is defined elsewhere
# from .source_type import SourceType

def get_source(name: 'SourceType') -> 'Source':
    """Get a specific source."""
    # Prevent circular dependencies -- pylint: disable=import-outside-toplevel
    from .sources_directory import SOURCES_DIRECTORY

    try:
        return SOURCES_DIRECTORY[name]
    except KeyError as exc:
        raise ValueError(
            f"Unknown source '{name}'. Supported source are: {SOURCES_DIRECTORY.keys()}"
        ) from exc

```

--------------------------------

### Tessa Core Imports

Source: https://github.com/ymyke/tessa/blob/master/docs/tessa.html

Shows the essential imports from the Tessa library, including functions for price retrieval (`price_history`, `price_point`, `price_point_strict`, `price_latest`), search functionality (`search`), and symbol-related classes (`Symbol`, `ExtendedSymbol`, `SymbolCollection`).

```python
from .sources import SourceType
from .price import (
    price_history,
    price_point,
    price_point_strict,
    price_latest,
)
from .search import search
from .symbol import Symbol, ExtendedSymbol, SymbolCollection
```
Tokens:
Raw