You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-20Lines changed: 36 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,22 @@
4
4
5
5
Much of the functionality of this package has been ported over from [tivars_lib_cpp](https://github.com/adriweb/tivars_lib_cpp). However, a number of changes have been made to the API to better suit Python's strengths and capabilities as a language (e.g. scripting, dynamic typing).
6
6
7
+
-[Installation](#installation)
8
+
-[As a Package](#as-a-package)
9
+
-[As a Submodule](#as-a-submodule)
10
+
-[Unit Testing](#unit-testing)
11
+
-[How to Use](#how-to-use)
12
+
-[Entries](#entries)
13
+
-[Vars & Headers](#vars--headers)
14
+
-[Models](#models)
15
+
-[Documentation](#documentation)
16
+
-[API](#api)
17
+
-[Formatting Output](#formatting-output)
18
+
-[Other Functionalities](#other-functionalities)
19
+
-[PIL](#pil)
20
+
-[Tokenization](#tokenization)
21
+
-[Examples](#examples)
22
+
7
23
## Installation
8
24
9
25
The current release version is `v0.9.2`. All versions require Python 3.10+ to run.
@@ -246,24 +262,6 @@ Flash files such as apps, OSes, and certificates can be loaded using the `TIFlas
246
262
247
263
All TI-82/83/84 series calcs are represented as `TIModel` objects stored in `tivars.models`. Each model contains its name, metadata, and features; use `has` on a `TIFeature` to check that a model has a given a feature. Models are also used to determine var file extensions and token sheets.
248
264
249
-
## Other Functionalities
250
-
251
-
### PIL
252
-
253
-
The `tivars.PIL` package can be used to interface with PIL, the [Python Imaging Library](https://pillow.readthedocs.io/en/stable/). Simply import the package to register codecs for each of the TI image types. You can then open such images directly into a PIL `Image`:
254
-
255
-
```python
256
-
fromPILimport Image
257
-
from tivars.PILimport*
258
-
259
-
img = Image.open("Pic1.8ci")
260
-
img.show()
261
-
```
262
-
263
-
### Tokenization
264
-
265
-
Functions to decode and encode strings into tokens can be found in `tivars.tokenizer`. These functions utilize the [TI-Toolkit token sheets](https://github.com/TI-Toolkit/tokens), which are kept as a submodule in `tivars.tokens`. Support currently exists for all models in the 82/83/84 series; PR's concerning the sheets themselves should be directed upstream.
266
-
267
265
## Documentation
268
266
269
267
### API
@@ -275,7 +273,7 @@ The var file format(s) and data sections can be found in a readable format on th
275
273
> [!NOTE]
276
274
> The wiki is still a work-in-progress. Why not [contribute a page](https://github.com/TI-Toolkit/tivars_lib_py/wiki)?
277
275
278
-
### Formatting
276
+
### Formatting Output
279
277
280
278
All entry types support string formatting using Python's f-strings.
281
279
@@ -294,6 +292,24 @@ All entry types support string formatting using Python's f-strings.
294
292
295
293
Additionally, the `t` type is supported for types which can be made from tokens, composing the object out of typeable (accessible) token names. For example, `-2 + 5i` is presented as `~2+5[i]`.
296
294
295
+
## Other Functionalities
296
+
297
+
### PIL
298
+
299
+
The `tivars.PIL` package can be used to interface with PIL, the [Python Imaging Library](https://pillow.readthedocs.io/en/stable/). Simply import the package to register codecs for each of the TI image types. You can then open such images directly into a PIL `Image`:
300
+
301
+
```python
302
+
fromPILimport Image
303
+
from tivars.PILimport*
304
+
305
+
img = Image.open("Pic1.8ci")
306
+
img.show()
307
+
```
308
+
309
+
### Tokenization
310
+
311
+
Functions to decode and encode strings into tokens can be found in `tivars.tokenizer`. These functions utilize the [TI-Toolkit token sheets](https://github.com/TI-Toolkit/tokens), which are kept as a submodule in `tivars.tokens`. Support currently exists for all models in the 82/83/84 series; PR's concerning the sheets themselves should be directed upstream.
312
+
297
313
## Examples
298
314
299
-
You can find more sample code in `examples` that details common operations on each of the entry types. There are also examples for interfacing with popular external libraries (e.g. NumPy, PIL). Contributions welcome!
315
+
You can find more sample code in [`examples`](https://github.com/TI-Toolkit/tivars_lib_py/tree/main/examples) that details common operations on each of the entry types. There are also examples for interfacing with popular external libraries (e.g. NumPy, PIL). Contributions welcome!
0 commit comments