Metadata-Version: 2.4
Name: xxy
Version: 4574.2.3
Summary: A financial statement analysis tool
Project-URL: homepage, https://github.com/iaalm/xxy
Project-URL: repository, https://github.com/iaalm/xxy
Project-URL: documentation, https://github.com/iaalm/xxy
Author-email: iaalm <iaalmsimon@gmail.com>
License: MIT
License-File: LICENSE
Keywords: finance,llm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.12
Requires-Dist: flask[async]>=3.1.1
Requires-Dist: langchain
Requires-Dist: langchain-openai
Requires-Dist: langchain-text-splitters
Requires-Dist: langgraph
Requires-Dist: llama-index
Requires-Dist: llama-index-embeddings-azure-openai
Requires-Dist: llama-index-retrievers-bm25
Requires-Dist: loguru
Requires-Dist: pydantic
Requires-Dist: rongda-mcp-server>=0.3.0
Provides-Extra: all
Requires-Dist: pdfplumber; extra == 'all'
Provides-Extra: pdf
Requires-Dist: pdfplumber; extra == 'pdf'
Description-Content-Type: text/markdown

📢🔬 xxy
========

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Release Building](https://github.com/iaalm/xxy/actions/workflows/release.yml/badge.svg)](https://github.com/iaalm/xxy/actions/workflows/release.yml)
[![PyPI version](https://badge.fury.io/py/xxy.svg)](https://badge.fury.io/py/xxy)

A financial statement analysis tool.

## Run
```shell
python -m xxy query ./data_example -t "000002.SZ" -d 2022  2023 -n "主营业务收入" "投资收益"
```

### Config file
Config file is under `~/.xxy_cfg.json`.

## Development

### Install dependency
```shell
pip install -e .[dev]
```

### Lint
```shell
make format
```

### Test
```shell
make test
```


### Log critiria
| Level | Verbosity | Frequency | Description |
|-------|-----------|-----------|-------------|
| Critial | Always | Once per run | Can't run anymore |
| Error | Always | Once per run | Can continue run, but this is something unexpected |
| Warning | Always | A few time per run | Can continue run, and it's expected issue |
| Success | -v | At most once per run each code line | User should easy to understand |
| Info | -vv | More than once per run each code line | User should easy to understand |
| Debug | -vvv | At most three per second | Technical details for developers |
| Trace | -vvvv | More than three per second | Easy to know where code is hang |
