housestyle 0.1.0__tar.gz

housestyle-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

housestyle-0.1.0/NOTICE

@@ -0,0 +1,14 @@
+housestyle
+Copyright 2026 Jonas Kieselbach
+
+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.

housestyle-0.1.0/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: housestyle
+Version: 0.1.0
+Summary: Learn your own writing voice from your own texts, measured locally - raw text never leaves the machine.
+Author: Jonas Kieselbach
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/TheKieselbach/housestyle
+Project-URL: Source, https://github.com/TheKieselbach/housestyle
+Project-URL: Documentation, https://github.com/TheKieselbach/housestyle/blob/main/INSTALL.md
+Project-URL: Changelog, https://github.com/TheKieselbach/housestyle/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/TheKieselbach/housestyle/issues
+Keywords: writing,style,voice,privacy,local,corpus,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Natural Language :: English
+Classifier: Natural Language :: German
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# housestyle
+
+[![tests](https://github.com/TheKieselbach/housestyle/actions/workflows/ci.yml/badge.svg)](https://github.com/TheKieselbach/housestyle/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
+[![dependencies: none](https://img.shields.io/badge/dependencies-none-brightgreen)](INSTALL.md)
+
+**Learn your own writing voice from your own texts — without sending those
+texts to a model.**
+
+A language model can imitate your style if you show it enough of your
+writing. The usual way to do that is to paste your writing into the context.
+For a private person that is a nuisance. For a business it is a decision
+nobody made deliberately: every mail you ever sent, in someone else's
+infrastructure, because a draft needed to sound right.
+
+housestyle takes the other route. It measures your writing **locally** and
+produces numbers. Only the numbers, plus a handful of short redacted
+passages, go into building the profile. The corpus stays on your machine.
+
+**Who this is for:** anyone whose writing carries their own name — consultants,
+founders, freelancers, people who send a lot of mail that has to sound like
+them. Also anyone under a duty of confidentiality who would rather not paste
+their sent folder into a chat window.
+
+**Who it is not for:** teams looking for a shared house tone. That is a
+different problem — this measures one person, and mixing several writers
+produces an average nobody actually writes like.
+
+---
+
+## What you actually get
+
+Ask any model to decline a proposal, and you get this:
+
+> Dear Mr Fisher,
+>
+> Thank you for your message and for the detailed proposal. Having carefully
+> reviewed the approach you outlined, I would like to share some thoughts.
+> While I appreciate the thinking behind it, I am concerned that the
+> associated costs may be considerable. I would therefore suggest that we
+> explore alternative avenues together. Please do not hesitate to reach out
+> should you have any questions.
+
+Competent. Polite. Not you. Give the same model your profile, and it writes
+to the measurements instead:
+
+> Hi Tom,
+>
+> too expensive. We tried it twice, it didn't work.
+> I'll look at it tomorrow and come back to you.
+>
+> Cheers
+
+Every difference traces to a number, not to taste:
+
+| Measurement | What it changed |
+|---|---|
+| Sentence median **7 words**, 48 % under six | The long, hedged sentences collapse |
+| Intensifiers and hedges at **0 per 1000 words** | "carefully", "considerable", "I would like to" go |
+| Greeting measured as **"Hi"**, sign-off as **"Cheers"** | No "Dear …", no "Please do not hesitate" |
+| Exclamation marks **0.0 per sentence** | None appear |
+| Informal address throughout | No formal register |
+
+That is the point of measuring rather than asking a model to guess: **you can
+see why a sentence changed.**
+
+## What the measurement looks like
+
+Real output from `measure.py`, abridged:
+
+```json
+{
+ "volume":   { "texts": 180, "sentences": 633, "words": 3917 },
+ "sentence_length_words": {
+    "median": 7, "mean": 6.3, "p10": 2.0, "p90": 9.0,
+    "short_under_6": 48, "long_over_25": 0 },
+ "punctuation_per_sentence": {
+    "comma": 0.39, "dash": 0.07, "colon": 0.15, "exclamation_mark": 0.0 },
+ "markers_per_1000_words": {
+    "hedges": 0.0, "intensifiers": 0.0, "questions": 12.3 },
+ "particles": [ ["also", 48, 12.25], ["gern", 40, 10.21], ["ja", 31, 7.91] ]
+}
+```
+
+From that plus a few short redacted passages you write `style-profile.md` —
+roughly one page. **That page is what you paste into your AI tool.**
+
+Writing it is the one step a model does for you. With the Claude Code plugin
+the `profile` skill does it. Without it, paste the metrics file into whatever
+model you use and ask:
+
+> Here are measurements of my writing, taken from my own texts, plus a few
+> short sample passages. Write a one-page style profile I can give to a model
+> so it writes like me. Every statement must trace back to one of these
+> numbers — no "clear and concise", but "median 7 words, 48 percent of
+> sentences under six". End with a short checklist for reviewing a draft.
+
+Note what does **not** happen here: your corpus is not in that prompt. Only
+counts, medians and a handful of redacted lines. It says
+things like *"median 7 words; 48 percent of sentences under six; opens with
+Hi, closes with Cheers; intensifiers essentially absent — emphasis comes from
+negation, not from adverbs."*
+
+Every line of it is a claim you can check against a number. That is the
+difference from "write in a casual tone": a model can follow it, and you can
+tell when it did not.
+
+## How you use it day to day
+
+1. **Once a quarter** — refresh the corpus and remeasure. Ten minutes.
+2. **Once, then rarely** — paste `style-profile.md` into your tool's
+   instructions: ChatGPT custom instructions, a Claude Project, a Gem, your
+   `.cursorrules`. It stays there.
+3. **Per draft** — check it against your own vocabulary:
+   ```bash
+   housestyle outliers draft.txt
+   ```
+   It lists words whose stem you almost never use. In the reference corpus
+   one flagged word appeared **once** in 50,000 of the author's own words.
+   Not every hit is wrong — technical terms land there too. It is a list to
+   look at, not a list to delete.
+4. **When you rewrite a draft** — put the rewritten version back into the
+   corpus. Texts you approved are the best material there is, because they
+   are certainly in your voice.
+
+With the Claude Code plugin, steps 2 to 4 happen on their own.
+
+---
+
+## Start with what you already have
+
+If you use Claude Code, your corpus already exists. Your own messages in the
+transcripts are typed and dictated prose, and nobody has to export anything.
+
+```bash
+python3 scripts/setup.py                      # four questions, shows what it will create
+python3 scripts/collect_transcripts.py
+python3 scripts/measure.py "$ROOT/corpus/transcripts.jsonl" --tag transcripts
+```
+
+That is the whole first run. You now have a file of numbers describing how you
+write, and no text has left the machine.
+
+Add registers as you go — sent mail (mbox or Microsoft Graph), published
+articles. Registers are kept apart on purpose: most people write very
+differently in mail than in public. Getting your texts out of Gmail, Microsoft
+365, Apple Mail or any IMAP provider is covered in
+[`docs/getting-your-texts.md`](docs/getting-your-texts.md).
+
+**Requirements: Python 3.9 and nothing else.** No packages, no account, no
+network. See [`INSTALL.md`](INSTALL.md) — including exactly what gets created
+and how to remove it.
+
+## Works with whatever you already use
+
+The measurement is plain Python and produces a Markdown profile. Paste it into
+ChatGPT's custom instructions, a Claude Project or Style, a Gem, your
+`.cursorrules`, or a local model's system prompt. Or read it yourself — it is
+an honest description of how you write.
+
+The `skills/` directory adds a [Claude Code](https://claude.com/claude-code)
+plugin on top, which loads the profile automatically and checks drafts against
+it. **That layer is optional** and deleting it changes nothing else.
+
+## What it measures
+
+| | |
+|---|---|
+| Sentence length | median, mean, p10/p90, share under 6 and over 25 words |
+| Punctuation | commas, dashes, colons, brackets, question and exclamation marks per sentence |
+| Markers | hedges, intensifiers, connectives, contrast, subjunctive, modals, nominal style, passive, person, forms of address |
+| Closed word classes | particles, degree words, evaluative words — the actual style signal |
+| Openings and closings | how you start sentences, how you greet, how you sign off |
+| Topic vocabulary | reported separately and labelled **not style** |
+
+## Three things that cost a full run each
+
+These are in the code as comments too. They are the reason this repository
+exists rather than a description of one.
+
+**1 · Mail clients emit `\r\n`.** Every `$` anchor in a line-based regular
+expression fails on the leftover `\r`, silently. Normalise before anything
+else.
+
+**2 · The signature was 43 percent of the mail corpus.** An automatic
+signature block — address, service list, marketing line, booking link — hangs
+on every mail and dwarfs the actual message. Worse, its canned sign-off looks
+exactly like a typed one, so the profile concluded a farewell formula the
+author never types. Signature anchors are configuration in this project, and
+`collect_mail.py` warns when you leave them empty.
+
+**3 · Word frequency over open word classes measures your topic, not your
+style.** An early run produced a profile whose most characteristic words were
+"client", "backup" and "folder". True, and useless. What someone writes
+*about* changes with the project. Which particles they reach for does not.
+Closed classes — particles, degree words, evaluative words — are the signal;
+open classes are reported separately and clearly labelled.
+
+## Languages
+
+The method is language-independent. The word lists are not, so they live in
+`lang/<code>.json` rather than in the code.
+
+Shipped: **German** (`de`, the reference language — built and validated
+against a real 54,000-word corpus) and **English** (`en`). Adding a language
+means writing one JSON file; see `docs/adding-a-language.md`.
+
+## What this does not do
+
+- It does not write for you. It produces a profile; a model writes with it.
+- It does not verify authorship or detect AI text.
+- It will not make a model sound like you from a small corpus. Below roughly
+  10,000 of your own words the numbers are noise.
+- It is not a privacy guarantee for whatever you do next. It keeps *this*
+  step local. What you paste elsewhere is still your call.
+
+## Privacy
+
+The corpus contains the full text of things you wrote. It lives under the
+path you set in `housestyle.conf`, deliberately outside this repository, and
+`.gitignore` is a second net in case something is ever written here by
+mistake. Sample passages — the one place actual text is meant to be shown to
+a model — are redacted first: configured names, mail addresses, links, phone
+numbers and amounts.
+
+**Secrets are redacted when the corpus is written.** People type API keys and
+passwords into chat windows, and transcripts keep them. Keys, tokens, private
+key blocks and credentials in URLs are replaced with placeholders before
+anything is stored — and again before any sample is shown to a model.
+
+Nothing in this project sends anything anywhere. There is no telemetry, no
+network call except the one in `collect_web.py`, which fetches URLs you pass
+it yourself — and only over http and https, never `file://`.
+
+What was checked before release, and what it found, is in
+[`SECURITY.md`](SECURITY.md).
+
+## Why it was built this way
+
+The long version is in [`docs/why-measure-locally.md`](docs/why-measure-locally.md).
+The short version: a guardrail that only exists in a policy document is not a
+guardrail. This one is in the file layout — the corpus cannot reach a model
+by accident, because the thing that reaches the model is a JSON file full of
+numbers.
+
+## Tests
+
+```bash
+python3 -W error::ResourceWarning -m unittest discover tests -v
+```
+
+52 tests, no corpus and no setup needed. They are not coverage theatre — each
+one records a specific way an earlier version was wrong, or a security
+constraint that must keep holding.
+
+## Did it work for you?
+
+The tool has been built and measured on one machine, against one corpus, in
+two languages. That is not enough to know whether it works.
+
+If you set it up, a short note in
+[Discussions](../../discussions) helps more than a star — and four things
+would help most:
+
+1. **Which language, which corpus?** Transcripts, mail, published texts — and
+   roughly how many words before the numbers stopped looking like noise.
+2. **How did you get your texts out?** The export routes in
+   [`docs/getting-your-texts.md`](docs/getting-your-texts.md) are documented
+   from testing, not from using every provider. If yours was different, that
+   is worth a paragraph.
+3. **Which tool did you paste the profile into**, and did it follow it?
+4. **The one that matters: did a draft actually come out different?** Not
+   "did it feel better" — what changed, and does it trace to a number? That
+   is the question this project stands or falls on, and it is the one nobody
+   else asks.
+
+Reports that say it did **not** work are more useful than reports that say it
+did. A profile that reads well and changes nothing is the failure mode worth
+knowing about.
+
+Findings from those reports go into a field-reports section here, with
+attribution, once there are any.
+
+## Contributing
+
+The most useful contribution is **a language pack** — one JSON file, no code,
+and it needs a native speaker. See [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+## License
+
+Apache-2.0. See `LICENSE` and `NOTICE`.