Chat-research

Bug Fixes

- 🐛 fix(chat_async_arxiv.py): fix import paths
- 🐛 fix(paper_with_image.py): fix get_title method to use self.pdf instead of doc variable
- 🐛 fix(areader.py): rename find_title to update_title
- 🐛 fix(paper_with_image.py): raise exception if no image found in pdf
- 🐛 fix(areader.py): set paper title only if it is empty and a new title is found

Co-authored-by

- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Yangliz5 <yangyang.linorthwestern.edu>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>
- Dependabot[bot] <49699333+dependabot[bot]users.noreply.github.com>

Documentation

- Add example file

Features

- 🔧 chore(cliff.toml): update commit_parsers regex to match any commit message starting with feat, fix, doc, perf, refactor, style, test, chore, and ending with any character. Update filter_unconventional to false and split_commits to true.
- 🚀 feat(.opencommitignore): add file to ignore certain file types in commits
- ✨ feat(paper_with_image.py): add fetch_title method to fetch title from pdf metadata
- Add export to PDF feature using custom template

Miscellaneous Tasks

- 🔧 chore(Makefile): replace aic with oc in commit script
- 🔥 chore(paper_with_image.py): remove unused comments and variables
- 🔥 chore(.gitignore): add 'download' to .gitignore
- 🔖 chore(pyproject.toml): bump up version from 0.1.10 to 0.1.11

Refactor

- Add short parameter
- 🔥 refactor(paper.py): remove unused comment
- 🔥 refactor(paper_with_image.py): remove unused comment and whitespace
- 🔨 refactor(paper_with_image.py): remove unused code and add logging statements
- 🔥 refactor(areader.py): remove unnecessary blank line
- 🔥 refactor(chat_async_paper.py): remove unnecessary comments and blank lines
- 🔨 refactor(areader.py): simplify conditional statement for updating paper title

Signed-off-by

- Dependabot[bot] <supportgithub.com>

Testing

- Bump pytest from 7.2.2 to 7.3.0 (17)

Build

- Bump poetry from 1.4.1 to 1.4.2 in /.github/workflows
- Bump openai from 0.27.2 to 0.27.4 (14)
- Bump ruff from 0.0.260 to 0.0.261 (13)
- Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.8.5 (11)
- Bump poetry from 1.4.1 to 1.4.2 in /.github/workflows (15)
- Bump loguru from 0.6.0 to 0.7.0 (16)

Features

- Add fetch_title method to fetch title from pdf metadata

Miscellaneous Tasks

- 🔖 chore(pyproject.toml): bump up version to 0.1.10

Refactor

- Comment out unused code

Documentation

- Add docs
- Add Makefile with clean, format, sync, test, and commit commands, and update README with classic paper examples in TODO list; remove unused Docker-related files and images; move tutorial images to docs folder
- Add docs

Bug Fixes

- 🐛 fix(AsyncBaseReader): change logger level from info to trace in report_token_usage method
- 🐛 fix(async_arxiv.py): change logger level from trace to info in Result class's download_pdf method

Features

- 📝 docs(README.md): update README.md with new features and GIF tutorials

Refactor

- Refactor

Bug Fixes

- 🔨 chore(**main**.py): fix typo in chat_arxiv_command variable name
- 🐛 fix(chat_research): rename cli function to \_cli to avoid name collision
- 🐛 fix(chat_async_paper.py): rename subcommand name from asyncpaper to paper

Features

- Add async support
- ✨ feat(chat_research): add try-except block to handle KeyboardInterrupt

Miscellaneous Tasks

- 🔖 chore(pyproject.toml): bump up version to 0.1.6

Refactor

- Add aiohttp and fake-useragent to Pyproject.toml, and refactor chat_biorxiv.py and async_biorxiv.py to use async/await and aiohttp for downloading PDFs in an asynchronous way
- 🔥 refactor(**main**.py): remove chat_paper module and its references
- Refactor

Bug Fixes

- 📝 docs(README.md): fix typo in TODO list
- 🐛 fix(README.md): check off "Use config to set key" task

Documentation

- 📝 docs(README.md): revise TODO list
- 📝 docs(README.md): add help.gif to Usage section
- 📝 docs(README.md): update file to reflect correct configuration file name.
- 📝 docs(config.yml): add configuration for welcome, new-issue-welcome, new-pr-welcome, and first-pr-merge behavior bots

Features

- 📝 docs(CHANGELOG.md): add new features and changes in version 0.1.4
- ✨ feat(create_gif.sh): add script to create gif from asciinema recording
- ✨ feat(chat_config.py): add ability to set OpenAI API keys in config file using command line arguments

Miscellaneous Tasks

- 🔍 chore(.gitignore): update .gitignore to exclude chatre.toml instead of apikey.toml
- 🔍 chore(.gitignore): add \*.cast to ignore list
- 🔧 chore(cliff.toml): add configuration file for git-cliff
- 🚀 chore(README.md): add 'Use config to set key' to the to-do list
- 🔖 chore(pyproject.toml): bump up version to 0.1.6

Styling

- 🎨 style(tutorial/help.gif): add help.gif to tutorial directory
- 🎨 style(README.md): replace markdown image with HTML image tag
- 🎨 style(README.md): resize images in README.md
- 🎨 style(README.md): add image to Chat Config section
- 🎨 style(README.md): add image to Chat Arxiv section
- 🎨 style(tutorial): add gif files for Chat Config and Chat Arxiv sections
- 🎨 style(README.md): update images size and remove unnecessary console output