wirenote 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- wirenote-0.1.0/.gitignore +15 -0
- wirenote-0.1.0/CHANGELOG.md +26 -0
- wirenote-0.1.0/CLA.md +150 -0
- wirenote-0.1.0/CODE_OF_CONDUCT.md +83 -0
- wirenote-0.1.0/CONTRIBUTING.md +43 -0
- wirenote-0.1.0/LICENSE +661 -0
- wirenote-0.1.0/PKG-INFO +106 -0
- wirenote-0.1.0/PRIVACY.md +40 -0
- wirenote-0.1.0/README.md +74 -0
- wirenote-0.1.0/SECURITY.md +26 -0
- wirenote-0.1.0/THIRD_PARTY.md +49 -0
- wirenote-0.1.0/docs/usage.md +118 -0
- wirenote-0.1.0/pyproject.toml +65 -0
- wirenote-0.1.0/scripts/dump_streams.py +11 -0
- wirenote-0.1.0/scripts/make_replay.py +155 -0
- wirenote-0.1.0/scripts/release_notes.py +65 -0
- wirenote-0.1.0/src/wirenote/__init__.py +3 -0
- wirenote-0.1.0/src/wirenote/calendar/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/calendar/ics.py +236 -0
- wirenote-0.1.0/src/wirenote/capture/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/capture/recorder.py +304 -0
- wirenote-0.1.0/src/wirenote/capture/wav.py +58 -0
- wirenote-0.1.0/src/wirenote/cli.py +262 -0
- wirenote-0.1.0/src/wirenote/config/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/config/apps.py +158 -0
- wirenote-0.1.0/src/wirenote/config/migrate.py +130 -0
- wirenote-0.1.0/src/wirenote/config/perms.py +61 -0
- wirenote-0.1.0/src/wirenote/config/secrets.py +98 -0
- wirenote-0.1.0/src/wirenote/config/settings.py +176 -0
- wirenote-0.1.0/src/wirenote/config/vocabulary.py +32 -0
- wirenote-0.1.0/src/wirenote/data/wirenote-ui.service +15 -0
- wirenote-0.1.0/src/wirenote/data/wirenote.desktop +10 -0
- wirenote-0.1.0/src/wirenote/data/wirenote.service +15 -0
- wirenote-0.1.0/src/wirenote/detector/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/detector/core.py +115 -0
- wirenote-0.1.0/src/wirenote/detector/daemon.py +743 -0
- wirenote-0.1.0/src/wirenote/detector/graph.py +102 -0
- wirenote-0.1.0/src/wirenote/detector/identity.py +205 -0
- wirenote-0.1.0/src/wirenote/detector/streams.py +69 -0
- wirenote-0.1.0/src/wirenote/detector/tracker.py +304 -0
- wirenote-0.1.0/src/wirenote/net/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/net/peer.py +101 -0
- wirenote-0.1.0/src/wirenote/notify/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/notify/clipboard.py +43 -0
- wirenote-0.1.0/src/wirenote/notify/dbus.py +89 -0
- wirenote-0.1.0/src/wirenote/process/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/process/jobs.py +122 -0
- wirenote-0.1.0/src/wirenote/process/merge.py +87 -0
- wirenote-0.1.0/src/wirenote/process/models.py +57 -0
- wirenote-0.1.0/src/wirenote/process/note.py +124 -0
- wirenote-0.1.0/src/wirenote/process/speakers.py +295 -0
- wirenote-0.1.0/src/wirenote/process/summarize.py +287 -0
- wirenote-0.1.0/src/wirenote/process/transcribe.py +97 -0
- wirenote-0.1.0/src/wirenote/process/worker.py +229 -0
- wirenote-0.1.0/src/wirenote/tools/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/tools/dump_streams.py +595 -0
- wirenote-0.1.0/src/wirenote/tools/install.py +140 -0
- wirenote-0.1.0/src/wirenote/tools/setup.py +338 -0
- wirenote-0.1.0/src/wirenote/ui/__init__.py +2 -0
- wirenote-0.1.0/src/wirenote/ui/data.py +783 -0
- wirenote-0.1.0/src/wirenote/ui/launch.py +88 -0
- wirenote-0.1.0/src/wirenote/ui/server.py +423 -0
- wirenote-0.1.0/src/wirenote/ui/static/app.css +907 -0
- wirenote-0.1.0/src/wirenote/ui/static/app.js +1267 -0
- wirenote-0.1.0/src/wirenote/ui/static/fonts/OFL.txt +93 -0
- wirenote-0.1.0/src/wirenote/ui/static/fonts/inter-latin-ext.woff2 +0 -0
- wirenote-0.1.0/src/wirenote/ui/static/fonts/inter-latin.woff2 +0 -0
- wirenote-0.1.0/src/wirenote/ui/static/icon.svg +1 -0
- wirenote-0.1.0/src/wirenote/ui/static/icons.svg +31 -0
- wirenote-0.1.0/src/wirenote/ui/static/index.html +57 -0
- wirenote-0.1.0/src/wirenote/ui/static/login.html +19 -0
- wirenote-0.1.0/tests/conftest.py +95 -0
- wirenote-0.1.0/tests/replay/jitsi-chrome-marked.json +2148 -0
- wirenote-0.1.0/tests/replay/jitsi-chrome-marked2.json +2365 -0
- wirenote-0.1.0/tests/replay/jitsi-chrome.json +5744 -0
- wirenote-0.1.0/tests/replay/jitsi-firefox.json +3961 -0
- wirenote-0.1.0/tests/test_calendar.py +194 -0
- wirenote-0.1.0/tests/test_capture.py +174 -0
- wirenote-0.1.0/tests/test_clipboard.py +80 -0
- wirenote-0.1.0/tests/test_daemon.py +270 -0
- wirenote-0.1.0/tests/test_docs.py +69 -0
- wirenote-0.1.0/tests/test_graph_and_config.py +125 -0
- wirenote-0.1.0/tests/test_identity.py +110 -0
- wirenote-0.1.0/tests/test_install.py +90 -0
- wirenote-0.1.0/tests/test_isolation.py +16 -0
- wirenote-0.1.0/tests/test_launch.py +88 -0
- wirenote-0.1.0/tests/test_license_headers.py +27 -0
- wirenote-0.1.0/tests/test_migrate.py +167 -0
- wirenote-0.1.0/tests/test_models.py +56 -0
- wirenote-0.1.0/tests/test_peer.py +96 -0
- wirenote-0.1.0/tests/test_perms.py +122 -0
- wirenote-0.1.0/tests/test_process.py +360 -0
- wirenote-0.1.0/tests/test_release_notes.py +70 -0
- wirenote-0.1.0/tests/test_replay.py +92 -0
- wirenote-0.1.0/tests/test_setup.py +155 -0
- wirenote-0.1.0/tests/test_speakers.py +52 -0
- wirenote-0.1.0/tests/test_tracker.py +230 -0
- wirenote-0.1.0/tests/test_ui.py +558 -0
- wirenote-0.1.0/uv.lock +1145 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
__pycache__/
|
|
2
|
+
*.tmp
|
|
3
|
+
|
|
4
|
+
# Raw captures: hostnames, user name, device names, room names. Commit only scrubbed
|
|
5
|
+
# traces made with scripts/make_replay.py (tests/replay/).
|
|
6
|
+
tests/fixtures/
|
|
7
|
+
.venv/
|
|
8
|
+
.pytest_cache/
|
|
9
|
+
|
|
10
|
+
# AI assistant working files stay local: plans, specs, agent instructions.
|
|
11
|
+
docs/superpowers/
|
|
12
|
+
.superpowers/
|
|
13
|
+
.claude/
|
|
14
|
+
CLAUDE.md
|
|
15
|
+
AGENTS.md
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes are listed here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow [Semantic Versioning](https://semver.org/).
|
|
4
|
+
|
|
5
|
+
## [0.1.0] - 2026-10-26
|
|
6
|
+
|
|
7
|
+
First public release. Runs on Linux (x86_64 and ARM64) with PipeWire and Python 3.11 to 3.14.
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- Call detection on PipeWire, with a Record / Ignore prompt; app rules in `apps.toml`.
|
|
12
|
+
- Two-track recording (your mic and the system audio), auto-stop, crash recovery.
|
|
13
|
+
- Transcription with faster-whisper, speakers told apart and named, local summaries through Ollama or, opt-in, Claude.
|
|
14
|
+
- Markdown notes and a local meetings app: search, playback, notes during the call, action items, Ask across meetings, follow-up email.
|
|
15
|
+
- Settings page: summaries, transcription, consent line, Claude key and calendars.
|
|
16
|
+
- `wirenote setup install` / `uninstall`, `wirenote doctor`, `wirenote open`.
|
|
17
|
+
- Works outside KDE: clipboard through `wl-copy`, `xclip` or `xsel`, and prompts without notification buttons.
|
|
18
|
+
|
|
19
|
+
### Security
|
|
20
|
+
|
|
21
|
+
- Recordings, notes and settings are private to your user (umask 077).
|
|
22
|
+
- The meetings app only serves your own user, through a one-time login.
|
|
23
|
+
- Calendar feeds are limited and must use https; untrusted text is escaped in notifications and notes.
|
|
24
|
+
- Logs leave out room names, note paths and speaker names; model downloads are pinned.
|
|
25
|
+
|
|
26
|
+
[0.1.0]: https://github.com/knowhrishi/wirenote/releases/tag/v0.1.0
|
wirenote-0.1.0/CLA.md
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Wirenote Individual Contributor License Agreement
|
|
2
|
+
|
|
3
|
+
Version 1.0, 26 October 2026
|
|
4
|
+
|
|
5
|
+
Thank you for contributing to Wirenote. This agreement sets out the rights you
|
|
6
|
+
give when you send a contribution. **You keep the copyright in your work.** You
|
|
7
|
+
sign once, and the agreement covers every contribution you send to Wirenote.
|
|
8
|
+
|
|
9
|
+
In short: you allow the Maintainer to use your contribution in Wirenote under
|
|
10
|
+
the GNU Affero General Public License and also under other terms, for example
|
|
11
|
+
a commercial edition for companies; in return, every accepted contribution
|
|
12
|
+
stays available as open source. The numbered sections below are the binding
|
|
13
|
+
text.
|
|
14
|
+
|
|
15
|
+
## 1. Definitions
|
|
16
|
+
|
|
17
|
+
- **"Maintainer"**: Hrishikesh Jadhav, who maintains Wirenote, and anyone to
|
|
18
|
+
whom this agreement is transferred under section 8.
|
|
19
|
+
- **"You"**: the natural person who signs this agreement.
|
|
20
|
+
- **"Wirenote"**: the software published at
|
|
21
|
+
<https://github.com/knowhrishi/wirenote>, including its documentation and
|
|
22
|
+
all its past and future versions, under whatever name it is published.
|
|
23
|
+
- **"Contribution"**: any work of authorship, such as code, documentation,
|
|
24
|
+
translations, designs or tests, that You Submit to Wirenote and that is
|
|
25
|
+
intended for inclusion in it. Material that You clearly mark as
|
|
26
|
+
"Not a Contribution" when You Submit it is not a Contribution.
|
|
27
|
+
- **"Submit"**: to send a Contribution to the Maintainer in any form,
|
|
28
|
+
including pull requests, patches, issue comments and attachments, and
|
|
29
|
+
messages on the project's communication channels.
|
|
30
|
+
|
|
31
|
+
## 2. Copyright license
|
|
32
|
+
|
|
33
|
+
You grant the Maintainer, and the recipients of software distributed by the
|
|
34
|
+
Maintainer, a worldwide, non-exclusive, free-of-charge, royalty-free,
|
|
35
|
+
irrevocable license, for the full term of copyright, to reproduce, modify,
|
|
36
|
+
prepare derivative works of, publicly display, publicly perform, make
|
|
37
|
+
available to the public, sublicense and distribute Your Contributions and
|
|
38
|
+
derivative works of them, in any form and **under any license terms**,
|
|
39
|
+
including licenses other than the GNU Affero General Public License, such as
|
|
40
|
+
proprietary or commercial licenses.
|
|
41
|
+
|
|
42
|
+
This license covers all types of use known when You Submit the Contribution
|
|
43
|
+
and, as far as the applicable law allows this agreement to grant them, types
|
|
44
|
+
of use that become known later.
|
|
45
|
+
|
|
46
|
+
To the extent the applicable law gives You a claim to payment for these
|
|
47
|
+
rights, You waive it, as far as that law allows. You may still sell your own
|
|
48
|
+
copies or other licenses of Your Contributions; this agreement is
|
|
49
|
+
non-exclusive.
|
|
50
|
+
|
|
51
|
+
## 3. Patent license
|
|
52
|
+
|
|
53
|
+
You grant the Maintainer, and the recipients of software distributed by the
|
|
54
|
+
Maintainer, a worldwide, non-exclusive, free-of-charge, royalty-free,
|
|
55
|
+
irrevocable patent license to make, have made, use, offer to sell, sell,
|
|
56
|
+
import and otherwise transfer Your Contributions and Wirenote. This license
|
|
57
|
+
covers only those patent claims that You can license and that are necessarily
|
|
58
|
+
infringed by Your Contribution alone or by its combination with the version
|
|
59
|
+
of Wirenote to which You Submitted it.
|
|
60
|
+
|
|
61
|
+
If any entity starts patent litigation (including a cross-claim or
|
|
62
|
+
counterclaim) alleging that Your Contribution, or Wirenote, infringes a
|
|
63
|
+
patent, the patent licenses granted to that entity under this agreement for
|
|
64
|
+
that Contribution or for Wirenote end on the date that litigation is filed.
|
|
65
|
+
|
|
66
|
+
## 4. The Maintainer's commitments
|
|
67
|
+
|
|
68
|
+
1. **Open source stays open.** Every Contribution that is accepted into
|
|
69
|
+
Wirenote will remain available to the public under a license approved by
|
|
70
|
+
the Open Source Initiative, such as the GNU Affero General Public License,
|
|
71
|
+
version 3 or later. The rights in section 2 allow the Maintainer to offer
|
|
72
|
+
Wirenote under other terms as well; they do not allow withdrawing Your
|
|
73
|
+
Contribution from the open source version.
|
|
74
|
+
2. **Credit.** Your authorship stays recorded in the project's version
|
|
75
|
+
history.
|
|
76
|
+
3. **No obligation.** The Maintainer may decide not to use a Contribution,
|
|
77
|
+
and may change it before or after including it.
|
|
78
|
+
|
|
79
|
+
## 5. What You confirm
|
|
80
|
+
|
|
81
|
+
1. You are legally able to enter into this agreement.
|
|
82
|
+
2. Each Contribution is Your original creation, or You have the right to
|
|
83
|
+
Submit it under this agreement. If any part of a Contribution comes from
|
|
84
|
+
someone else, You say so when You Submit it, and You name its source and
|
|
85
|
+
license.
|
|
86
|
+
3. As far as You know, Your Contributions do not infringe anyone else's
|
|
87
|
+
rights.
|
|
88
|
+
4. If an employer or anyone else has rights in Your Contributions (for
|
|
89
|
+
example because Your employment contract covers software You write), You
|
|
90
|
+
have their written permission to Submit the Contributions and to grant
|
|
91
|
+
the licenses in this agreement, or they have waived those rights.
|
|
92
|
+
5. You will tell the Maintainer promptly if any of this stops being true.
|
|
93
|
+
|
|
94
|
+
If You want to contribute on behalf of your employer or another
|
|
95
|
+
organization, please open an issue first; the organization then signs a
|
|
96
|
+
separate agreement.
|
|
97
|
+
|
|
98
|
+
## 6. No warranty; liability
|
|
99
|
+
|
|
100
|
+
Unless You agree otherwise in writing, You provide Your Contributions
|
|
101
|
+
"as is", without warranties or conditions of any kind, and You are not
|
|
102
|
+
expected to provide support for them.
|
|
103
|
+
|
|
104
|
+
As far as the applicable law allows, neither You nor the Maintainer is
|
|
105
|
+
liable to the other for damages arising from this agreement, except for
|
|
106
|
+
damages caused intentionally or through gross negligence, and except for
|
|
107
|
+
injury to life, body or health.
|
|
108
|
+
|
|
109
|
+
## 7. Moral rights
|
|
110
|
+
|
|
111
|
+
Nothing in this agreement affects moral rights that the applicable law does
|
|
112
|
+
not allow You to give up. Within those limits, You agree that the Maintainer
|
|
113
|
+
may modify Your Contributions, combine them with other works, and credit You
|
|
114
|
+
through the version history rather than in each file.
|
|
115
|
+
|
|
116
|
+
## 8. Transfer
|
|
117
|
+
|
|
118
|
+
The Maintainer may transfer this agreement, with all its rights and
|
|
119
|
+
obligations, to a person or legal entity that takes over the maintenance of
|
|
120
|
+
Wirenote, including a company the Maintainer founds or controls. The
|
|
121
|
+
transfer is valid only if the new party is bound by section 4. You agree to
|
|
122
|
+
such a transfer in advance.
|
|
123
|
+
|
|
124
|
+
## 9. Stopping
|
|
125
|
+
|
|
126
|
+
You may end this agreement at any time for Contributions You Submit in the
|
|
127
|
+
future, by telling the Maintainer in writing (an issue or an email is
|
|
128
|
+
enough). The licenses for Contributions You Submitted before that remain in
|
|
129
|
+
force.
|
|
130
|
+
|
|
131
|
+
## 10. General
|
|
132
|
+
|
|
133
|
+
1. This agreement is governed by the law of the Federal Republic of Germany,
|
|
134
|
+
excluding the United Nations Convention on Contracts for the
|
|
135
|
+
International Sale of Goods. Mandatory consumer protection rules of the
|
|
136
|
+
country where You live remain unaffected.
|
|
137
|
+
2. If any provision of this agreement is invalid or unenforceable, the rest
|
|
138
|
+
remains in force, and the invalid provision is replaced by a valid one
|
|
139
|
+
that comes closest to its purpose.
|
|
140
|
+
3. This agreement is the complete agreement between You and the Maintainer
|
|
141
|
+
about Your Contributions. A later version of it applies to You only if
|
|
142
|
+
You sign that version.
|
|
143
|
+
|
|
144
|
+
## 11. How to sign
|
|
145
|
+
|
|
146
|
+
When You open Your first pull request, the CLA Assistant bot posts a comment
|
|
147
|
+
with a link. Follow it, sign in with GitHub, and select "I agree". Your
|
|
148
|
+
GitHub account name, the date and the version of this agreement are
|
|
149
|
+
recorded. You do not need to sign again for later pull requests, unless a
|
|
150
|
+
new version of this agreement is published.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
|
|
6
|
+
|
|
7
|
+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
|
8
|
+
|
|
9
|
+
## Our Standards
|
|
10
|
+
|
|
11
|
+
Examples of behavior that contributes to a positive environment for our community include:
|
|
12
|
+
|
|
13
|
+
* Demonstrating empathy and kindness toward other people
|
|
14
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
15
|
+
* Giving and gracefully accepting constructive feedback
|
|
16
|
+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
|
17
|
+
* Focusing on what is best not just for us as individuals, but for the overall community
|
|
18
|
+
|
|
19
|
+
Examples of unacceptable behavior include:
|
|
20
|
+
|
|
21
|
+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
|
|
22
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
23
|
+
* Public or private harassment
|
|
24
|
+
* Publishing others' private information, such as a physical or email address, without their explicit permission
|
|
25
|
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
26
|
+
|
|
27
|
+
## Enforcement Responsibilities
|
|
28
|
+
|
|
29
|
+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
|
30
|
+
|
|
31
|
+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
|
32
|
+
|
|
33
|
+
## Scope
|
|
34
|
+
|
|
35
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
36
|
+
|
|
37
|
+
## Enforcement
|
|
38
|
+
|
|
39
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement privately, through the repository's **Security** tab › **Report a vulnerability** (only the maintainer can read it; start the title with "Code of conduct"). All complaints will be reviewed and investigated promptly and fairly.
|
|
40
|
+
|
|
41
|
+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
42
|
+
|
|
43
|
+
## Enforcement Guidelines
|
|
44
|
+
|
|
45
|
+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
|
46
|
+
|
|
47
|
+
### 1. Correction
|
|
48
|
+
|
|
49
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
|
50
|
+
|
|
51
|
+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
|
52
|
+
|
|
53
|
+
### 2. Warning
|
|
54
|
+
|
|
55
|
+
**Community Impact**: A violation through a single incident or series of actions.
|
|
56
|
+
|
|
57
|
+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
|
58
|
+
|
|
59
|
+
### 3. Temporary Ban
|
|
60
|
+
|
|
61
|
+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
|
62
|
+
|
|
63
|
+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
|
64
|
+
|
|
65
|
+
### 4. Permanent Ban
|
|
66
|
+
|
|
67
|
+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
|
68
|
+
|
|
69
|
+
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
|
70
|
+
|
|
71
|
+
## Attribution
|
|
72
|
+
|
|
73
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
74
|
+
|
|
75
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
76
|
+
|
|
77
|
+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
|
|
78
|
+
|
|
79
|
+
[homepage]: https://www.contributor-covenant.org
|
|
80
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
81
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
82
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
83
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Contributing to Wirenote
|
|
2
|
+
|
|
3
|
+
Thank you for helping. Bug reports, tested fixes, support for more call apps and desktops, and clearer docs are all welcome.
|
|
4
|
+
|
|
5
|
+
## Before you start
|
|
6
|
+
|
|
7
|
+
- **Bugs:** open an issue with your distribution, desktop, PipeWire version (`pipewire --version`) and the output of `wirenote doctor`. Never attach recordings, transcripts, calendar links or full logs: they contain other people's words and names.
|
|
8
|
+
- **Larger changes:** open an issue first, so we can agree on the approach before you spend time on it.
|
|
9
|
+
- **Security problems:** do not open an issue; see [SECURITY.md](SECURITY.md).
|
|
10
|
+
|
|
11
|
+
## Development setup
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
git clone https://github.com/knowhrishi/wirenote
|
|
15
|
+
cd wirenote
|
|
16
|
+
uv sync
|
|
17
|
+
uv run pytest -q
|
|
18
|
+
uv run pyflakes src tests
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Run your checkout as the real thing with `uv tool install --editable --force .` and `wirenote setup install`.
|
|
22
|
+
|
|
23
|
+
The design notes in [docs/dev/](docs/dev/) explain why the detector, the capture and the processing work the way they do; [docs/dev/PLAN.md](docs/dev/PLAN.md) has the defaults table every threshold in the code refers to.
|
|
24
|
+
|
|
25
|
+
## Pull requests
|
|
26
|
+
|
|
27
|
+
- Keep each pull request to one change, with a test that fails without it. The tests run without PipeWire, a GPU or network access; keep it that way (see the fakes in `tests/`).
|
|
28
|
+
- Every Python file starts with the license header:
|
|
29
|
+
```python
|
|
30
|
+
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
31
|
+
# Copyright (c) 2026 Hrishikesh Jadhav
|
|
32
|
+
```
|
|
33
|
+
If you add a file, use the same header; you keep the copyright in your changes (see the CLA below).
|
|
34
|
+
- Anything that sends data off the computer must be opt-in and listed in [PRIVACY.md](PRIVACY.md) and in the app's disclosure text.
|
|
35
|
+
- To add a call app, add a rule to the defaults in `src/wirenote/config/apps.py` and say how you verified it (`wirenote dump-streams` during a call shows what the detector sees).
|
|
36
|
+
|
|
37
|
+
## Contributor License Agreement
|
|
38
|
+
|
|
39
|
+
Before your first pull request is merged, you sign the [CLA](CLA.md) once; a bot asks you on the pull request. It lets the maintainer also offer Wirenote under other terms (for example a supported edition for companies), while every accepted contribution stays available under an open source license.
|
|
40
|
+
|
|
41
|
+
## Code of conduct
|
|
42
|
+
|
|
43
|
+
Everyone taking part follows the [code of conduct](CODE_OF_CONDUCT.md).
|