bionic-reader 0.1.0__py3-none-macosx_11_0_arm64.whl

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.
Files changed (21) hide show
  1. bionic_reader-0.1.0.data/data/share/bionic-reader/completions/_bionic-reader +595 -0
  2. bionic_reader-0.1.0.data/data/share/bionic-reader/completions/bionic-reader.bash +1052 -0
  3. bionic_reader-0.1.0.data/data/share/bionic-reader/completions/bionic-reader.fish +372 -0
  4. bionic_reader-0.1.0.data/data/share/bionic-reader/config.example.toml +19 -0
  5. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/README.md +37 -0
  6. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/bash-it/bionic-reader/bionic-reader.plugin.bash +4 -0
  7. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/fisher/bionic-reader/conf.d/bionic-reader.fish +4 -0
  8. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/frameworks.tsv +7 -0
  9. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-bash/bionic-reader/bionic-reader.plugin.sh +4 -0
  10. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-fish/bionic-reader/init.fish +4 -0
  11. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-zsh/bionic-reader/bionic-reader.plugin.zsh +4 -0
  12. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/prezto/bionic-reader/init.zsh +4 -0
  13. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/zinit/bionic-reader/init.zsh +4 -0
  14. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/bash.sh +85 -0
  15. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/fish.fish +27 -0
  16. bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/zsh.sh +33 -0
  17. bionic_reader-0.1.0.data/scripts/bionic-reader +0 -0
  18. bionic_reader-0.1.0.dist-info/METADATA +158 -0
  19. bionic_reader-0.1.0.dist-info/RECORD +21 -0
  20. bionic_reader-0.1.0.dist-info/WHEEL +4 -0
  21. bionic_reader-0.1.0.dist-info/sboms/bionic-reader.cyclonedx.json +3045 -0
