diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 36e1483..f0303ba 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -321,22 +321,16 @@ jobs: cat > /tmp/release-notes.md <<- NOTE_EOF Release ${GITHUB_REF_NAME}. - ## MSIX Distribution (v1.2.0+) + ## Assets - Starting with v1.2.0, Windows distribution is migrating to MSIX/App Installer. - In-app self-updating (downloading and running Setup.exe) has been removed. - Update responsibility belongs to Windows packaging, not the app itself. + ### Windows + - \`OpenReader.msix\` — MSIX package. May be unsigned — requires Windows Developer Mode for sideloading. + - \`OpenReader-Setup.exe\` — Legacy Inno Setup installer for manual recovery. Requires administrator rights. + - \`OpenReader-Windows.zip\` — Portable/manual recovery ZIP. - ### Assets for Windows - - **\`OpenReader.msix\`** — ✅ **Recommended for v1.2.0+.** MSIX package with App Installer support for automatic Windows-managed updates. No admin required for per-user install when signed. *(Currently unsigned — requires Windows Developer Mode for sideloading until code signing is procured.)* - - **\`OpenReader-Setup.exe\`** — ✅ **Legacy fallback.** Inno Setup installer with PDF file association, Start Menu shortcut, desktop shortcut, and Add/Remove Programs entry. Requires admin rights. - - \`OpenReader-Windows.zip\` — Portable/manual recovery package. Use only if you need a portable copy or are following SUPPORT.md recovery steps. - - ### Assets for macOS - - \`OpenReader-macOS-Apple-Silicon.zip\` — macOS Apple Silicon app bundle. - - \`OpenReader-macOS-Intel.zip\` — macOS Intel app bundle. - - Packaged builds include the tag-injected app version and canonical release asset names. + ### macOS + - \`OpenReader-macOS-Apple-Silicon.zip\` — Experimental macOS Apple Silicon app bundle. + - \`OpenReader-macOS-Intel.zip\` — Experimental macOS Intel app bundle. NOTE_EOF - name: Publish release diff --git a/AGENTS.md b/AGENTS.md index 1945f8d..06b97cd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -11,11 +11,14 @@ This repository is a local-first desktop PDF utility. Keep maintenance changes b ## Release and Update Rules -- The updater depends on GitHub Release assets, not GitHub Actions artifacts. +- The app detects updates via GitHub API and opens the releases page in a browser. It does not download or install updates. - Canonical release assets must keep these exact names: - `OpenReader-Windows.zip` - `OpenReader-macOS-Apple-Silicon.zip` - `OpenReader-macOS-Intel.zip` + - `OpenReader.msix` (MSIX package for Store submission/advanced use) + - `OpenReader-Setup.exe` (legacy Inno Setup installer) +- The Microsoft Store identity (`SparshSam.OpenReader`) is frozen — never change. - Tag releases with `vMAJOR.MINOR.PATCH`. - Packaged builds must inject the tag version into `main.py` via `scripts/inject_version.py`. - Source builds may remain `-dev`. @@ -42,7 +45,7 @@ This repository is a local-first desktop PDF utility. Keep maintenance changes b ## Documentation Rules - README should describe shipped behavior only. -- Do not overclaim auto-update. It works for packaged builds only when canonical release assets are attached to the latest GitHub Release. +- OpenReader does not install updates itself. Store installations update automatically; GitHub MSIX installations are manual. - Keep Mac signing/Gatekeeper caveats visible until releases are signed and notarized. ## MCP Server (AI Agent Integration) diff --git a/CLAUDE.md b/CLAUDE.md index e0b0739..d6dcb37 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,15 +1,29 @@ -# PDF Reader by Sparsh — Agent Instructions +# OpenReader — Agent Instructions ## Overview -Private, local-first desktop PDF tool for reading, annotation, search, diff, and workspace restore. -Windows primary target; macOS source-build only. +Privacy-first, local-only desktop PDF utility for Windows. +macOS experimental; Linux unsupported. ## Architecture Constraints -1. **Local-first.** No cloud dependency. No network calls beyond the explicit GitHub release update check. +1. **Local-first.** No cloud dependency. No network calls beyond the optional GitHub release update check (no downloads). 2. **Privacy by design.** Treat PDFs as local/private user data. Never upload or transmit document content. -3. **Cross-platform** (Windows primary, macOS secondary). +3. **Cross-platform** (Windows primary, macOS experimental). + +## Distribution and Updates + +- **Microsoft Store** (in certification) — automatic updates after approval. +- **GitHub MSIX** — advanced users, unsigned, requires Developer Mode for sideloading. +- **Legacy Setup.exe** — manual recovery only. +- The app detects updates via GitHub API (opens browser). It never downloads or runs installers. + +## Frozen Identity — Never Change + +- Identity Name: `SparshSam.OpenReader` +- Publisher: `CN=E6186421-BF8A-47E0-A89C-0F513DFF91C0` +- PFN: `SparshSam.OpenReader_yh0byntbzd2qw` +- Store ID: `9MXDVW2645LL` ## Commands @@ -42,8 +56,8 @@ python -m pytest tests/ -v - `OpenReader-Windows.zip` - `OpenReader-macOS-Apple-Silicon.zip` - `OpenReader-macOS-Intel.zip` - - `OpenReader.msix` (MSIX package for beta testing/Store submission) - - `OpenReader-Setup.exe` (legacy Inno Setup installer, when published) + - `OpenReader.msix` (MSIX package) + - `OpenReader-Setup.exe` (legacy installer) - MSIX identity (`SparshSam.OpenReader`) is frozen — never change. - Tag releases with `vMAJOR.MINOR.PATCH`. - Version injected from tag via `scripts/inject_version.py`. @@ -64,7 +78,7 @@ python -m pytest tests/ -v - ARCHITECTURE.md is the canonical architecture reference. - VERSIONING.md documents the versioning scheme. - Keep CHANGELOG.md updated per Keep a Changelog format. -- Keep Mac signing/Gatekeeper caveats visible until releases are signed. +- Keep Mac caveats visible for experimental platform status. ## Security Rules diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7324792..7846871 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Thanks for your interest in improving OpenReader. -This project is source-available for non-commercial use. Contributions are accepted under the same PolyForm Noncommercial License 1.0.0 used by the project. +This project is free software. Contributions are accepted under the same [GNU AGPLv3](LICENSE) used by the project. ## Local Setup diff --git a/LICENSE b/LICENSE index b877575..31af158 100644 --- a/LICENSE +++ b/LICENSE @@ -1,122 +1,644 @@ -PolyForm Noncommercial License 1.0.0 - -https://polyformproject.org/licenses/noncommercial/1.0.0 - -## Acceptance - -In order to get any license under these terms, you must agree to them as -both strict obligations and conditions to all your licenses. - -## Copyright License - -The licensor grants you a copyright license for the software to do -everything you might do with the software that would otherwise infringe -the licensor's copyright in it for any permitted purpose. However, you -may only distribute the software according to Distribution License and -make changes or new works based on the software according to Changes and -New Works License. - -## Distribution License - -The licensor grants you an additional copyright license to distribute -copies of the software. Your license to distribute covers distributing -the software with changes and new works permitted by Changes and New -Works License. - -## Notices - -You must ensure that anyone who gets a copy of any part of the software -from you also gets a copy of these terms or the URL for them above, as -well as copies of any plain-text lines beginning with `Required Notice:` -that the licensor provided with the software. For example: - -> Required Notice: Copyright Yoyodyne, Inc. (http://example.com) - -Required Notice: Copyright Sparsh - -## Changes and New Works License - -The licensor grants you an additional copyright license to make changes -and new works based on the software for any permitted purpose. - -## Patent License - -The licensor grants you a patent license for the software that covers -patent claims the licensor can license, or becomes able to license, that -you would infringe by using the software. - -## Noncommercial Purposes - -Any noncommercial purpose is a permitted purpose. - -## Personal Uses - -Personal use for research, experiment, and testing for the benefit of -public knowledge, personal study, private entertainment, hobby projects, -amateur pursuits, or religious observance, without any anticipated -commercial application, is use for a permitted purpose. - -## Noncommercial Organizations - -Use by any charitable organization, educational institution, public -research organization, public safety or health organization, environmental -protection organization, or government institution is use for a permitted -purpose regardless of the source of funding or obligations resulting from -the funding. - -## Fair Use - -You may have "fair use" rights for the software under the law. These -terms do not limit them. - -## No Other Rights - -These terms do not allow you to sublicense or transfer any of your -licenses to anyone else, or prevent the licensor from granting licenses -to anyone else. These terms do not imply any other licenses. - -## Patent Defense - -If you make any written claim that the software infringes or contributes -to infringement of any patent, your patent license for the software -granted under these terms ends immediately. If your company makes such a -claim, your patent license ends immediately for work on behalf of your -company. - -## Violations - -The first time you are notified in writing that you have violated any of -these terms, or done anything with the software not covered by your -licenses, your licenses can nonetheless continue if you come into full -compliance with these terms, and take practical steps to correct past -violations, within 32 days of receiving notice. Otherwise, all your -licenses end immediately. - -## No Liability - -As far as the law allows, the software comes as is, without any warranty -or condition, and the licensor will not be liable to you for any damages -arising out of these terms or the use or nature of the software, under -any kind of legal claim. - -## Definitions - -The licensor is the individual or entity offering these terms, and the -software is the software the licensor makes available under these terms. - -You refers to the individual or entity agreeing to these terms. - -Your company is any legal entity, sole proprietorship, or other kind of -organization that you work for, plus all organizations that have control -over, are under the control of, or are under common control with that -organization. Control means ownership of substantially all the assets of -an entity, or the power to direct its management and policies by vote, -contract, or otherwise. Control can be direct or indirect. - -Your licenses are all the licenses granted to you for the software under -these terms. - -Use means anything you do with the software requiring one of your -licenses. - -© PolyForm Project Inc. + 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, network server software presents a special problem. 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, but is +not a GNU license. We distribute it for the public, but we intend it +only as a reference for the Affero General Public 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 laws-like protections 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. + + Subject to the terms of this License, 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 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 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 be +otherwise 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 whether 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. + + OpenReader — a privacy-first desktop PDF utility. + Copyright (C) 2026 Sparsh Sam + + 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 . diff --git a/README.md b/README.md index d27a6fa..966ee5f 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@

