Feat/init project - #1
Merged
Merged
Conversation
Add .gitignore entries for .context/, .cursorrules, and .cursor/rules/ so local notes and personal Cursor configuration stay out of version control. Made-with: Cursor
- Introduced a commit-msg hook to enforce Conventional Commits format. - Added __init__.py to define the package version as "0.0.1.dev0". - Created a smoke test to verify the package import and version.
- Updated .gitignore to include macOS and Visual Studio Code files. - Added pyproject.toml for project metadata and dependency management. - Introduced uv.lock for dependency resolution. - Created CI workflow in GitHub Actions for automated testing and linting.
- Created CHANGELOG.md to document notable changes and adhere to Semantic Versioning. - Expanded README.md with project description, status, quickstart instructions, and CI badge.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR adds the initial scaffold for bigos, a high-level document ingestion library aimed at RAG pipelines. Scope is foundation-only: packaging layout, developer tooling, CI, and documentation—no domain ingestion logic yet.
What’s included
pyproject.tomlwith Hatchling,requires-python >= 3.11, Apache-2.0, empty runtime dependencies, and adevdependency group (pytest, pytest-asyncio, pytest-cov, ruff, mypy, hypothesis).src/bigos/package with__version__, plustests/test_smoke.pyasserting the public version string.pyproject.toml.mainand pull requests, matrix Python 3.11 & 3.12, using uv for sync and running ruff (check + format), mypy, and pytest with coverage.README.md(status + quickstart),CHANGELOG.mdentry for0.0.1.dev0, and.gitignoreupdates (e.g. macOS,.vscode/).uv.lockcommitted for consistent resolution in CI and locally..githooks/commit-msg(conventional/structured commit message checks) for those who wire hooks locally.How to verify
Notes
__version__only) until APIs stabilize.README.mdonce the repository path is final (OWNER/REPO).