Bug Fixes
- 🚀 chore(pyproject.toml): remove packages field and fix chatre script path
- 🐛 fix(**init**.py): fix import statement for Paper class
- 🐛 fix(**main**.py): set width to 80 for RichHelpFormatter
- 🐛 fix(**init**.py): import paper and paper_with_image modules
- 🐛 fix(chat_paper.py): raise ValueError if args is None
- 🐛 fix(chat_paper.py): set language to English if args.language is not "en" or "zh"
- 🐛 fix(chat_paper.py): raise ValueError if pdf_path does not exist
- 🐛 fix(chat_response.py): raise ValueError if comment_path does not exist
- 🐛 fix(chat_arxiv.py): log exception messages correctly
- 🐛 fix(chat_arxiv.py): fix report_token_usage import
- 🐛 fix(chat_arxiv.py): fix report_token_usage function call
- 🐛 fix(chat_arxiv.py): fix logger.info calls to use f-strings
- 🐛 fix(chat_arxiv.py): fix logger.info calls to log token usage correctly
- 🐛 fix(paper_with_image.py): fix logger.info() calls by adding f-string
- 🐛 fix(test_paper.py): fix test_paper and test_paper_with_image tests to use demo.pdf from test/data directory
- 🐛 fix(.gitignore): add 'export' to .gitignore
- 🐛 fix(chat_paper.py): fix root_path type error
- 🐛 fix(paper_with_image.py): add f-string to logger.info to log start_page and end_page variables
- 🐛 fix(**main**.py): add logger configuration to stderr
- 🐛 fix(chat_arxiv.py): get gitee_key from config dictionary
- 🐛 fix(chat_reviewer.py): raise ValueError if args is None
- 🐛 fix(**main**.py): remove single quotes from logger format string to fix formatting issue
- 🐛 fix(chat_paper.py): remove redundant log message and fix log message format in chat_paper.py
- 🐛 fix(export.py): add fallback to markdown if pandoc fails to output pdf
- 🐛 fix(reader.py): remove unnecessary translations and add f-strings
Documentation
- 📝 docs(README.md): add project description, installation, usage, license, and contributors sections
- 📄 docs: add demo.pdf test file
- 📝 docs(README.md): update README.md with new usage instructions and subcommands
- 📝 docs(README.md): add links to example markdown and pdf report
Features
- 🚀 feat(chat_arxiv.py): add Paper class to handle papers with images
- ✨ feat(chat_arxiv.py): add metavar to arguments and improve help messages
- ✨ feat(paper_with_image.py): add Paper class to parse pdf and extract paper information and sections. Add get_image_path method to extract the first image from the pdf and save it to a local directory. Add get_chapter_names method to extract chapter names from the pdf. Add get_title method to extract the title of the paper from the pdf.
- ✨ feat(chat_paper.py): add support for pytest
- ✨ feat(chat_paper.py): add support for pytest-sugar
- ✨ feat(chat_paper.py): add support for --max-results argument
- ✨ feat(chat_paper.py): add support for --save-image argument
- ✨ feat(chat_paper.py): add support for --file-format argument
- ✨ feat
- ✨ feat(paper_with_image.py): add support for image resizing and saving
- ✨ feat(chat_research): add rich traceback to **init**.py
- ✨ feat(chat_research): add loguru logger to **main**.py
- ✨ feat(paper.py): add title parameter to Paper class constructor
- ✨ feat(chat_research/chat_config.py): add config subcommand to create apikey.toml
- Add biorxiv provider
- Add biorxiv provider
- ✨ feat(reader.py): add key_words parameter to summary_with_chat, chat_summary, chat_method, and chat_conclusion methods
- Extract base reader
- 🎉 feat(noxfile.py): add nox configuration file
- 🚀 chore(README.md): add features section and update installation guide
- 🚀 chore(README.md): add new features to TODO list
Miscellaneous Tasks
- 🔧 chore(chat_arxiv.py): remove unnecessary blank lines and add metavar to arguments
- 🔧 chore(chat_paper.py): update import statement for Paper class
- 🔧 chore(chat_paper.py): change sort parameter type from enum to string
- 🔧 chore(chat_reviewer.py): update import statement for Paper class
- 🔧 chore(chat_reviewer.py): add default value for review_format parameter
- 🔧 chore(chat_reviewer.py): add metavar for all arguments in add_subcommand function in chat_reviewer.py
- 🔧 chore(chat_response.py): add metavar for all arguments in add_subcommand function in chat_response.py
- 🔧 chore(pyproject.toml): add types-requests package
- 🔧 chore(pre-commit): add isort hook to pre-commit config
- 🔧 chore(pyproject.toml): add isort profile to tool.isort
- 🔧 chore(chat_research): move report_token_usage function to utils.py
- 🔧 chore(paper.py): rearrange imports in alphabetical order
- 🚀 chore(utils.py): add function to report token usage
- 🗑️ chore(ReviewFormat.txt): delete file
- 🔧 chore(.gitignore): add apikey.toml to ignore list
- 🔧 chore(pyproject.toml): add toml to dependencies
- 🔧 chore(chat_research/**main**.py): add chat_config subcommand
- 🔧 chore(chat_research/chat_arxiv.py): add help message to subcommand
- 🔧 chore(chat_research/chat_paper.py): add help message to subcommand
- 🔧 chore(chat_research/chat_response.py): add help message to subcommand
- 🔧 chore(chat_research/chat_reviewer.py): add help message to subcommand
- 🔧 chore(chat_research/utils.py): change apikey.ini to apikey.toml and add error message
- 🔧 chore(**init**.py): add utils module to **all** list
- 🔧 chore(chat_biorxiv.py): add file-format argument and choices to add_subcommand function
- 🔧 chore(chat_paper.py): add file-format argument and choices to add_subcommand function
- 🔧 chore(export.py): add export function and combine_md function
- 🔧 chore(paper_with_image.py): change logger.info to logger.trace in Paper class
- 🔧 chore(arxiv.py): change \_last_request_dt type to Optional[datetime]
- 🚀 chore(release.yml): remove unused check-parent-commit step
- 🔧 chore(pyproject.toml): add nox and nox-poetry dependencies
- 🔖 chore(pyproject.toml): update version to 0.1.1
- 📝 chore(pyproject.toml): update version to 0.1.2
- 🚀 chore(pyproject.toml): update version to 0.1.3
- 🔖 chore(pyproject.toml): bump up version to 0.1.4
Refactor
- 🔥 refactor(chat_arxiv.py): remove unused imports and code
- 🔥 refactor(chat_arxiv.py): remove unused Paper class and its methods
- 🔨 refactor(chat_reviewer.py): add pydantic validator to check if paper_path exists
- 🔨 refactor(chat_reviewer.py): add default values to some arguments
- 🔨 refactor(paper.py): remove redundant code
- 🔨 refactor(paper_with_image.py): remove main function
- 🔧 chore(chat_research): refactor code to load API keys from configuration file and environment variable
- 🔧 chore(**main**.py): refactor logger initialization and add log-level argument
- 🔨 refactor(reader.py): remove category parameter from BaseReader constructor
- 🔨 refactor(reader.py): remove export_to_markdown method from BaseReader class
Styling
- 🎨 style(**init**.py): reformat import statements
- 🎨 style(**main**.py): reformat import statements
- 🎨 style(app.py): reformat import statements
- 🎨 style(README.md): update badges and format file for better readability
Testing
- 🔧 chore(pyproject.toml): add pytest and pytest-sugar packages
- 🧪 test(test_paper.py): add test for paper_with_image module
- 🚚 chore(test_paper.py): move demo.pdf to test/data directory
<!-- generated by git-cliff -->