OpenReader

- A local-first desktop PDF reader for Windows. + A privacy-first desktop PDF utility for Windows.
- Read, search, copy, merge, split, extract, and compress PDFs without uploading documents anywhere. + Read, search, copy, merge, split, extract, and compress PDFs — all locally, no uploads required.

Latest release - License + License Release build CI Security @@ -26,15 +26,11 @@ · Screenshots · - Roadmap - · Build · - Security - · - Verification + Privacy · - Philosophy + AI Agent · Architecture · @@ -43,32 +39,50 @@ ## Overview -OpenReader is a **stable, local-first desktop PDF utility** built with Python, PySide6, and PyMuPDF. It is designed for people who want common PDF tasks in a simple native app without sending private documents to a cloud service. +OpenReader is a **local-first desktop PDF utility** built with Python, PySide6, and PyMuPDF. It is designed for people who want common PDF tasks in a simple native app without sending private documents to a cloud service. The app is intentionally local-first: PDFs are opened, rendered, searched, merged, split, annotated, and compressed on your computer — no uploads, no accounts, no telemetry. -**v1.2.2** (current release) fixes the MSIX manifest for Microsoft Store acceptance. Windows distribution uses MSIX/App Installer with Windows-native updates — the app never replaces itself. See the [changelog](CHANGELOG.md) and [roadmap](ROADMAP.md) for what's new and what's next. +**Current version:** v1.2.2 (June 2026) ## Download -Get the latest builds from the [Releases page](https://github.com/sparshsam/pdfreader-by-sparsh/releases/latest). +### Recommended: Microsoft Store + +The Microsoft Store submission is in certification. Once approved, install OpenReader with one click — automatic updates included. + +*Store link will appear here after certification.* + +### GitHub Releases (Advanced Users) -| Platform | Recommended Download | Alternative | Notes | -|---|---|---|---| -| Windows | `OpenReader.msix` | `OpenReader-Setup.exe` (legacy) or `OpenReader-Windows.zip` | **MSIX (recommended for v1.2.0+):** Windows-managed updates via App Installer. Signed with a future Store identity. No admin required for per-user install when signed. *(Currently unsigned — enable Developer Mode for sideloading.)* **Legacy Setup.exe:** Inno Setup installer, requires admin. ZIP for portable/manual recovery. | -| macOS | — | — | **Not currently stable.** macOS builds are published for source-build testing only. The app may exhibit UI issues, missing features, or crashes. Run from source for the best macOS experience (see [Build From Source](#build-from-source)). | +MSIX packages are available from the [Releases page](https://github.com/sparshsam/pdfreader-by-sparsh/releases). -Windows may show a SmartScreen warning because community builds are not code-signed. macOS may show a Gatekeeper warning because the Mac builds are not Apple-notarized. Only run software from sources you trust. +| Platform | Package | Notes | +|---|---|---| +| Windows 10/11 | `OpenReader.msix` | MSIX package. May be unsigned — requires [Windows Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) for sideloading. | +| Windows 10/11 | `OpenReader-Setup.exe` | Legacy Inno Setup installer for manual recovery. Requires administrator rights. | +| Windows 10/11 | `OpenReader-Windows.zip` | Portable ZIP for manual recovery. | +| macOS | `OpenReader-macOS-*.zip` | **Experimental.** Community-tested. See [macOS notes](docs/macos.md). | +| Linux | — | Unsupported. | -**About the "Unknown Publisher" warning:** The MSIX package currently displays "Unknown Publisher" because GitHub Release builds are unsigned. The Microsoft Store will sign the package automatically with the Store identity upon submission, removing this warning. For local test-signing, see [test signing setup](docs/msix-update-validation.md#test-signing-setup). +### Platform Support -**v1.2.0 update change:** In-app self-updating has been removed. OpenReader now uses **Windows-native updates** — the app never downloads or runs installers. +| Platform | Status | +|---|---| +| Windows 10/11 | Supported | +| Microsoft Store | In certification — recommended after approval | +| GitHub MSIX | Advanced users | +| macOS Apple Silicon | Experimental | +| macOS Intel | Experimental | +| Linux | Unsupported | + +### Update Policy -- **Existing v1.0.x and v1.1.x users** must manually install a v1.2.0+ MSIX once. Future updates are handled by the Microsoft Store or Windows App Installer. -- **v1.2.0+ users:** Windows App Installer manages updates on launch and in the background. The app's Help → Check for Updates opens the GitHub Releases page in your browser. -- Source builds should be updated with `git pull` and rebuilt locally. +OpenReader does not install updates itself. -> **ℹ️ Microsoft Store-managed updates** will provide automatic updates after Store approval. Until then, users update by downloading the latest MSIX from GitHub Releases and installing manually (Developer Mode required for unsigned packages). +- **Microsoft Store** installations update automatically through the Store. +- **GitHub MSIX** installations can check for new versions (Help → Check for Updates) but updates must be downloaded and installed manually. +- **Source builds** should be updated with `git pull` and rebuilt locally. ## Features @@ -87,31 +101,25 @@ Windows may show a SmartScreen warning because community builds are not code-sig | Annotation management | Show/hide annotations toggle (View menu). Delete all annotations on current page or entire document (Tools menu) | | Save PDF | Explicit File → Save (Ctrl+S) to persist annotation edits immediately | | PDF tools | Merge PDFs, split every page, extract page ranges like `1-3,5`, save compressed copies | -| Desktop integration | Windows installer with `.pdf` file association, Start Menu, and desktop shortcut | | Dark mode | System-aware dark theme (Catppuccin Mocha) with Auto/Light/Dark toggle via View → Theme | | Recent files | Quick access to the last 10 opened PDFs via File → Open Recent | -| Update detection | Help → Check for Updates queries GitHub API and opens the releases page in a browser. | -| Release engineering | Tag-driven GitHub Release publishing, PyInstaller packaging, Windows/macOS GitHub Actions builds, Inno Setup installer (legacy), MSIX packaging | +| Update detection | Help → Check for Updates queries GitHub API and opens the releases page. | ## Screenshots | Reader | Sample PDF | -|--------|------------| +|---|---| | ![Reader](assets/screenshots/reader-main.png) | ![Sample PDF](assets/screenshots/sample-pdf.png) | | Sample PDF 2 | PDF Tools | -|--------------|-----------| +|---|---| | ![Sample PDF 2](assets/screenshots/sample-pdf-2.png) | ![PDF Tools](assets/screenshots/merge-split.png) | | Dark Mode | About | -|-----------|-------| +|---|---| | ![Dark Mode](assets/screenshots/dark-mode.png) | ![About](assets/screenshots/about.png) | -## Why I Built This - -I built OpenReader as a local-first alternative for reading and handling PDFs without uploading private documents to cloud services. The project helped me practice desktop GUI development, PDF processing, OCR fallback handling, packaging, release automation, and security hardening while creating a tool people can actually use. - -## Security and Privacy +## Privacy and Security OpenReader processes PDFs locally. It does not use network services and does not upload PDFs. @@ -128,20 +136,18 @@ The app includes lightweight safety checks before opening and rendering document These checks reduce risk from malformed or oversized PDFs, but PDF parsing still depends on PyMuPDF/MuPDF. Avoid opening PDFs from untrusted sources unless you use OS-level sandboxing, a VM, or another isolation layer. -## License and Use - -OpenReader is free to use, share, study, and modify for non-commercial purposes under the [PolyForm Noncommercial License 1.0.0](LICENSE). +## License -Commercial use, resale, paid redistribution, or bundling in a commercial product is not permitted without separate written permission from the copyright holder. +OpenReader is free software under the [GNU AGPLv3](LICENSE). -Earlier published versions may have been released under MIT. The current license applies from the license change forward. +Copyright © 2026 Sparsh Sam. ## Requirements | Use case | Requirements | |---|---| -| Run Windows release | Windows 10 or newer. Python is not required. | -| Develop/build locally | Python 3.11 or newer. Windows recommended; macOS source builds may work but are not tested. | +| Run Windows package | Windows 10 or newer. Python is not required. | +| Develop or build from source | Python 3.11 or newer. Windows recommended. macOS source builds may work but are not tested. | ## Build From Source @@ -175,7 +181,7 @@ dist\OpenReader\ The Windows `.exe` cannot run on macOS. PyInstaller bundles native binaries for the operating system it runs on. -**macOS packaged builds are not stable.** The app is developed and tested primarily on Windows. To run on macOS, build from source — this gives you the latest code without the packaging layer: +**macOS packaged builds are experimental.** The app is developed and tested primarily on Windows. To run on macOS, build from source: ```bash git clone https://github.com/sparshsam/pdfreader-by-sparsh.git @@ -188,54 +194,6 @@ python main.py See [docs/macos.md](docs/macos.md) for macOS setup, Finder "Open With" notes, icon generation, and OCR notes. -## Releases and Update Strategy (v1.2.0+) - -Release assets are the canonical distribution path. GitHub Actions artifacts are CI outputs and are not release assets. - -**Starting with v1.2.0, update detection replaces in-app self-updating.** The app no longer downloads or runs installers. Updates are handled by **Windows App Installer** (via MSIX packaging) or performed manually by the user. - -**macOS release assets** (Apple Silicon and Intel ZIPs) are published alongside Windows but **are not stable** — Windows is the tested platform. Mac users should build from source (see [Build From Source](#build-from-source)). - -### Update Detection - -The app checks for updates via GitHub API: - -```text -https://api.github.com/repos/sparshsam/pdfreader-by-sparsh/releases/latest -``` - -- **Background check (optional):** On launch, the app silently checks for a newer version. If found, a brief status bar message appears. -- **Manual check:** Help → Check for Updates queries the API and shows a dialog with version info and release notes. -- **No download/install:** The dialog offers "Open Releases Page" — the user gets the MSIX from GitHub and installs it manually. -- **Microsoft Store future:** After Store submission, Store-managed automatic updates replace the manual download flow for Store users. - -### MSIX Distribution - -The recommended Windows distribution format is MSIX, which provides: -- **Windows-managed updates** — App Installer checks on launch and in the background -- **Clean install/uninstall** — no leftover registry keys or files -- **No admin required** — per-user installs don't need elevation (once signed) - -**GitHub Release MSIX packages are unsigned** and require Windows Developer Mode for sideloading. After Microsoft Store submission, the Store-signed MSIX will install without Developer Mode and without SmartScreen warnings. - -> **⚠️ GitHub MSIX vs Store-signed MSIX:** The unsigned .msix from GitHub Releases is for beta testing only. The Store-signed .msix (delivered through the Microsoft Store) is the production distribution channel. They share the same identity (`SparshSam.OpenReader`) and upgrade chain, so a Store install can upgrade a sideloaded beta and vice versa. - -### Legacy Installer - -The Inno Setup installer (`installer/setup.iss`) remains available for manual use. It no longer supports in-app update triggering — it exists purely as a standalone installer for users who prefer it. - -See [docs/windows-distribution.md](docs/windows-distribution.md) for the full Windows distribution strategy, [docs/updater-architecture.md](docs/updater-architecture.md) for the updater architecture, and [RELEASE.md](RELEASE.md) for release instructions. - -## Use as Default PDF App - -Windows does not allow apps to silently take over file defaults. To make this your default PDF app: - -1. Right-click a PDF file. -2. Choose **Open with > Choose another app**. -3. Pick `OpenReader.exe`. -4. Select **Always use this app to open .pdf files**. -5. Click **OK**. - ## OCR Setup Text selection works natively on PDFs with embedded text. For scanned/image-only PDFs, the app falls back to OCR via PyMuPDF's Tesseract integration. @@ -269,127 +227,18 @@ sudo pacman -S tesseract tesseract-data-eng ## Roadmap -### ✓ v0.3.x — Completed (latest: v0.3.6) - -**v0.3.0** shipped the major feature set: -- **Workspace and session restoration** — remembers which PDFs were open and what page you were on. Auto-restore on launch (toggle in File menu). -- **Full-library indexed search** — SQLite FTS5-based full-text index over entire folders of PDFs. Manage folders via Library dialog, search across all documents instantly. -- **PDF version comparison** — side-by-side diff view with color-coded changes (red deletions, green insertions). Compares page by page with diff summary. -- **Offline semantic search** — TF-IDF cosine similarity search (no ML dependencies). Toggle "Semantic" checkbox in the search bar for meaning-based matching across your indexed library. -- **Compare button** in toolbar and **Tools → Compare PDFs** menu entry. -- **Library button** in toolbar and **View → Library Search** menu entry with Ctrl+Shift+F shortcut. -- **Semantic search toggle** (checkbox) integrated into the main search bar. - -**v0.3.1–v0.3.6** focused on release engineering, installer, and updater reliability: -- Tag-driven GitHub Release publishing workflow with canonical updater asset names -- Windows auto-update fix (lost metadata, save-as-`update_None` resolved) -- Enhanced update error handling with HTTP status-specific messages and debug logging -- Inno Setup installer with dynamic version injection, icon, and proper file association -- CI hardening with compile checks, regression tests, security audit, and asset validation - -### ✓ v0.2.0 — Completed - -- **Highlight and annotation tools** — select, highlight, underline, and add sticky notes directly on PDFs; saved as native PDF annotations, not overlays -- **Multi-tab PDF support** — open several documents in a single window with tabbed navigation. Ctrl+T new tab, Ctrl+W close tab -- **Dark mode** — system-aware Catppuccin Mocha theme with Auto/Light/Dark toggle (View → Theme) -- **Recent files list** — last 10 documents in File → Open Recent -- **Windows installer** — Inno Setup installer with `.pdf` file association and Start Menu entry -- **OCR setup docs** — per-platform Tesseract installation guide above -- **macOS auto-update** — PID-based process wait, retry logic, Gatekeeper quarantine clearance - -### ✓ v1.1.0 — AI Agent Integration (Shipped) - -- [x] MCP server for AI agent PDF integration (14 tools) -- [x] README features table synced with code -- [x] README tech stack expanded - -### ✓ v1.1.1 — Stability and UX Hardening - -- [x] Open file — single picker, no cascading fallbacks, re-entrant guard -- [x] New Tab — creates blank tab without file dialog -- [x] Session restore — "Don't ask again" checkbox with persistent preference -- [x] Compress — size guard rejects output larger than original -- [x] Updater — post-launch version verification with status bar confirmation -- [x] Windows publisher docs — "Unknown Publisher" explained -- [x] 9 new regression tests (28 total, all passing) - -### ✓ v1.1.10 — Installer-Based Windows Updater - -- [x] Windows in-app updates use `OpenReader-Setup.exe` -- [x] Inno Setup handles UAC elevation and Program Files replacement -- [x] Portable ZIP remains available for manual recovery -- [x] Release workflow requires the Windows installer asset - -### ✓ v1.1.11 — Updater Validation Release - -- [x] Minimal version-only release to test v1.1.10 → v1.1.11 updater flow -- [x] Confirms Windows updater downloads and launches `OpenReader-Setup.exe` - -### ✓ v1.2.0 — MSIX Distribution Reset (Completed) - -**Goal:** Replace in-app self-updating with MSIX/App Installer for Windows. - -- [x] Remove self-update download/apply pipeline from `main.py` -- [x] Keep safe update detection (Help → Check for Updates → opens releases page) -- [x] Add MSIX packaging (`packaging/msix/`) -- [x] Add App Installer template for Windows-managed updates -- [x] Update GitHub Actions workflow to build MSIX -- [x] Add architecture docs (`docs/windows-distribution.md`, `docs/updater-architecture.md`) -- [x] Validate MSIX install and in-place upgrade (confirmed on Windows 11) -- [x] Store submission — v1.2.1 is the first Microsoft Store release candidate - ### Near-Term -Items in active or planned development. - +- **Microsoft Store submission** — currently in certification - **Local AI summarization** — generate document summaries and extract key points using a local LLM (e.g. Ollama, llama.cpp); no data ever leaves your machine - **Stronger sandboxing guidance** — documented approaches for running the app in an OS sandbox when opening documents from untrusted sources +- **Winget support** — `winget install SparshSam.OpenReader` ### Long-Term Vision -The direction the project grows into over time — grounded in real engineering, not speculation. - -- **Cross-platform desktop support** — native builds for Linux in addition to Windows and macOS, broadening the audience to all major desktop platforms -- **Secure research workspace** — a sandboxed reading environment with isolated rendering, no write access to the rest of the filesystem, and optional network blocking for working with sensitive or untrusted documents -- **PDF timeline and version history** — track changes across document revisions, with a browsable timeline of edits and diffs -- **Plugin system** — a lightweight extension API for community-contributed tools (custom export formats, batch processing pipelines, metadata editors) -- **Collaborative annotations (optional, wallet-based)** — share annotations and highlights between trusted peers using cryptographic identity, not a cloud account - -## Cryptographic Verification (Base) - -Optional infrastructure for anchoring document fingerprints to the [Base](https://base.org) blockchain. This feature is entirely opt-in — the app functions fully without it. - -### Philosophy - -PDFs remain local. No document content is ever uploaded or transmitted. Only a cryptographic hash — a fixed-length fingerprint derived from the file — is written to the blockchain. This creates a permanent, publicly verifiable proof that a specific document existed at a specific time, without revealing anything about its contents. - -### Planned capabilities - -- **Proof-of-existence anchoring** — generate a SHA-256 hash of any PDF and record it on Base in a single low-cost transaction -- **Verification receipts** — the app produces a small local receipt file containing the block number, transaction hash, and document fingerprint, so you can prove a document's existence without re-querying the chain -- **QR verification slips** — print or save a QR code that encodes the verification receipt, allowing anyone with the original PDF to independently confirm it matches the anchored fingerprint -- **Portable proof metadata** — embed verification metadata directly in the PDF as a hidden annotation layer, so proof travels with the document -- **Optional wallet-based identity** — use an Ethereum wallet for signing annotations, allowing trusted collaborators to verify who made a highlight or note without a central account system - -### What stays local - -- All PDF content -- All rendering, search, and processing -- All AI summarization and semantic search (when enabled) -- All annotation data until a user explicitly anchors a hash or signs with their wallet - -Base is used only as a low-cost, permanent verification layer. It is not a data store, not a monetization mechanism, and not a requirement for any core functionality. - -## Future Philosophy - -OpenReader sits at the intersection of a few ideas that I think are worth building towards: - -- **Local-first tools** that work offline, respect your filesystem, and don't require an account -- **Privacy-preserving software** that treats user data as something to protect, not extract -- **Cryptographic proof systems** that let you assert facts about documents without revealing their contents -- **User ownership** — you install it, you run it, you decide what happens to your data -- **Interoperable calm utilities** — small, focused tools that compose well with each other rather than monolithic platforms -- **Optional decentralized infrastructure** — blockchain used as a lightweight verification oracle, not a platform for speculation or lock-in - -This project is one piece of that broader picture. The immediate goal is a genuinely good PDF reader. Everything else — the proof layer, the AI features, the cross-platform story — builds on that foundation, never replaces it. +- **Cross-platform desktop support** — native builds for Linux in addition to Windows and macOS +- **Secure research workspace** — a sandboxed reading environment with isolated rendering and optional network blocking +- **PDF timeline and version history** — track changes across document revisions +- **Plugin system** — a lightweight extension API for community-contributed tools +- **Collaborative annotations (optional, wallet-based)** — share annotations between trusted peers using cryptographic identity ## Project Structure @@ -398,7 +247,8 @@ This project is one piece of that broader picture. The immediate goal is a genui ├── .github/ # CI, security checks, Dependabot ├── assets/ # App icon and README screenshots ├── docs/ # Platform notes and known limitations -├── installer/ # Inno Setup installer script +├── installer/ # Inno Setup installer script (legacy) +├── packaging/ # MSIX packaging ├── scripts/ # Build scripts ├── tests/ # Regression test suite ├── tools/ # Developer utilities and CI test helpers @@ -406,17 +256,12 @@ This project is one piece of that broader picture. The immediate goal is a genui ├── pdfreader_lib/ # Core library (search, comparison, MCP server) ├── requirements.txt # Pinned runtime/build dependencies ├── requirements-mcp.txt # MCP server dependencies (optional) -├── OpenReader.spec # PyInstaller spec -├── .bandit # Bandit security scanner configuration -├── CHANGELOG.md -├── CONTRIBUTING.md -├── LICENSE -└── SECURITY.md +└── CHANGELOG.md ``` ## Contributing -Contributions are welcome for non-commercial use cases. Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md) before opening issues or pull requests. +Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md) before opening issues or pull requests. ## AI Agent Integration (MCP Server) @@ -425,7 +270,7 @@ OpenReader ships with a built-in [MCP (Model Context Protocol)](https://modelcon ### Available Tools (14) | Tool | Purpose | -|------|---------| +|---|---| | `extract_text` | Extract all text from a PDF, per-page | | `get_page_text` | Extract text from a single page | | `get_metadata` | Get PDF metadata (title, author, pages, size) | @@ -494,21 +339,20 @@ python -m pdfreader_lib.mcp_server --transport sse --port 8312 All operations are local. No data is uploaded anywhere. ---- - -*Last updated: June 2026* - ## Tech Stack | Layer | Choice | -|-------|--------| +|---|---| | Language | Python 3.11+ | | UI Framework | PySide6 (Qt 6) | | PDF Rendering | PyMuPDF (MuPDF) | | Search | SQLite FTS5 (keyword), TF-IDF / scikit-learn (semantic) | | OCR | PyMuPDF / Tesseract integration | -| Packaging | PyInstaller (onedir) | -| Installer (Windows) | Inno Setup | +| Packaging | PyInstaller (onedir), MSIX | | CI/CD | GitHub Actions (Windows + macOS) | | Security scanning | Bandit, pip-audit | -| Platform | Windows (primary — stable), macOS (source-build only — not stable) | +| Platform | Windows (primary), macOS (experimental) | + +--- + +*Last updated: June 2026* diff --git a/RELEASE.md b/RELEASE.md index 21a5b6f..886a1d8 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,17 +6,16 @@ OpenReader uses semantic version tags to publish packaged builds. - `__version__` in `main.py` is the canonical source. Set it to the next release version. - Tags must use the format `vMAJOR.MINOR.PATCH`, for example `v1.2.2`. -- The injected runtime version removes the leading `v`, so `v1.2.2` becomes `__version__ = "1.2.1"` in packaged builds. +- The injected runtime version removes the leading `v`, so `v1.2.2` becomes `__version__ = "1.2.2"` in packaged builds. - CI injects the tag version for release builds via `scripts/inject_version.py`. -## Release Architecture (v1.2.0+) +## Release Architecture -**Starting with v1.2.0, update detection replaces in-app self-updating.** The app no longer -downloads or runs installers. Windows distribution is migrating to MSIX/App Installer: +OpenReader uses **update detection only** — the app never downloads or runs installers. -- **Update detection** — the app queries the GitHub API and opens the releases page -- **Update application** — handled by Windows App Installer (MSIX) or manual download -- **Legacy Setup.exe** — retained as a manual installer only; no update detection support +- **Update detection** — the app queries the GitHub API and opens the releases page in a browser +- **Update application** — handled by the Microsoft Store (automatic) or manual download +- **Legacy Setup.exe** — retained as a manual recovery installer only See [docs/updater-architecture.md](docs/updater-architecture.md) for details. @@ -25,16 +24,16 @@ See [docs/updater-architecture.md](docs/updater-architecture.md) for details. The release workflow attaches these assets: ```text -OpenReader.msix (MSIX package — recommended for v1.2.0+) -OpenReader-Setup.exe (legacy Inno Setup installer — manual use only) +OpenReader.msix (MSIX package — recommended for advanced users) +OpenReader-Setup.exe (legacy Inno Setup installer — manual recovery) OpenReader-Windows.zip (portable/manual recovery package) -OpenReader-macOS-Apple-Silicon.zip (macOS Apple Silicon — source-build testing) -OpenReader-macOS-Intel.zip (macOS Intel — source-build testing) +OpenReader-macOS-Apple-Silicon.zip (macOS Apple Silicon — experimental) +OpenReader-macOS-Intel.zip (macOS Intel — experimental) ``` -The MSIX package is built unsigned (requires `MakeAppx.exe` from Windows SDK). +The MSIX package is unsigned when built on CI (requires `MakeAppx.exe` from Windows SDK). GitHub Release MSIX packages require Windows Developer Mode for sideloading. -The Microsoft Store will sign the production MSIX with its Store identity — +The Microsoft Store signs the production MSIX with its Store identity — no separate code-signing certificate is needed. ## How to Cut a Release @@ -95,11 +94,10 @@ curl https://api.github.com/repos/sparshsam/pdfreader-by-sparsh/releases/latest ## MSIX Signing -The MSIX package is currently unsigned. The distribution plan is: +The MSIX package is unsigned for GitHub Release builds. -1. **Microsoft Store** — Submit the unsigned MSIX to the Microsoft Store. The Store - signs the package automatically with its Store identity. **v1.2.2 is the first - Store release candidate.** +1. **Microsoft Store** — Submission is in certification. The Store signs the + package automatically with its Store identity. 2. **Sideloading** — Unsigned MSIX from GitHub Releases requires Windows Developer Mode. Local test-signing scripts are in `packaging/msix/`. 3. **No self-procured code-signing cert** — The Store handles production signing. diff --git a/docs/archive/README.md b/docs/archive/README.md new file mode 100644 index 0000000..a167151 --- /dev/null +++ b/docs/archive/README.md @@ -0,0 +1,18 @@ +# Documentation Archive + +This directory contains historical documentation that is no longer relevant to the current release. + +These documents are retained for project history and reference only. They describe past release processes, transitional states, and validation tests that have been superseded. + +| File | Original Location | Purpose | +|---|---|---| +| `v1.0.6-announcement.md` | `docs/announcements/` | Historical release announcement for v1.0.6 | +| `v1.1.0-plan.md` | `docs/` | Feature plan for v1.1.0 — all items shipped or deferred | +| `v0.3.2-to-v0.3.3-updater-test.md` | `docs/` | Validation test for an early updater release | +| `project-status.md` | `docs/` | Status document referencing v1.1.11 as latest | +| `release-readiness-v1.2.0.md` | `docs/` | Beta validation scenarios (partially completed) | +| `screenshot-audit.md` | `docs/` | README screenshot review from v1.0.x era | + +**Current documentation is in `docs/` at the repository root.** + +*Last updated: June 2026* diff --git a/docs/project-status.md b/docs/archive/project-status.md similarity index 100% rename from docs/project-status.md rename to docs/archive/project-status.md diff --git a/docs/release-readiness-v1.2.0.md b/docs/archive/release-readiness-v1.2.0.md similarity index 100% rename from docs/release-readiness-v1.2.0.md rename to docs/archive/release-readiness-v1.2.0.md diff --git a/docs/screenshot-audit.md b/docs/archive/screenshot-audit.md similarity index 100% rename from docs/screenshot-audit.md rename to docs/archive/screenshot-audit.md diff --git a/docs/v0.3.2-to-v0.3.3-updater-test.md b/docs/archive/v0.3.2-to-v0.3.3-updater-test.md similarity index 100% rename from docs/v0.3.2-to-v0.3.3-updater-test.md rename to docs/archive/v0.3.2-to-v0.3.3-updater-test.md diff --git a/docs/announcements/v1.0.6.md b/docs/archive/v1.0.6-announcement.md similarity index 100% rename from docs/announcements/v1.0.6.md rename to docs/archive/v1.0.6-announcement.md diff --git a/docs/v1.1.0-plan.md b/docs/archive/v1.1.0-plan.md similarity index 100% rename from docs/v1.1.0-plan.md rename to docs/archive/v1.1.0-plan.md diff --git a/docs/known-limitations.md b/docs/known-limitations.md index 9ef72f3..b43fd65 100644 --- a/docs/known-limitations.md +++ b/docs/known-limitations.md @@ -16,13 +16,13 @@ These are accepted limitations of the current release. They are documented here ## Memory -- **Log file grows unboundedly.** The updater debug log at `%TEMP%\PDFReader-Updates\updater-debug.log` and the app debug log at `%TEMP%\PDFReader-Logs\app-debug.log` grow indefinitely. Manual cleanup is required. +- **Log file grows unboundedly.** The app debug log at `%TEMP%\PDFReader-Logs\app-debug.log` grows indefinitely. Manual cleanup is required. - **No backup rotation.** The safety backup system (`_save_with_backup`) only keeps one `.bak` file per document. Multiple saves overwrite the same backup. This is intentional — the backup is meant for crash recovery, not version history. ## macOS - **Unsigned builds.** Both GitHub Actions builds and local builds are unsigned. macOS Gatekeeper will warn before running. The app needs Apple Developer ID code signing and notarization for smooth public distribution. -- **No macOS update apply verification.** The in-app updater can download macOS updates but the apply flow (`_apply_update_macos`) has not been validated in a full end-to-end release cycle since v0.3.x. +- **macOS is experimental.** The app is developed and tested on Windows. macOS builds are published for community testing but are not stable. ## Windows @@ -39,7 +39,3 @@ These are accepted limitations of the current release. They are documented here - **Library modules are optional.** The `pdfreader_lib` package (library full-text search, PDF comparison, semantic search) is only loaded if installed. Without it, the Compare and Library buttons are grayed out. This is by design — the core PDF reader works without these modules. - **Semantic search requires an indexed library.** The TF-IDF index must be built by adding folders via the Library dialog before semantic search returns results. -## Updater - -- **Source builds don't auto-update.** The in-app updater works only in PyInstaller-packaged builds (`sys.frozen == True`). Source builds must be updated with `git pull` and rebuilt locally. -- **Update check may fail behind proxies.** The updater uses `QNetworkAccessManager` and respects system proxy settings, but network timeouts are limited to 15 seconds for the check and 5 minutes for the download. diff --git a/docs/msix-update-validation.md b/docs/msix-update-validation.md index d6bdfdc..80002ac 100644 --- a/docs/msix-update-validation.md +++ b/docs/msix-update-validation.md @@ -1,8 +1,8 @@ # MSIX Update Validation Guide (Archived) > **ℹ️ Historical record.** MSIX beta validation (beta.5 → beta.6) completed -> successfully. v1.2.1 is the first Microsoft Store release candidate — Store-managed -> updates replace sideloaded MSIX update testing. +> successfully. v1.2.2 is the current stable release. Store-managed +> updates will replace sideloaded MSIX update testing after Store certification. **Purpose:** Validate that MSIX updates work correctly for OpenReader (historical). diff --git a/docs/store-submission-checklist.md b/docs/store-submission-checklist.md index c9db48e..9fee256 100644 --- a/docs/store-submission-checklist.md +++ b/docs/store-submission-checklist.md @@ -3,7 +3,7 @@ **Target version:** v1.2.2 stable (MSIX version `1.2.2.0`) **Store ID:** `9MXDVW2645LL` **PFN:** `SparshSam.OpenReader_yh0byntbzd2qw` -**Status:** 🔜 Ready for submission (privacy policy published) +**Status:** 🔜 In certification **Privacy policy URL:** https://sparshsam.github.io/pdfreader-by-sparsh/privacy/ **Upload artifact:** `OpenReader.msix` from v1.2.2 GitHub Release (built by release.yml workflow) @@ -247,7 +247,7 @@ Write-Host "Publisher check: $($matches.Count -gt 0 ? 'PASS' : 'FAIL')" ## 6. Post-Submission Tasks - [x] Publish privacy policy URL (published at `https://sparshsam.github.io/pdfreader-by-sparsh/privacy/`) -- [ ] Prepare Winget manifest for `SparshSam.OpenReader` (optional, medium priority) +- [ ] Prepare Winget manifest for `SparshSam.OpenReader` — see [winget-preparation.md](winget-preparation.md) - [ ] Monitor Partner Center certification report - [ ] After acceptance: test Store install on clean Windows VM - [ ] After acceptance: test Store upgrade over existing sideloaded installation diff --git a/docs/updater-architecture.md b/docs/updater-architecture.md index b151ee6..5dc0eb7 100644 --- a/docs/updater-architecture.md +++ b/docs/updater-architecture.md @@ -84,7 +84,7 @@ breaking upgrades. | Channel | Status | Update Mechanism | |---------|--------|-----------------| -| Microsoft Store | 🔒 Reserved | Windows Update (automatic) | +| Microsoft Store | 🔜 In certification | Windows Update (automatic) | | GitHub Releases (MSIX) | ✅ Active | Manual download (unsigned — Developer Mode) | | Winget | 🔜 Future | `winget install SparshSam.OpenReader` | | GitHub Releases (Setup.exe) | ⚠️ Legacy | Manual download only — no in-app updates | @@ -151,7 +151,6 @@ Once Store submission is active or App Installer is deployed: ## Future Work -- [ ] Submit MSIX to Microsoft Store +- [x] Submit MSIX to Microsoft Store (in certification) - [ ] Deploy App Installer hosting infrastructure - [ ] Submit Winget manifest -- [ ] End-to-end validation on Windows 10/11 diff --git a/docs/windows-distribution.md b/docs/windows-distribution.md index 43ffd38..dfa0c22 100644 --- a/docs/windows-distribution.md +++ b/docs/windows-distribution.md @@ -9,6 +9,8 @@ OpenReader has migrated from Inno Setup self-updating to **MSIX** — Microsoft' modern packaging format — with multiple distribution channels. The app no longer downloads or runs installers from within itself; Windows handles updates. +The Microsoft Store submission is currently in certification. + ## ⚠️ Frozen Identity (MSIX / Microsoft Store) The following values are **permanently frozen** and must never change after @@ -58,7 +60,7 @@ CI auto-extracts from Git tag and pads to 4 parts: `${tag}.0` **Store ID:** `9MXDVW2645LL` -OpenReader is reserved in the Microsoft Store. Users can search for "OpenReader" +OpenReader is currently in Microsoft Store certification. Once approved, users can search for "OpenReader" or install directly via: ``` diff --git a/docs/winget-preparation.md b/docs/winget-preparation.md new file mode 100644 index 0000000..9072032 --- /dev/null +++ b/docs/winget-preparation.md @@ -0,0 +1,91 @@ +# Winget Support Preparation + +**Status:** 🔜 Not yet published + +## Package Identity + +| Field | Value | +|---|---| +| Package identifier | `SparshSam.OpenReader` | +| Package family name | `SparshSam.OpenReader_yh0byntbzd2qw` | +| Publisher | `Sparsh Sam` | +| License | AGPL-3.0 | +| Installer type | MSIX | + +## Requirements + +Before submitting to [winget-pkgs](https://github.com/microsoft/winget-pkgs): + +- [x] GitHub Releases must have predictable asset naming (done — `OpenReader.msix`) +- [x] Release workflow produces consistent artifacts (done) +- [ ] **Microsoft Store certification is approved** (blocking — wait for Store approval) +- [ ] Stable release validation passes a Store-signed installation cycle +- [ ] Winget manifest is prepared (see below) +- [ ] Automated PR via winget release workflow is considered + +## Manifest Structure + +```text +manifests/ + s/ + SparshSam/ + OpenReader/ + 1.2.2.0.yaml +``` + +### Manifest Template (prepare, do not submit) + +```yaml +PackageIdentifier: SparshSam.OpenReader +PackageVersion: 1.2.2.0 +PackageLocale: en-US +Publisher: Sparsh Sam +PublisherUrl: https://github.com/sparshsam +PublisherSupportUrl: https://github.com/sparshsam/pdfreader-by-sparsh/issues +Author: Sparsh Sam +PackageName: OpenReader +PackageUrl: https://github.com/sparshsam/pdfreader-by-sparsh +License: AGPL-3.0 +LicenseUrl: https://github.com/sparshsam/pdfreader-by-sparsh/blob/main/LICENSE +ShortDescription: Privacy-first, local-only PDF utility. +Moniker: openreader +Tags: + - pdf + - reader + - privacy + - local-first +InstallerType: msix +Installers: + - Architecture: x64 + InstallerUrl: https://github.com/sparshsam/pdfreader-by-sparsh/releases/download/v1.2.2/OpenReader.msix + InstallerSha256: [REPLACE WITH ACTUAL SHA256] +PackageFamilyName: SparshSam.OpenReader_yh0byntbzd2qw +ManifestType: singleton +ManifestVersion: 1.0.0 +``` + +## Release Checklist Addition + +Add this step to `RELEASE.md` after the existing validation checklist: + +> - [ ] After Store approval and stable release validation, prepare Winget manifest update: +> 1. Fork [winget-pkgs](https://github.com/microsoft/winget-pkgs) +> 2. Create `manifests/s/SparshSam/OpenReader//` +> 3. Copy manifest template with updated version + SHA256 +> 4. Submit PR + +## Versioning + +Winget uses the MSIX 4-part version string (e.g. `1.2.2.0`), which matches the version +in `AppxManifest.xml`. Each new release requires a new manifest directory. + +## Update Flow + +After initial submission, the winget bot automatically detects new releases and +opens PRs to update the manifest. No manual submission is needed for subsequent releases. + +## Notes + +- Do not submit Winget until Store certification is approved. +- Do not submit Winget before validating a Store-signed installation cycle. +- The SHA256 hash in the manifest must match the MSIX attached to the GitHub Release. diff --git a/tools/test_updater_asset_flow.py b/tools/test_updater_asset_flow.py index 6330598..9135737 100644 --- a/tools/test_updater_asset_flow.py +++ b/tools/test_updater_asset_flow.py @@ -1,12 +1,11 @@ -"""Regression checks for update detection (v1.2.0+ MSIX distribution). +"""Regression checks for update detection (current architecture). -The old self-update download/apply pipeline has been replaced by MSIX/App Installer -packaging. These checks validate that update detection still works correctly: +These checks validate that update detection still works correctly: - Version parsing - Update response classification - The Help -> Check for Updates dialog correctly opens the releases page -The app no longer downloads or installs updates from within itself. +The app does not download or install updates from within itself. """ import json