Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Bug report
about: Report a bug in raglite
labels: bug
body:
- type: textarea
id: description
attributes:
label: Description
description: What happened?
validations:
required: true
- type: input
id: version
attributes:
label: raglite version
- type: textarea
id: steps
attributes:
label: Steps to reproduce
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Feature request
about: Suggest an idea for raglite
labels: enhancement
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Briefly describe the feature.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
28 changes: 14 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,30 @@ on:

jobs:
build:
runs-on: ${{ matrix.os }}
runs-on: ubuntu-latest
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ['3.10', '3.11', '3.12']
python-version: ["3.10", "3.11"]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Cache pip
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[dev]
pip install -e .[dev,server]
- name: Lint
run: |
ruff check .
black --check .
ruff check src tests
black --check src tests
isort --check-only src tests
- name: Type check
run: mypy raglite_sqlite
- name: Test
run: pytest --cov=raglite_sqlite
run: |
mypy src
- name: Tests
run: |
pytest -q
- name: Self-test
run: |
raglite self-test
23 changes: 10 additions & 13 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
repos:
- repo: https://github.com/psf/black
rev: 24.4.2
rev: 23.12.1
hooks:
- id: black
args: ["--line-length", "100"]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.4.8
hooks:
- id: ruff
args: ["--fix", "--exit-non-zero-on-fix"]
- id: ruff-format
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
args: ["--profile", "black", "--line-length", "100"]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.9
hooks:
- id: ruff
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.8.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
- id: mypy
additional_dependencies:
- types-requests
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Changelog

## 0.1.0 - 2024-05-01
- Initial release of raglite with SQLite-backed RAG pipeline, Typer CLI, FastAPI server, and demo corpus.
29 changes: 29 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone.

## Our Standards

Examples of behaviour that contributes to a positive environment include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback

## Enforcement Responsibilities

Project maintainers are responsible for clarifying and enforcing our standards of acceptable behaviour.

## Scope

This Code of Conduct applies within all community spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the maintainers at `opensource@example.com`.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing to raglite

Thank you for helping improve raglite! The project aims to provide a practical local-first RAG stack powered by SQLite.

## Getting started

1. Fork and clone the repository.
2. Install dependencies: `pip install -e .[dev,server]`.
3. Enable pre-commit hooks: `pre-commit install`.
4. Run the demo self-test: `raglite self-test`.

## Development workflow

- Make sure `pytest -q` passes before submitting a pull request.
- Run `ruff`, `mypy`, and `black` using the provided pre-commit configuration.
- Update documentation and add tests for new features.
- Follow the MIT license and keep dependencies minimal.

## Reporting issues

Open an issue with detailed reproduction steps, expected behaviour, and environment information. Attach logs if available.

## Code of conduct

Please review `CODE_OF_CONDUCT.md` for community guidelines.
Loading
Loading