@@ -0,0 +1,27 @@
1
+ # bionic-reader generated fish integration. Evaluate with: eval (bionic-reader init fish | string collect)
2
+ if test "$BIONIC_READER_DISABLE" != 1; and status is-interactive; and isatty stdin; and isatty stdout
3
+ if test "$BIONIC_READER_SESSION" = 1; and set -q BIONIC_READER_MARKER_TOKEN
4
+ if not set -q _BIONIC_READER_FISH_HOOKS
5
+ set -g _BIONIC_READER_FISH_HOOKS 1
6
+ set -g _BIONIC_READER_FISH_ACTIVE 0
7
+ function __bionic_reader_marker --argument-names kind metadata
8
+ printf '\eP+BIONIC_READER;%s;%s:%s\e\\' "$BIONIC_READER_MARKER_TOKEN" "$kind" "$metadata" >&2
9
+ end
10
+ function __bionic_reader_preexec --on-event fish_preexec
11
+ if test "$_BIONIC_READER_FISH_ACTIVE" != 1
12
+ set -g _BIONIC_READER_FISH_ACTIVE 1
13
+ set -l encoded (string escape --style=script -- "$argv[1]")
14
+ __bionic_reader_marker BEGIN "$encoded"
15
+ end
16
+ end
17
+ function __bionic_reader_postexec --on-event fish_postexec
18
+ if test "$_BIONIC_READER_FISH_ACTIVE" = 1
19
+ __bionic_reader_marker END
20
+ set -g _BIONIC_READER_FISH_ACTIVE 0
21
+ end
22
+ end
23
+ end
24
+ else if test "$BIONIC_READER_SESSION" != 1
25
+ exec bionic-reader session --shell fish
26
+ end
27
+ end
@@ -0,0 +1,33 @@
1
+ # bionic-reader generated Zsh integration. Evaluate with: eval "$(bionic-reader init zsh)"
2
+ if [[ ${BIONIC_READER_DISABLE-} != 1 && -o interactive && -t 0 && -t 1 ]]; then
3
+ if [[ ${BIONIC_READER_SESSION-} == 1 && -n ${BIONIC_READER_MARKER_TOKEN-} ]]; then
4
+ if (( ! ${+_BIONIC_READER_ZSH_HOOKS} )); then
5
+ typeset -g _BIONIC_READER_ZSH_HOOKS=1
6
+ typeset -g _BIONIC_READER_ZSH_ACTIVE=0
7
+ _bionic_reader_marker() {
8
+ local _br_quoted=
9
+ (( $# > 1 )) && _br_quoted=$(builtin printf '%q' "$2")
10
+ builtin printf '\033P+BIONIC_READER;%s;%s:%s\033\\' "$BIONIC_READER_MARKER_TOKEN" "$1" "$_br_quoted" >&2
11
+ }
12
+ _bionic_reader_preexec() {
13
+ if [[ $_BIONIC_READER_ZSH_ACTIVE != 1 ]]; then
14
+ _BIONIC_READER_ZSH_ACTIVE=1
15
+ _bionic_reader_marker BEGIN "$1"
16
+ fi
17
+ }
18
+ _bionic_reader_precmd() {
19
+ local _br_status=$?
20
+ if [[ $_BIONIC_READER_ZSH_ACTIVE == 1 ]]; then
21
+ _bionic_reader_marker END
22
+ _BIONIC_READER_ZSH_ACTIVE=0
23
+ fi
24
+ return $_br_status
25
+ }
26
+ typeset -ga precmd_functions preexec_functions
27
+ (( ${precmd_functions[(Ie)_bionic_reader_precmd]} )) || precmd_functions=(_bionic_reader_precmd "${precmd_functions[@]}")
28
+ (( ${preexec_functions[(Ie)_bionic_reader_preexec]} )) || preexec_functions+=(_bionic_reader_preexec)
29
+ fi
30
+ elif [[ ${BIONIC_READER_SESSION-} != 1 ]]; then
31
+ exec bionic-reader session --shell zsh
32
+ fi
33
+ fi
@@ -0,0 +1,158 @@
1
+ Metadata-Version: 2.4
2
+ Name: bionic-reader
3
+ Version: 0.1.0
4
+ Classifier: Environment :: Console
5
+ Classifier: License :: OSI Approved :: MIT License
6
+ Classifier: Operating System :: MacOS
7
+ Classifier: Operating System :: POSIX :: Linux
8
+ Classifier: Programming Language :: Rust
9
+ Classifier: Topic :: Text Processing
10
+ Summary: Local word-prefix emphasis for text streams and terminal sessions
11
+ Author: arturoaviles and contributors
12
+ License-Expression: MIT
13
+ Requires-Python: >=3.8
14
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
15
+
16
+ # Bionic Reader
17
+
18
+ Read text with emphasis on the beginnings of words.
19
+
20
+ [![CI](https://github.com/arturoaviles/bionic-reader/actions/workflows/ci.yml/badge.svg)](https://github.com/arturoaviles/bionic-reader/actions/workflows/ci.yml)
21
+ [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/arturoaviles/bionic-reader/blob/main/LICENSE)
22
+
23
+ Bionic Reader works with text streams, Markdown documents, and interactive shell
24
+ sessions. It runs locally and keeps your words intact. Try different emphasis
25
+ settings to find what feels comfortable; no reading-speed improvement is promised.
26
+
27
+ > **Bio**nic **Rea**der **empha**sizes **wo**rd **begin**nings.
28
+
29
+ ## Installation
30
+
31
+ **The first release and package-manager publications are pending.** Cargo's Git
32
+ installation works now. The commands below describe the release packages and
33
+ registry channels once published; [installation details](https://github.com/arturoaviles/bionic-reader/blob/main/docs/INSTALL.md)
34
+ include direct-download alternatives and platform requirements.
35
+
36
+ ### Homebrew
37
+
38
+ ```sh
39
+ brew install arturoaviles/tap/bionic-reader
40
+ ```
41
+
42
+ ### Linux
43
+
44
+ ```sh
45
+ # Debian / Ubuntu
46
+ curl -fL "https://github.com/arturoaviles/bionic-reader/releases/latest/download/bionic-reader-linux-$(dpkg --print-architecture).deb" -o bionic-reader.deb
47
+ sudo apt install ./bionic-reader.deb
48
+
49
+ # Fedora
50
+ curl -fL "https://github.com/arturoaviles/bionic-reader/releases/latest/download/bionic-reader-linux-$(rpm --eval '%{_arch}').rpm" -o bionic-reader.rpm
51
+ sudo dnf install --nogpgcheck ./bionic-reader.rpm
52
+
53
+ # Arch Linux
54
+ curl -fL "https://github.com/arturoaviles/bionic-reader/releases/latest/download/bionic-reader-linux-$(uname -m).pkg.tar.zst" -o bionic-reader.pkg.tar.zst
55
+ sudo pacman -U ./bionic-reader.pkg.tar.zst
56
+ ```
57
+
58
+ ### Python and Node.js
59
+
60
+ ```sh
61
+ # pip (in a virtual environment) or uv
62
+ pip install bionic-reader
63
+ uv tool install bionic-reader
64
+
65
+ # npm, Yarn, or pnpm
66
+ npm install --global @arturoaviles/bionic-reader
67
+ yarn add @arturoaviles/bionic-reader
68
+ pnpm add --global @arturoaviles/bionic-reader
69
+ ```
70
+
71
+ ### Cargo and Snap
72
+
73
+ ```sh
74
+ cargo install --git https://github.com/arturoaviles/bionic-reader.git --locked bionic-reader
75
+
76
+ # Snap currently installs a repository-built file; see the build guide.
77
+ sudo snap install --dangerous --classic ./dist/local/snap/bionic-reader_*.snap
78
+ ```
79
+
80
+ Yarn installs into the current project; run it with `yarn bionic-reader`.
81
+ Package managers select the CPU architecture automatically. Linux release
82
+ filenames use the native architecture query shown above. Snap build instructions
83
+ live in [BUILD.md](https://github.com/arturoaviles/bionic-reader/blob/main/docs/BUILD.md#snap-ubuntu-2404).
84
+ You can also download native binaries from [GitHub Releases](https://github.com/arturoaviles/bionic-reader/releases).
85
+
86
+ ## The reader
87
+
88
+ ```sh
89
+ bionic-reader read article.txt
90
+ cat article.txt | bionic-reader read
91
+ ```
92
+
93
+ Scroll with the arrow keys or `j`/`k`, search with `/`, and press `q` to leave.
94
+ Use `?` for all shortcuts. Adjust emphasis while you read with `+`/`-`, or try
95
+ settings interactively with `bionic-reader preview`.
96
+
97
+ ## The CLI
98
+
99
+ ```sh
100
+ bionic-reader -t 'Make long passages easier to follow.'
101
+ cat article.txt | bionic-reader
102
+ bionic-reader --input-format markdown --style always < article.md
103
+
104
+ # Change the reading style.
105
+ bionic-reader --profile subtle -t 'A lighter touch.'
106
+ bionic-reader --fraction 0.6 --every 2 -t 'Choose your own emphasis.'
107
+
108
+ # Export HTML or Markdown.
109
+ bionic-reader --format html < article.txt > article.html
110
+ bionic-reader --format markdown < article.txt > emphasized.md
111
+ ```
112
+
113
+ See `bionic-reader --help` and the [usage guide](https://github.com/arturoaviles/bionic-reader/blob/main/docs/USAGE.md)
114
+ for formats, profiles, safe terminal controls, and reader shortcuts.
115
+
116
+ ## Shell integration
117
+
118
+ Start a reading session with `bionic-reader session`. Known editors, pagers, and
119
+ full-screen applications use passthrough. Inside a session, use `bionic-reader
120
+ off`, `on`, or `toggle` to control emphasis, and `exit` to leave.
121
+
122
+ For automatic sessions, add one initializer to your shell configuration:
123
+
124
+ ```sh
125
+ # ~/.bashrc
126
+ eval "$(bionic-reader init bash)"
127
+ # ~/.zshrc
128
+ eval "$(bionic-reader init zsh)"
129
+ ```
130
+
131
+ Bash, Zsh, fish, shell completions, and seven framework adapters are covered in
132
+ the [shell guide](https://github.com/arturoaviles/bionic-reader/blob/main/docs/SHELL.md).
133
+
134
+ ## Configuration
135
+
136
+ Save preferences in `~/.config/bionic-reader/config.toml`, or beneath an absolute
137
+ `XDG_CONFIG_HOME`:
138
+
139
+ ```toml
140
+ profile = "balanced"
141
+ fraction = 0.5
142
+ emphasis = "bold"
143
+ ```
144
+
145
+ Command-line settings override the file. See the [configuration guide](https://github.com/arturoaviles/bionic-reader/blob/main/docs/CONFIGURATION.md)
146
+ for all options and precedence.
147
+
148
+ ## Contributing
149
+
150
+ See [CONTRIBUTING.md](https://github.com/arturoaviles/bionic-reader/blob/main/CONTRIBUTING.md)
151
+ for development checks, [BUILD.md](https://github.com/arturoaviles/bionic-reader/blob/main/docs/BUILD.md)
152
+ for source builds, and [RELEASE.md](https://github.com/arturoaviles/bionic-reader/blob/main/docs/RELEASE.md)
153
+ for release and package publication.
154
+
155
+ ## License
156
+
157
+ [MIT](https://github.com/arturoaviles/bionic-reader/blob/main/LICENSE).
158
+
@@ -0,0 +1,21 @@
1
+ bionic_reader-0.1.0.data/data/share/bionic-reader/completions/_bionic-reader,sha256=TWygi_sx9DS3F2KIrJI9KDa4l87mm8L3BIdDxKrJHnI,39689
2
+ bionic_reader-0.1.0.data/data/share/bionic-reader/completions/bionic-reader.bash,sha256=Y0yJjco2AdqiWiVGKby1yqV8bW1OPMqci_DX5-6EwNk,39372
3
+ bionic_reader-0.1.0.data/data/share/bionic-reader/completions/bionic-reader.fish,sha256=2G4GdRSOMXrbC1BmVZZzgrEtXt5ryBVtSCRrWe9VIQg,46733
4
+ bionic_reader-0.1.0.data/data/share/bionic-reader/config.example.toml,sha256=6XXkRYcy_PnUcVxhxTCvFJBPcfq37zBlFp0FN9TsPtc,741
5
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/README.md,sha256=0L53aGFdI_cOVPInOCFS-hexP--rtrTNdF4xYu7t1FA,2949
6
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/bash-it/bionic-reader/bionic-reader.plugin.bash,sha256=1kx7gzM3cvvhc9ny5-Rdp_M_ABg3bWlZ04wHTPBawfI,231
7
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/fisher/bionic-reader/conf.d/bionic-reader.fish,sha256=7mvirDjBjtn89DIRj0zXkaWZJ4YwHnJW-rebtwV_3D0,230
8
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/frameworks.tsv,sha256=XykENAjBrMgZRydTBD5gIb32eDAhbPNRbjV37pJLb1g,647
9
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-bash/bionic-reader/bionic-reader.plugin.sh,sha256=l1pIiHrSVOM8oF_FjB7091kM3Fv5XjSii9wnd4c0ey0,243
10
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-fish/bionic-reader/init.fish,sha256=vy6AzrTJo29yeV9QoaJp3Rj2KI7RmRyVo5_IjhF74F4,219
11
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/oh-my-zsh/bionic-reader/bionic-reader.plugin.zsh,sha256=ZIn8_ADSBd78nPdgqr_GjLwPuxlEmRpTtO4Yxk3zHMs,233
12
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/prezto/bionic-reader/init.zsh,sha256=70WtjJlKQv1pY-LNCw2LXMy9AQC74gDkcuxyeIsMxTM,235
13
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/adapters/zinit/bionic-reader/init.zsh,sha256=1FrAdQGbe3XufGb95bMmnjC1JALFCHlqpon7kGPNzxg,217
14
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/bash.sh,sha256=0BRMtr9BoM7SRIsb1nCsRSkhZxex4CDw9vCCsiXUu-Q,3988
15
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/fish.fish,sha256=rpfXDrqJAG-5v_Dqx8bsEaFicizaxfKnNjSL-nLZBUo,1380
16
+ bionic_reader-0.1.0.data/data/share/bionic-reader/integrations/zsh.sh,sha256=eJBz4uSB8j_QSGIG9Mh8OhVrYQgXT6HkvIoAAcLm6Dk,1457
17
+ bionic_reader-0.1.0.data/scripts/bionic-reader,sha256=VxhvONh3gM98GMVcs1sIkgzPhFiIc-_brOcyi7XYtJQ,4820112
18
+ bionic_reader-0.1.0.dist-info/METADATA,sha256=8EoMzzrhZKbV-y2mZfI452wjPsqDpKlPDyVJ7SMcGeg,5708
19
+ bionic_reader-0.1.0.dist-info/WHEEL,sha256=U927pSLvWHh5eaqcN5v72CdMm-HUWF344fKLe8HhSOU,102
20
+ bionic_reader-0.1.0.dist-info/sboms/bionic-reader.cyclonedx.json,sha256=9VdAHSTG8p8S4KZZMGK8ml7HANolnXvoLXq-se5fsWQ,96380
21
+ bionic_reader-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.15.0)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-macosx_11_0_arm64