Add support for automated testing with Github Actions #69
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I have added a small documentation on how to setup local env for testing. **Changes in pyproject.toml** `pytest` was not picking up local changes. It was giving `ModuleNotFoundError` error for `chonkie`. Adding `pythonpath` fixed that. **Automated Testing** I have also added a github action to run the tests automatically on each `git push`. I have used `uv` because of superfast dependency installation. I followed this guide for the GitHub Actions setup: https://docs.astral.sh/uv/guides/integration/github/
Added automated testing using Github Actions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes multiple changes to improve automated testing, enhance documentation, and refine code functionality. The most important changes include adding a GitHub Actions workflow for automated testing, updating the
README.mdwith development instructions, modifying theBaseChunkerclass, and adding conditional skips for tests that require an OpenAI API key.Automated Testing:
.github/workflows/tests.yml: Added a GitHub Actions workflow to automate testing on push events. This includes steps to check out the repository, set up Python, install dependencies, and run tests.Documentation:
README.md: Added a new "Development" section with instructions on how to clone the repository, set up a virtual environment, install dependencies, and run tests.Code Enhancements:
src/chonkie/chunker/base.py: Modified theBaseChunkerclass to rename thetokenizerparameter totokenizer_or_token_counterfor clarity and updated the initialization logic accordingly.Testing Improvements:
tests/chunker/test_semantic_chunker.py,tests/embeddings/test_openai_embeddings.py: Addedpytest.mark.skipifdecorators to conditionally skip tests that require theOPENAI_API_KEYenvironment variable if it is not defined. [1] [2] [3] [4] [5]Configuration:
pyproject.toml: Addedpythonpathconfiguration forpytestand updatedruffsettings to includeDOCin theselectlist.