diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..ada8f5f --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,13 @@ +cff-version: 1.2.0 +message: "If you use this software, please cite it as below." +title: Retriever +abstract: "AI-powered document Q&A for organizations using retrieval-augmented generation over multi-format documents." +type: software +authors: + - given-names: Chris + family-names: Krough + alias: ckrough +repository-code: "https://github.com/ckrough/retriever" +url: "https://dev.krough.org" +license: Apache-2.0 +copyright: "Copyright (C) 2025 Backchain LLC" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c50ca4d..cd7dfe2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Retriever is an AI-powered Q&A system using RAG (Retrieval-Augmented Generation) ```bash # Clone (or fork first, then clone your fork) -git clone https://github.com/your-org/retriever.git +git clone https://github.com/ckrough/retriever.git cd retriever cp .env.example .env # Edit .env, add your API keys (see Environment Configuration below) @@ -21,18 +21,13 @@ uv sync --dev uv run alembic upgrade head uv run uvicorn retriever.main:app --reload --port 8000 # → http://localhost:8000/health - -# Frontend (separate terminal) -cd frontend -npm install -npm run dev -# → http://localhost:5173 ``` +The frontend portal lives in the separate [stacker](https://github.com/ckrough/stacker) repository. + ## Prerequisites - **Python 3.13+** with [uv](https://docs.astral.sh/uv/) -- **Node.js 22+** with npm - **Docker** (for postgres + jaeger via `docker compose`) - **[Supabase CLI](https://supabase.com/docs/guides/cli)** (for local auth) - **API keys:** @@ -61,14 +56,10 @@ OPENAI_API_KEY=your-key-here supabase start docker compose up -d -# Backend (terminal 1) +# Backend cd backend uv run uvicorn retriever.main:app --reload --port 8000 -# Frontend (terminal 2) -cd frontend -npm run dev - # Stop everything docker compose down supabase stop @@ -98,19 +89,6 @@ uv run python -m mypy src/ --strict && \ uv run python -m pytest tests/ --cov=src/retriever --cov-fail-under=80 ``` -### Frontend (run from `frontend/`) - -```bash -# Type checking (TypeScript + Svelte) -npm run check - -# Production build -npm run build - -# E2E tests (requires build first) -npm run test:e2e -``` - ## Making Changes We use **GitHub Flow**: feature branches → pull request → squash merge to `main`. @@ -163,7 +141,6 @@ Types: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, `chore:` ## PR Checklist - [ ] All backend quality checks pass -- [ ] Frontend checks pass (`npm run check && npm run build`) - [ ] New code has tests (80% coverage) - [ ] No secrets or API keys committed - [ ] Documentation updated if needed @@ -174,9 +151,6 @@ Types: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, `chore:` Recommended extensions: - Python + Pylance -- Svelte for VS Code -- ESLint -- Tailwind CSS IntelliSense Debug config (F5) and quality check tasks (Ctrl+Shift+P → Run Task) are preconfigured in `.vscode/`. @@ -187,11 +161,11 @@ retriever/ ├── backend/ # FastAPI + SQLAlchemy + pgvector (active development) │ ├── src/retriever/ # Application source │ └── tests/ # Backend tests -├── frontend/ # SvelteKit + Svelte 5 + Skeleton UI (active development) -│ └── src/ # SvelteKit source └── docs/ # Architecture docs and ADRs ``` +The frontend portal lives in the separate [stacker](https://github.com/ckrough/stacker) repository. + ## Understanding the Codebase - **Quick patterns & conventions** → [CLAUDE.md](CLAUDE.md) @@ -201,10 +175,12 @@ retriever/ ## Getting Help -- Check existing [issues](https://github.com/your-org/retriever/issues) first +- Check existing [issues](https://github.com/ckrough/retriever/issues) first - Open a new issue with context: what you tried, error messages, environment details - See [CLAUDE.md](CLAUDE.md) for gotchas and non-obvious patterns ## License of Contributions -This project is licensed under GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). By submitting a contribution, you agree that your contribution is licensed under the same terms. +This project is licensed under the Apache License 2.0 (Apache-2.0). By submitting a contribution, you agree that your contribution is licensed under Apache-2.0. You retain copyright on your contributions. + +There is no Contributor License Agreement (CLA), no Developer Certificate of Origin (DCO) sign-off, and no copyright assignment. The public license is the license. diff --git a/LICENSE b/LICENSE index be3f7b2..d645695 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,202 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..48b765b --- /dev/null +++ b/NOTICE @@ -0,0 +1,6 @@ +Retriever +Copyright (C) 2025 Backchain LLC +https://backchain.ai + +This product is licensed under the Apache License, Version 2.0. +See the LICENSE file for the full license text. diff --git a/README.md b/README.md index 66efdc8..e98a350 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ Documentation

---- +# Retriever: AI-Powered Document Q&A with RAG + +Retriever is an open-source retrieval-augmented generation (RAG) system for document question-answering. It indexes an organization's PDFs, Word documents, spreadsheets, and web pages, then answers natural-language questions with cited sources. Built by [Chris Krough](https://dev.krough.org) under [Backchain](https://backchain.ai). Retriever is an AI-powered question-answering system that helps users find information in your organization's policy and procedure documents. Upload your documents, and Retriever uses RAG (Retrieval-Augmented Generation) to provide accurate, sourced answers. @@ -37,7 +39,6 @@ Retriever can be adapted for any organization with documentation that users need ### Prerequisites - Python 3.13+ with [uv](https://docs.astral.sh/uv/) -- Node.js 22+ - Docker - [Supabase CLI](https://supabase.com/docs/guides/cli) - API keys: [OpenRouter](https://openrouter.ai/keys) (LLM) and [OpenAI](https://platform.openai.com/api-keys) (embeddings/moderation) @@ -45,7 +46,7 @@ Retriever can be adapted for any organization with documentation that users need ### Get Running ```bash -git clone https://github.com/your-org/retriever.git +git clone https://github.com/ckrough/retriever.git cd retriever cp .env.example .env # Edit .env with your API keys @@ -56,12 +57,9 @@ docker compose up -d # pgvector postgres + jaeger cd backend && uv sync --dev uv run alembic upgrade head uv run uvicorn retriever.main:app --reload --port 8000 - -# In a separate terminal: -cd frontend && npm install && npm run dev ``` -Backend API: [http://localhost:8000/docs](http://localhost:8000/docs) | Frontend: [http://localhost:5173](http://localhost:5173) +Backend API: [http://localhost:8000/docs](http://localhost:8000/docs). The frontend portal lives in the separate [stacker](https://github.com/ckrough/stacker) repository. See [CONTRIBUTING.md](CONTRIBUTING.md) for full development setup, quality checks, and workflow. @@ -111,8 +109,8 @@ For best results: ## Deployment - **Backend:** Cloud Run via `gcloud run deploy --source ./backend` -- **Frontend:** Cloudflare Pages - **Database:** Supabase (managed Postgres + pgvector) +- **Frontend:** deployed from the [stacker](https://github.com/ckrough/stacker) repository (Cloudflare Pages) ### Production Checklist @@ -141,10 +139,10 @@ For best results: - **Backend:** Python 3.13+, FastAPI, SQLAlchemy 2.0 async, Pydantic 2.x - **LLM:** OpenRouter via Cloudflare AI Gateway - **Vector DB:** Supabase Postgres + pgvector (HNSW cosine + GIN full-text) -- **Frontend:** SvelteKit + Svelte 5 runes + Skeleton UI v4 - **Auth:** Supabase Auth / JWKS - **Observability:** structlog + OpenTelemetry + Langfuse -- **Deploy:** Cloud Run (backend), Cloudflare Pages (frontend) +- **Deploy:** Cloud Run (backend) +- **Frontend:** [stacker](https://github.com/ckrough/stacker) (separate repo): SvelteKit + Svelte 5 runes + Skeleton UI v4 ## Development @@ -160,6 +158,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for full setup and quality check commands ## License -GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). See [LICENSE](LICENSE) for the full text. +Apache License 2.0 (Apache-2.0). See [LICENSE](LICENSE) for the full text and [NOTICE](NOTICE) for attribution. Copyright (C) 2025 Backchain LLC + +## About / Built by + +I'm [Chris Krough](https://dev.krough.org), and I build production AI systems like this one. Retriever is the kind of work I do: retrieval pipelines, LLM safety, and observability shipped as real, deployable software. Find me on [my site](https://dev.krough.org) and [LinkedIn](https://linkedin.com/in/ckrough). + +Retriever is developed and maintained under [Backchain](https://backchain.ai), my AI transformation consulting practice. Backchain helps organizations discover where AI works: [Discover Where AI Works](https://backchain.ai). + +If Retriever is useful to you, star the repo and reach out. I'm open to collaboration, consulting, and conversations about applied AI. diff --git a/backend/pyproject.toml b/backend/pyproject.toml index 0dd8d82..19f1f7e 100644 --- a/backend/pyproject.toml +++ b/backend/pyproject.toml @@ -8,8 +8,9 @@ version = "1.5.0" description = "AI-powered Q&A system for shelter volunteers" readme = "README.md" requires-python = ">=3.13" -license = "AGPL-3.0-or-later" -authors = [{ name = "Backchain LLC" }] +license = "Apache-2.0" +authors = [{ name = "Chris Krough", email = "dev@krough.org" }] +maintainers = [{ name = "Chris Krough", email = "dev@krough.org" }] dependencies = [ "fastapi>=0.115", @@ -38,6 +39,11 @@ dependencies = [ "easyocr>=1.7.2", ] +[project.urls] +Homepage = "https://dev.krough.org" +Repository = "https://github.com/ckrough/retriever" +Documentation = "https://github.com/ckrough/retriever/tree/main/docs" + [tool.hatch.build.targets.wheel] packages = ["src/retriever"] diff --git a/backend/src/retriever/__init__.py b/backend/src/retriever/__init__.py index e69de29..f30c074 100644 --- a/backend/src/retriever/__init__.py +++ b/backend/src/retriever/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 diff --git a/backend/src/retriever/config.py b/backend/src/retriever/config.py index 8cea386..a5c6625 100644 --- a/backend/src/retriever/config.py +++ b/backend/src/retriever/config.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Application configuration via pydantic-settings.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/__init__.py b/backend/src/retriever/infrastructure/__init__.py index e69de29..f30c074 100644 --- a/backend/src/retriever/infrastructure/__init__.py +++ b/backend/src/retriever/infrastructure/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 diff --git a/backend/src/retriever/infrastructure/cache/__init__.py b/backend/src/retriever/infrastructure/cache/__init__.py index 01f1af6..b76445d 100644 --- a/backend/src/retriever/infrastructure/cache/__init__.py +++ b/backend/src/retriever/infrastructure/cache/__init__.py @@ -1 +1,4 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Semantic cache infrastructure.""" diff --git a/backend/src/retriever/infrastructure/cache/pg_cache.py b/backend/src/retriever/infrastructure/cache/pg_cache.py index 5a0d718..d031184 100644 --- a/backend/src/retriever/infrastructure/cache/pg_cache.py +++ b/backend/src/retriever/infrastructure/cache/pg_cache.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Semantic cache backed by pgvector cosine similarity.""" import uuid diff --git a/backend/src/retriever/infrastructure/cache/protocol.py b/backend/src/retriever/infrastructure/cache/protocol.py index 8294391..8d733c1 100644 --- a/backend/src/retriever/infrastructure/cache/protocol.py +++ b/backend/src/retriever/infrastructure/cache/protocol.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """SemanticCache protocol — defines the interface for query result caching.""" import uuid diff --git a/backend/src/retriever/infrastructure/database/__init__.py b/backend/src/retriever/infrastructure/database/__init__.py index 5f767bf..d3ead22 100644 --- a/backend/src/retriever/infrastructure/database/__init__.py +++ b/backend/src/retriever/infrastructure/database/__init__.py @@ -1 +1,4 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Database session infrastructure.""" diff --git a/backend/src/retriever/infrastructure/database/session.py b/backend/src/retriever/infrastructure/database/session.py index 6f833d7..5c5ab72 100644 --- a/backend/src/retriever/infrastructure/database/session.py +++ b/backend/src/retriever/infrastructure/database/session.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI database session dependency.""" from collections.abc import AsyncGenerator diff --git a/backend/src/retriever/infrastructure/embeddings/__init__.py b/backend/src/retriever/infrastructure/embeddings/__init__.py index ef1a8be..f3f0856 100644 --- a/backend/src/retriever/infrastructure/embeddings/__init__.py +++ b/backend/src/retriever/infrastructure/embeddings/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Embedding provider infrastructure.""" from retriever.infrastructure.embeddings.exceptions import ( diff --git a/backend/src/retriever/infrastructure/embeddings/exceptions.py b/backend/src/retriever/infrastructure/embeddings/exceptions.py index f235b70..aa2ee6e 100644 --- a/backend/src/retriever/infrastructure/embeddings/exceptions.py +++ b/backend/src/retriever/infrastructure/embeddings/exceptions.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Exceptions for embedding providers.""" diff --git a/backend/src/retriever/infrastructure/embeddings/openai.py b/backend/src/retriever/infrastructure/embeddings/openai.py index e0b2ae0..de869a8 100644 --- a/backend/src/retriever/infrastructure/embeddings/openai.py +++ b/backend/src/retriever/infrastructure/embeddings/openai.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """OpenAI embedding provider implementation.""" from datetime import timedelta diff --git a/backend/src/retriever/infrastructure/embeddings/protocol.py b/backend/src/retriever/infrastructure/embeddings/protocol.py index 9e2ae06..06cbfc0 100644 --- a/backend/src/retriever/infrastructure/embeddings/protocol.py +++ b/backend/src/retriever/infrastructure/embeddings/protocol.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Protocol definition for embedding providers.""" from typing import Protocol diff --git a/backend/src/retriever/infrastructure/llm/__init__.py b/backend/src/retriever/infrastructure/llm/__init__.py index b8090b4..65cf9e0 100644 --- a/backend/src/retriever/infrastructure/llm/__init__.py +++ b/backend/src/retriever/infrastructure/llm/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """LLM provider abstraction layer.""" from retriever.infrastructure.llm.exceptions import ( diff --git a/backend/src/retriever/infrastructure/llm/exceptions.py b/backend/src/retriever/infrastructure/llm/exceptions.py index 7eca3e7..c4980db 100644 --- a/backend/src/retriever/infrastructure/llm/exceptions.py +++ b/backend/src/retriever/infrastructure/llm/exceptions.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Custom exceptions for LLM provider operations.""" diff --git a/backend/src/retriever/infrastructure/llm/fallback.py b/backend/src/retriever/infrastructure/llm/fallback.py index 0f5d41a..dff03f2 100644 --- a/backend/src/retriever/infrastructure/llm/fallback.py +++ b/backend/src/retriever/infrastructure/llm/fallback.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Fallback LLM provider with model degradation.""" import structlog diff --git a/backend/src/retriever/infrastructure/llm/openrouter.py b/backend/src/retriever/infrastructure/llm/openrouter.py index 2079f22..5fccfa4 100644 --- a/backend/src/retriever/infrastructure/llm/openrouter.py +++ b/backend/src/retriever/infrastructure/llm/openrouter.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """OpenRouter LLM provider implementation.""" from datetime import timedelta diff --git a/backend/src/retriever/infrastructure/llm/protocol.py b/backend/src/retriever/infrastructure/llm/protocol.py index 5856853..1ef1f46 100644 --- a/backend/src/retriever/infrastructure/llm/protocol.py +++ b/backend/src/retriever/infrastructure/llm/protocol.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Protocol definition for LLM providers.""" from typing import Protocol diff --git a/backend/src/retriever/infrastructure/observability/__init__.py b/backend/src/retriever/infrastructure/observability/__init__.py index e69de29..f30c074 100644 --- a/backend/src/retriever/infrastructure/observability/__init__.py +++ b/backend/src/retriever/infrastructure/observability/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 diff --git a/backend/src/retriever/infrastructure/observability/langfuse.py b/backend/src/retriever/infrastructure/observability/langfuse.py index cc2d77c..55668fa 100644 --- a/backend/src/retriever/infrastructure/observability/langfuse.py +++ b/backend/src/retriever/infrastructure/observability/langfuse.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Langfuse LLM observability integration. Provides @observe() decorator for tracing LLM calls with token tracking diff --git a/backend/src/retriever/infrastructure/observability/logging.py b/backend/src/retriever/infrastructure/observability/logging.py index 5bc0f4b..ba2c5c1 100644 --- a/backend/src/retriever/infrastructure/observability/logging.py +++ b/backend/src/retriever/infrastructure/observability/logging.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Structlog configuration with JSON output and OTel trace correlation.""" import logging diff --git a/backend/src/retriever/infrastructure/observability/middleware.py b/backend/src/retriever/infrastructure/observability/middleware.py index 6f00763..f313af3 100644 --- a/backend/src/retriever/infrastructure/observability/middleware.py +++ b/backend/src/retriever/infrastructure/observability/middleware.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Request ID middleware for tracing requests through the system.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/observability/tracing.py b/backend/src/retriever/infrastructure/observability/tracing.py index a319872..b34df04 100644 --- a/backend/src/retriever/infrastructure/observability/tracing.py +++ b/backend/src/retriever/infrastructure/observability/tracing.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """OpenTelemetry tracing configuration. Supports three exporter backends: diff --git a/backend/src/retriever/infrastructure/safety/__init__.py b/backend/src/retriever/infrastructure/safety/__init__.py index 1000a81..e236cbf 100644 --- a/backend/src/retriever/infrastructure/safety/__init__.py +++ b/backend/src/retriever/infrastructure/safety/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Content safety infrastructure for input/output filtering.""" from retriever.infrastructure.safety.confidence import ConfidenceScorer diff --git a/backend/src/retriever/infrastructure/safety/confidence.py b/backend/src/retriever/infrastructure/safety/confidence.py index 4c6c9e6..ac9effe 100644 --- a/backend/src/retriever/infrastructure/safety/confidence.py +++ b/backend/src/retriever/infrastructure/safety/confidence.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Confidence scoring for RAG responses.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/safety/detector.py b/backend/src/retriever/infrastructure/safety/detector.py index 258cf3a..15b5456 100644 --- a/backend/src/retriever/infrastructure/safety/detector.py +++ b/backend/src/retriever/infrastructure/safety/detector.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Prompt injection detection using pattern matching.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/safety/hallucination.py b/backend/src/retriever/infrastructure/safety/hallucination.py index 75c1d62..f9e1366 100644 --- a/backend/src/retriever/infrastructure/safety/hallucination.py +++ b/backend/src/retriever/infrastructure/safety/hallucination.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Hallucination detection by verifying claims against source chunks.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/safety/moderation.py b/backend/src/retriever/infrastructure/safety/moderation.py index 687b1a8..3b7b59d 100644 --- a/backend/src/retriever/infrastructure/safety/moderation.py +++ b/backend/src/retriever/infrastructure/safety/moderation.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Content moderation using OpenAI Moderation API.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/safety/schemas.py b/backend/src/retriever/infrastructure/safety/schemas.py index 88f06d0..0904e81 100644 --- a/backend/src/retriever/infrastructure/safety/schemas.py +++ b/backend/src/retriever/infrastructure/safety/schemas.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Schemas for content safety.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/safety/service.py b/backend/src/retriever/infrastructure/safety/service.py index f69955b..c81b06a 100644 --- a/backend/src/retriever/infrastructure/safety/service.py +++ b/backend/src/retriever/infrastructure/safety/service.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Safety service orchestrating all content safety checks.""" from __future__ import annotations diff --git a/backend/src/retriever/infrastructure/vectordb/__init__.py b/backend/src/retriever/infrastructure/vectordb/__init__.py index 3a451ab..fd64c3f 100644 --- a/backend/src/retriever/infrastructure/vectordb/__init__.py +++ b/backend/src/retriever/infrastructure/vectordb/__init__.py @@ -1 +1,4 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Vector database infrastructure.""" diff --git a/backend/src/retriever/infrastructure/vectordb/pgvector_store.py b/backend/src/retriever/infrastructure/vectordb/pgvector_store.py index e017669..2090ec0 100644 --- a/backend/src/retriever/infrastructure/vectordb/pgvector_store.py +++ b/backend/src/retriever/infrastructure/vectordb/pgvector_store.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """pgvector-backed VectorStore implementation.""" import uuid diff --git a/backend/src/retriever/infrastructure/vectordb/protocol.py b/backend/src/retriever/infrastructure/vectordb/protocol.py index 9543b50..9e20261 100644 --- a/backend/src/retriever/infrastructure/vectordb/protocol.py +++ b/backend/src/retriever/infrastructure/vectordb/protocol.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """VectorStore protocol — defines the interface for vector similarity search.""" import uuid diff --git a/backend/src/retriever/main.py b/backend/src/retriever/main.py index dd6b4ad..53a4bae 100644 --- a/backend/src/retriever/main.py +++ b/backend/src/retriever/main.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI application entry point.""" from __future__ import annotations diff --git a/backend/src/retriever/models/__init__.py b/backend/src/retriever/models/__init__.py index 3b9dcd3..f011b61 100644 --- a/backend/src/retriever/models/__init__.py +++ b/backend/src/retriever/models/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """SQLAlchemy domain models.""" from retriever.models.base import Base diff --git a/backend/src/retriever/models/base.py b/backend/src/retriever/models/base.py index 48117b2..f6baae9 100644 --- a/backend/src/retriever/models/base.py +++ b/backend/src/retriever/models/base.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """SQLAlchemy 2.0 async engine, session factory, and declarative base.""" import re diff --git a/backend/src/retriever/models/document.py b/backend/src/retriever/models/document.py index 2f22bd6..167aae9 100644 --- a/backend/src/retriever/models/document.py +++ b/backend/src/retriever/models/document.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document model for RAG source documents.""" import uuid diff --git a/backend/src/retriever/models/message.py b/backend/src/retriever/models/message.py index 23eb94c..79cd715 100644 --- a/backend/src/retriever/models/message.py +++ b/backend/src/retriever/models/message.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Message model for conversation history.""" import uuid diff --git a/backend/src/retriever/models/user.py b/backend/src/retriever/models/user.py index dd4cdba..bf34928 100644 --- a/backend/src/retriever/models/user.py +++ b/backend/src/retriever/models/user.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """User model — mirrors Supabase Auth users.""" import uuid diff --git a/backend/src/retriever/modules/__init__.py b/backend/src/retriever/modules/__init__.py index e69de29..f30c074 100644 --- a/backend/src/retriever/modules/__init__.py +++ b/backend/src/retriever/modules/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 diff --git a/backend/src/retriever/modules/auth/__init__.py b/backend/src/retriever/modules/auth/__init__.py index 50778ed..ee2c8f4 100644 --- a/backend/src/retriever/modules/auth/__init__.py +++ b/backend/src/retriever/modules/auth/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Supabase Auth: JWKS-based JWT validation and FastAPI dependencies.""" from retriever.modules.auth.dependencies import require_admin, require_auth diff --git a/backend/src/retriever/modules/auth/dependencies.py b/backend/src/retriever/modules/auth/dependencies.py index 0444b85..3d075d1 100644 --- a/backend/src/retriever/modules/auth/dependencies.py +++ b/backend/src/retriever/modules/auth/dependencies.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI auth dependencies for route protection.""" from functools import lru_cache diff --git a/backend/src/retriever/modules/auth/jwks.py b/backend/src/retriever/modules/auth/jwks.py index cb7d8ae..860a45d 100644 --- a/backend/src/retriever/modules/auth/jwks.py +++ b/backend/src/retriever/modules/auth/jwks.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """JWKS-based JWT validation for Supabase RS256 tokens.""" from typing import Any diff --git a/backend/src/retriever/modules/auth/schemas.py b/backend/src/retriever/modules/auth/schemas.py index dcd7ca1..25e73fe 100644 --- a/backend/src/retriever/modules/auth/schemas.py +++ b/backend/src/retriever/modules/auth/schemas.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Auth data types.""" from dataclasses import dataclass diff --git a/backend/src/retriever/modules/documents/__init__.py b/backend/src/retriever/modules/documents/__init__.py index 46707a7..d49360f 100644 --- a/backend/src/retriever/modules/documents/__init__.py +++ b/backend/src/retriever/modules/documents/__init__.py @@ -1 +1,4 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Documents module: upload, manage, and delete RAG source documents.""" diff --git a/backend/src/retriever/modules/documents/exceptions.py b/backend/src/retriever/modules/documents/exceptions.py index d06ab5b..65618ce 100644 --- a/backend/src/retriever/modules/documents/exceptions.py +++ b/backend/src/retriever/modules/documents/exceptions.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document module exceptions.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/documents/repos.py b/backend/src/retriever/modules/documents/repos.py index d76468d..1dd39e5 100644 --- a/backend/src/retriever/modules/documents/repos.py +++ b/backend/src/retriever/modules/documents/repos.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document repository — async persistence for RAG source documents.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/documents/routes.py b/backend/src/retriever/modules/documents/routes.py index a9403a2..07aa716 100644 --- a/backend/src/retriever/modules/documents/routes.py +++ b/backend/src/retriever/modules/documents/routes.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI routes for document management.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/documents/schemas.py b/backend/src/retriever/modules/documents/schemas.py index e6c84fe..5571828 100644 --- a/backend/src/retriever/modules/documents/schemas.py +++ b/backend/src/retriever/modules/documents/schemas.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Pydantic response schemas for the documents module.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/documents/services.py b/backend/src/retriever/modules/documents/services.py index 3d57980..c4c632f 100644 --- a/backend/src/retriever/modules/documents/services.py +++ b/backend/src/retriever/modules/documents/services.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document service — orchestrates upload, indexing, and deletion.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/messages/__init__.py b/backend/src/retriever/modules/messages/__init__.py index 0a2b094..0aa81c5 100644 --- a/backend/src/retriever/modules/messages/__init__.py +++ b/backend/src/retriever/modules/messages/__init__.py @@ -1 +1,4 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Conversation history module: routes, repository, and schemas.""" diff --git a/backend/src/retriever/modules/messages/repos.py b/backend/src/retriever/modules/messages/repos.py index 8a15a52..29d2a6f 100644 --- a/backend/src/retriever/modules/messages/repos.py +++ b/backend/src/retriever/modules/messages/repos.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Message repository — async persistence for conversation history.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/messages/routes.py b/backend/src/retriever/modules/messages/routes.py index ecffac1..6f93250 100644 --- a/backend/src/retriever/modules/messages/routes.py +++ b/backend/src/retriever/modules/messages/routes.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI routes for conversation history.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/messages/schemas.py b/backend/src/retriever/modules/messages/schemas.py index 38a2e96..dfa9935 100644 --- a/backend/src/retriever/modules/messages/schemas.py +++ b/backend/src/retriever/modules/messages/schemas.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Pydantic response schemas for the messages module.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/rag/__init__.py b/backend/src/retriever/modules/rag/__init__.py index 70db89b..50a7e2d 100644 --- a/backend/src/retriever/modules/rag/__init__.py +++ b/backend/src/retriever/modules/rag/__init__.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """RAG pipeline module — chunking, loading, prompts, and schemas.""" from retriever.modules.rag.service import RAGService diff --git a/backend/src/retriever/modules/rag/dependencies.py b/backend/src/retriever/modules/rag/dependencies.py index 647d878..0df32a0 100644 --- a/backend/src/retriever/modules/rag/dependencies.py +++ b/backend/src/retriever/modules/rag/dependencies.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI dependency providers for RAG pipeline components.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/rag/docling_processor.py b/backend/src/retriever/modules/rag/docling_processor.py index 8043777..b03fbaf 100644 --- a/backend/src/retriever/modules/rag/docling_processor.py +++ b/backend/src/retriever/modules/rag/docling_processor.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Docling-based document processing for the RAG pipeline. All Docling imports are deferred to method bodies to avoid loading diff --git a/backend/src/retriever/modules/rag/exceptions.py b/backend/src/retriever/modules/rag/exceptions.py index c62f29b..b83c070 100644 --- a/backend/src/retriever/modules/rag/exceptions.py +++ b/backend/src/retriever/modules/rag/exceptions.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document conversion error types for the RAG pipeline.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/rag/loader.py b/backend/src/retriever/modules/rag/loader.py index df04a2a..ec825c3 100644 --- a/backend/src/retriever/modules/rag/loader.py +++ b/backend/src/retriever/modules/rag/loader.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Document loading and validation for the RAG pipeline. Validates file uploads by extension and size. Format-aware limits diff --git a/backend/src/retriever/modules/rag/prompts.py b/backend/src/retriever/modules/rag/prompts.py index 3a4d608..efd7b57 100644 --- a/backend/src/retriever/modules/rag/prompts.py +++ b/backend/src/retriever/modules/rag/prompts.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """RAG-specific prompts for Retriever. These prompts are designed for retrieval-augmented generation, diff --git a/backend/src/retriever/modules/rag/retriever.py b/backend/src/retriever/modules/rag/retriever.py index 487f457..2b004a9 100644 --- a/backend/src/retriever/modules/rag/retriever.py +++ b/backend/src/retriever/modules/rag/retriever.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Hybrid retriever combining semantic and keyword search. Replaces the old in-memory BM25 approach with SQL ts_rank via an diff --git a/backend/src/retriever/modules/rag/routes.py b/backend/src/retriever/modules/rag/routes.py index 7f614dd..1d58f99 100644 --- a/backend/src/retriever/modules/rag/routes.py +++ b/backend/src/retriever/modules/rag/routes.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """FastAPI routes for the RAG ask endpoint.""" from __future__ import annotations diff --git a/backend/src/retriever/modules/rag/schemas.py b/backend/src/retriever/modules/rag/schemas.py index 5084287..d81ecbf 100644 --- a/backend/src/retriever/modules/rag/schemas.py +++ b/backend/src/retriever/modules/rag/schemas.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """Schemas for the RAG module. Pydantic models and Protocol definitions for document processing diff --git a/backend/src/retriever/modules/rag/service.py b/backend/src/retriever/modules/rag/service.py index 2536021..a073c09 100644 --- a/backend/src/retriever/modules/rag/service.py +++ b/backend/src/retriever/modules/rag/service.py @@ -1,3 +1,6 @@ +# Copyright (C) 2025 Backchain LLC +# SPDX-License-Identifier: Apache-2.0 + """RAG service orchestrating retrieval and generation.""" from __future__ import annotations diff --git a/backend/uv.lock b/backend/uv.lock index 9eb9b70..4019d6d 100644 --- a/backend/uv.lock +++ b/backend/uv.lock @@ -2882,7 +2882,7 @@ wheels = [ [[package]] name = "retriever" -version = "1.3.0" +version = "1.5.0" source = { editable = "." } dependencies = [ { name = "aiobreaker" }, diff --git a/docs/decisions/019-apache-2.0-licensing.md b/docs/decisions/019-apache-2.0-licensing.md new file mode 100644 index 0000000..6b42e9c --- /dev/null +++ b/docs/decisions/019-apache-2.0-licensing.md @@ -0,0 +1,72 @@ +--- +adr: 019 +title: Apache-2.0 for all repositories +status: accepted # proposed | accepted | deprecated | superseded +date: 2026-06-09 +tags: [licensing, open-source, governance] +supersedes: null +superseded_by: null +related: [] +--- + +# 019: Apache-2.0 for all repositories + +## Status + +Accepted + +## Context + +Retriever shipped under AGPL-3.0-or-later, following a two-license posture that +applied AGPL to network-deployed services and Apache-2.0 to locally-running +tools. Chris Krough and Backchain have since committed to a single open-source +license for every repository, regardless of artifact class. Attribution is the +return on open source: wide adoption attracts employers (Chris Krough, personal +brand) and business (Backchain). AGPL's network copyleft chilled exactly the +adoption the projects want and protected nothing Backchain monetizes, since +there is no commercial relicense to sell. + +A unilateral relicense is valid only when the relicensing party holds copyright +on all the code. The contributor check (`git shortlog -sne --all`) showed every +human commit authored by Chris Krough, with the only other author being the +`semantic-release` CI bot. Backchain LLC holds copyright on all code, so the +flip is clean. + +## Decision + +Relicense Retriever from AGPL-3.0-or-later to Apache-2.0. This aligns Retriever +with a practice-wide standard: every Chris Krough / Backchain repository ships +true, OSI-compliant open source under Apache-2.0, whether it is a local CLI, a +library, a Claude Code plugin or skill, an eval framework, or a network service. + +Copyright remains Backchain LLC. Contributors retain copyright on their +contributions under Apache-2.0. There is no AGPL, no copyleft, no commercial +license, no dual licensing, and no CLA or DCO. The public license is the license. + +Attribution is dual by design: legal and copyright attribution to Backchain LLC +(LICENSE, NOTICE, per-file SPDX headers); author identity to Chris Krough +(package manifest authors and maintainers, CITATION.cff, README About block). + +## Alternatives Considered + +- **Keep AGPL-3.0-or-later.** Rejected. Network copyleft deters adoption and the + enterprise use that drives employer and business interest, while protecting no + revenue stream Backchain actually has. +- **Two-license split (Apache for tools, AGPL for services).** The prior posture. + Rejected as adding friction and contributor confusion for no benefit; the + license choice should follow the open-source goal, not artifact class. +- **Dual licensing or a commercial relicense option.** Rejected. There is no + commercial license to sell; the offering is the public license. + +## Consequences + +- Downstream users, including commercial and SaaS operators, can adopt and deploy + Retriever without copyleft obligations. This maximizes adoption and the + attribution that travels with it. +- The professional-workspace rule `.claude/rules/repo-licensing.md` still + describes the superseded two-license split; that rule is updated separately + (tracked in prof-qy8r). +- New source files carry an Apache-2.0 SPDX header; existing `backend/src` files + received the header in a one-time sweep. +- GitHub re-detects the repository license as Apache-2.0 once the LICENSE swap + lands on `main`.