numbers-parser 4.8.0__tar.gz → 4.9.0__tar.gz

{numbers_parser-4.8.0 → numbers_parser-4.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: numbers-parser
-Version: 4.8.0
+Version: 4.9.0
 Summary: Read and write Apple Numbers spreadsheets
 Home-page: https://github.com/masaccio/numbers-parser
 License: MIT
@@ -57,14 +57,16 @@ For Intel Macs:
 
 ```bash
 brew install snappy python3
-CPPFLAGS="-I/usr/local/include -L/usr/local/lib" python3 -m pip install python-snappy
+CPPFLAGS="-I/usr/local/include -L/usr/local/lib" \
+python3 -m pip install python-snappy
 ```
 
 For Apple Silicon Macs:
 
 ```bash
 brew install snappy python3
-CPPFLAGS="-I/opt/homebrew/include -L/opt/homebrew/lib" python3 -m pip install python-snappy
+CPPFLAGS="-I/opt/homebrew/include -L/opt/homebrew/lib" \
+python3 -m pip install python-snappy
 ```
 
 For Linux (your package manager may be different):
@@ -78,10 +80,10 @@ binary libraries compiled by [Christoph Gohlke](https://www.lfd.uci.edu/~gohlke/
 version for your installation. For example for python 3.11:
 
 ```text
-C:\Users\Jon>pip install C:\Users\Jon\Downloads\python_snappy-0.6.1-cp311-cp311-win_amd64.whl
+pip install python_snappy-0.6.1-cp311-cp311-win_amd64.whl
 ```
 
-### Quick Start
+## Quick Start
 
 Reading documents:
 
@@ -121,7 +123,7 @@ the column values.
 'Debit'
 ```
 
-#### Cell Data
+### Cell Data
 
 Cells are objects with a common base class of `Cell`. All cell types
 have a property `value` which returns the contents of the cell as a
@@ -129,17 +131,17 @@ python datatype. `numbers-parser` uses
 [pendulum](https://pendulum.eustace.io) instead of python’s builtin
 types. Available cell types are:
 
-| Cell type         | value type               | Additional properties                                                                           |
-|-------------------|--------------------------|-------------------------------------------------------------------------------------------------|
-| N<br/>umberCell   | `float`                  |                                                                                                 |
-| TextCell          | `str`                    |                                                                                                 |
-| Ric<br/>hTextCell | `str`                    | See [Bullets and<br/>lists](#bullets-and-lists)                                                 |
-| EmptyCell         | `None`                   |                                                                                                 |
-| BoolCell          | `bool`                   |                                                                                                 |
-| DateCell          | `pend<br/>ulum.datetime` |                                                                                                 |
-| Dur<br/>ationCell | `pend<br/>ulum.duration` |                                                                                                 |
-| ErrorCell         | `None`                   |                                                                                                 |
-| M<br/>ergedCell   | `None`                   | See [Merged<br/>c<br/>ells](https://masaccio.github.io/numbers-parser/#table-cell-merged-cells) |
+| Cell type    | value type          | Additional properties                                                                                  |
+|--------------|---------------------|--------------------------------------------------------------------------------------------------------|
+| NumberCell   | `float`             |                                                                                                        |
+| TextCell     | `str`               |                                                                                                        |
+| RichTextCell | `str`               | See [Rich text](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.RichTextCell)  |
+| EmptyCell    | `None`              |                                                                                                        |
+| BoolCell     | `bool`              |                                                                                                        |
+| DateCell     | `pendulum.datetime` |                                                                                                        |
+| DurationCell | `pendulum.duration` |                                                                                                        |
+| ErrorCell    | `None`              |                                                                                                        |
+| MergedCell   | `None`              | See [Merged cells](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.MergedCell) |
 
 Cell references can be either zero-offset row/column integers or an
 Excel/Numbers A1 notation. Where cell values are not `None` the
@@ -161,7 +163,7 @@ any kind `ErrorCell`.
 '£1,234.50'
 ```
 
-#### Pandas Support
+### Pandas Support
 
 Since the return value of `rows()` is a list of lists, you can pass
 this directly to pandas. Assuming you have a Numbers table with a single
@@ -178,15 +180,15 @@ data = tables[0].rows(values_only=True)
 df = pd.DataFrame(data[1:], columns=data[0])
 ```
 
-#### Writing Numbers Documents
+### Writing Numbers Documents
 
 Whilst support for writing numbers files has been stable since version
 3.4.0, you are highly recommended not to overwrite working Numbers files
 and instead save data to a new file.
 
 Cell values are written using
-[Table.write()](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.write)
-and `numbers-parser` will automatically create empty rows and columns
+[Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and
+`numbers-parser` will automatically create empty rows and columns
 for any cell references that are out of range of the current table.
 
 ```python
@@ -199,12 +201,9 @@ table.write("B7", datetime(2020, 12, 25))
 doc.save("new-sheet.numbers")
 ```
 
-Additional tables and worksheets can be added to a `Document` before
-saving using
-[Document.add_sheet()](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_sheet)
-and
-[Sheet.add_table()](https://masaccio.github.io/numbers-parser/#numbers_parser.Sheet.add_table)
-respectively:
+Additional tables and worksheets can be added to a `Document` before saving using
+[Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and
+[Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
 
 ```python
 doc = Document()
@@ -217,37 +216,48 @@ table.write(1, 3, 3000)
 doc.save("sheet.numbers")
 ```
 
-#### Styles
+### Styles
 
 `numbers_parser` currently only supports paragraph styles and cell
-styles. The following paragraph styles are supported:
+styles. The following styles are supported:
 
 - font attributes: bold, italic, underline, strikethrough
 - font selection and size
 - text foreground color
 - horizontal and vertical alignment
 - cell background color
+- cell background images
 - cell indents (first line, left, right, and text inset)
 
 Numbers conflates style attributes that can be stored in paragraph
 styles (the style menu in the text panel) with the settings that are
 available on the Style tab of the Text panel. Some attributes in Numbers
-are not applied to new cells when a style is applied. To keep the API
-simple, `numbers-parser` packs all styling into a single
-[Style](https://masaccio.github.io/numbers-parser/#numbers_parser.Style)
-object. When a document is saved, the attributes not stored in a
-paragraph style are applied to each cell that includes it.
+are not applied to new cells when a style is applied.
+
+To keep the API simple, `numbers-parser` packs all styling into a single
+[Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes
+not stored in a paragraph style are applied to each cell that includes it.
 
 Styles are read from cells using the
-[Cell.style](https://masaccio.github.io/numbers-parser/#numbers_parser.Cell.style)
-propert and you can add new styles with
-[Document.add_style](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_style).
+[Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can
+add new styles with
+[Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
 
-Since `Style` objects are shared, changing `Cell.style.font_size`
-will have the effect of changing the font size for that style and will
-in turn affect the styles of all cells using that style.
+```python
+red_text = doc.add_style(
+    name="Red Text",
+    font_name="Lucida Grande",
+    font_color=RGB(230, 25, 25),
+    font_size=14.0,
+    bold=True,
+    italic=True,
+    alignment=Alignment("right", "top"),
+)
+table.write("B2", "Red", style=red_text)
+table.set_cell_style("C2", red_text)
+```
 
-#### Cell Data Formatting
+### Cell Data Formatting
 
 Numbers has two different cell formatting types: data formats and custom
 formats.
@@ -260,23 +270,37 @@ internally by the package. Changing a data format for cell has no impact
 on any other cells.
 
 Cell formats are changed using
-[Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting):
+[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
-table.set_cell_formatting("C1", "date", date_time_format="EEEE, d MMMM yyyy")
-table.set_cell_formatting(0, 4, "number", decimal_places=3, negative_style=NegativeNumberStyle.RED)
+table.set_cell_formatting(
+   "C1",
+   "date",
+   date_time_format="EEEE, d MMMM yyyy"
+)
+table.set_cell_formatting(
+   0,
+   4,
+   "number",
+   decimal_places=3,
+   negative_style=NegativeNumberStyle.RED
+)
 ```
 
 Custom formats are shared across a Document and can be applied to
 multiple cells in multiple tables. Editing a custom format changes the
 appearance of data in all cells that share that format. You must first
 add a custom format to the document using
-[Document.add_custom_format](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_custom_format)
+[Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format)
 before assigning it to cells using
-[Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting):
+[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
-long_date = doc.add_custom_format(name="Long Date", type="date", date_time_format="EEEE, d MMMM yyyy")
+long_date = doc.add_custom_format(
+   name="Long Date",
+   type="date",
+   date_time_format="EEEE, d MMMM yyyy"
+)
 table.set_cell_formatting("C1", "custom", format=long_date)
 ```
 
@@ -287,7 +311,7 @@ example, US dollars are referred to as `US$` whereas Euros and British
 Pounds are referred to using their symbols of `€` and `£`
 respectively.
 
-#### Borders
+### Borders
 
 `numbers-parser` supports reading and writing cell borders, though the
 interface for each differs. Individual cells can have each of their four
@@ -296,13 +320,11 @@ table to allow for drawing borders across multiple cells. Setting the
 border of merged cells is not possible unless the edge of the cells is
 at the end of the merged region.
 
-Borders are represented using the
-[Border](https://masaccio.github.io/numbers-parser/#numbers_parser.Border)
-class that can be initialized with line width, color and line style. The
+Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class
+that can be initialized with line width, color and line style. The
 current state of a cell border is read using the
-[Cell.border](https://masaccio.github.io/numbers-parser/#numbers_parser.Cell.border)
-property. The
-[Table.set_cell_border](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_border)
+[Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property
+and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border)
 sets the border for a cell edge or a range of cells.
 
 ## API
@@ -319,25 +341,30 @@ format, iterating through all the spreadsheets passed on the
 command-line.
 
 ```text
-usage: cat-numbers [-h] [-T | -S | -b] [-V] [--debug] [--formulas]
-                   [--formatting] [-s SHEET] [-t TABLE] [document ...]
+usage: cat-numbers [-h] [-T | -S | -b] [-V] [--formulas] [--formatting]
+                  [-s SHEET] [-t TABLE] [--debug]
+                  [document ...]
 
 Export data from Apple Numbers spreadsheet tables
 
 positional arguments:
-  document                 Document(s) to export
-
-optional arguments:
-  -h, --help               show this help message and exit
-  -T, --list-tables        List the names of tables and exit
-  -S, --list-sheets        List the names of sheets and exit
-  -b, --brief              Don't prefix data rows with name of sheet/table (default: false)
+  document              Document(s) to export
+
+options:
+  -h, --help            show this help message and exit
+  -T, --list-tables     List the names of tables and exit
+  -S, --list-sheets     List the names of sheets and exit
+  -b, --brief           Don't prefix data rows with name of sheet/table
+                        (default: false)
   -V, --version
-  --debug                  Enable debug output
-  --formulas               Dump formulas instead of formula results
-  --formatting             Dump formatted cells (durations) as they appear in Numbers
-  -s SHEET, --sheet SHEET  Names of sheet(s) to include in export
-  -t TABLE, --table TABLE  Names of table(s) to include in export
+  --formulas            Dump formulas instead of formula results
+  --formatting          Dump formatted cells (durations) as they appear
+                        in Numbers
+  -s SHEET, --sheet SHEET
+                        Names of sheet(s) to include in export
+  -t TABLE, --table TABLE
+                        Names of table(s) to include in export
+  --debug               Enable debug logging
 ```
 
 Note: `--formatting` will return different capitalization for 12-hour
@@ -358,10 +385,6 @@ Current known limitations of `numbers-parser` are:
   worksheet which does not take into account title or caption size
 - New sheets insert tables with formats copied from the first table in
   the previous sheet rather than default table formats
-- Creating custom cell formats and cell data formats is experimental
-  and not all formats are supported. See
-  [Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting)
-  for more details.
 - Due to a limitation in Python’s
   [ZipFile](https://docs.python.org/3/library/zipfile.html), Python
   versions older than 3.11 do not support image filenames with UTF-8
@@ -373,6 +396,5 @@ Current known limitations of `numbers-parser` are:
 
 ## License
 
-All code in this repository is licensed under the [MIT
-License](https://github.com/masaccio/numbers-parser/blob/master/LICENSE.rst)
+All code in this repository is licensed under the [MIT License](https://github.com/masaccio/numbers-parser/blob/master/LICENSE.rst).
 

{numbers_parser-4.8.0 → numbers_parser-4.9.0}/README.md

@@ -27,14 +27,16 @@ For Intel Macs:
 
 ```bash
 brew install snappy python3
-CPPFLAGS="-I/usr/local/include -L/usr/local/lib" python3 -m pip install python-snappy
+CPPFLAGS="-I/usr/local/include -L/usr/local/lib" \
+python3 -m pip install python-snappy
 ```
 
 For Apple Silicon Macs:
 
 ```bash
 brew install snappy python3
-CPPFLAGS="-I/opt/homebrew/include -L/opt/homebrew/lib" python3 -m pip install python-snappy
+CPPFLAGS="-I/opt/homebrew/include -L/opt/homebrew/lib" \
+python3 -m pip install python-snappy
 ```
 
 For Linux (your package manager may be different):
@@ -48,10 +50,10 @@ binary libraries compiled by [Christoph Gohlke](https://www.lfd.uci.edu/~gohlke/
 version for your installation. For example for python 3.11:
 
 ```text
-C:\Users\Jon>pip install C:\Users\Jon\Downloads\python_snappy-0.6.1-cp311-cp311-win_amd64.whl
+pip install python_snappy-0.6.1-cp311-cp311-win_amd64.whl
 ```
 
-### Quick Start
+## Quick Start
 
 Reading documents:
 
@@ -91,7 +93,7 @@ the column values.
 'Debit'
 ```
 
-#### Cell Data
+### Cell Data
 
 Cells are objects with a common base class of `Cell`. All cell types
 have a property `value` which returns the contents of the cell as a
@@ -99,17 +101,17 @@ python datatype. `numbers-parser` uses
 [pendulum](https://pendulum.eustace.io) instead of python’s builtin
 types. Available cell types are:
 
-| Cell type         | value type               | Additional properties                                                                           |
-|-------------------|--------------------------|-------------------------------------------------------------------------------------------------|
-| N<br/>umberCell   | `float`                  |                                                                                                 |
-| TextCell          | `str`                    |                                                                                                 |
-| Ric<br/>hTextCell | `str`                    | See [Bullets and<br/>lists](#bullets-and-lists)                                                 |
-| EmptyCell         | `None`                   |                                                                                                 |
-| BoolCell          | `bool`                   |                                                                                                 |
-| DateCell          | `pend<br/>ulum.datetime` |                                                                                                 |
-| Dur<br/>ationCell | `pend<br/>ulum.duration` |                                                                                                 |
-| ErrorCell         | `None`                   |                                                                                                 |
-| M<br/>ergedCell   | `None`                   | See [Merged<br/>c<br/>ells](https://masaccio.github.io/numbers-parser/#table-cell-merged-cells) |
+| Cell type    | value type          | Additional properties                                                                                  |
+|--------------|---------------------|--------------------------------------------------------------------------------------------------------|
+| NumberCell   | `float`             |                                                                                                        |
+| TextCell     | `str`               |                                                                                                        |
+| RichTextCell | `str`               | See [Rich text](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.RichTextCell)  |
+| EmptyCell    | `None`              |                                                                                                        |
+| BoolCell     | `bool`              |                                                                                                        |
+| DateCell     | `pendulum.datetime` |                                                                                                        |
+| DurationCell | `pendulum.duration` |                                                                                                        |
+| ErrorCell    | `None`              |                                                                                                        |
+| MergedCell   | `None`              | See [Merged cells](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.MergedCell) |
 
 Cell references can be either zero-offset row/column integers or an
 Excel/Numbers A1 notation. Where cell values are not `None` the
@@ -131,7 +133,7 @@ any kind `ErrorCell`.
 '£1,234.50'
 ```
 
-#### Pandas Support
+### Pandas Support
 
 Since the return value of `rows()` is a list of lists, you can pass
 this directly to pandas. Assuming you have a Numbers table with a single
@@ -148,15 +150,15 @@ data = tables[0].rows(values_only=True)
 df = pd.DataFrame(data[1:], columns=data[0])
 ```
 
-#### Writing Numbers Documents
+### Writing Numbers Documents
 
 Whilst support for writing numbers files has been stable since version
 3.4.0, you are highly recommended not to overwrite working Numbers files
 and instead save data to a new file.
 
 Cell values are written using
-[Table.write()](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.write)
-and `numbers-parser` will automatically create empty rows and columns
+[Table.write()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.write) and
+`numbers-parser` will automatically create empty rows and columns
 for any cell references that are out of range of the current table.
 
 ```python
@@ -169,12 +171,9 @@ table.write("B7", datetime(2020, 12, 25))
 doc.save("new-sheet.numbers")
 ```
 
-Additional tables and worksheets can be added to a `Document` before
-saving using
-[Document.add_sheet()](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_sheet)
-and
-[Sheet.add_table()](https://masaccio.github.io/numbers-parser/#numbers_parser.Sheet.add_table)
-respectively:
+Additional tables and worksheets can be added to a `Document` before saving using
+[Document.add_sheet()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_sheet) and
+[Sheet.add_table()](https://masaccio.github.io/numbers-parser/api/sheet.html#numbers_parser.Sheet.add_table) respectively:
 
 ```python
 doc = Document()
@@ -187,37 +186,48 @@ table.write(1, 3, 3000)
 doc.save("sheet.numbers")
 ```
 
-#### Styles
+### Styles
 
 `numbers_parser` currently only supports paragraph styles and cell
-styles. The following paragraph styles are supported:
+styles. The following styles are supported:
 
 - font attributes: bold, italic, underline, strikethrough
 - font selection and size
 - text foreground color
 - horizontal and vertical alignment
 - cell background color
+- cell background images
 - cell indents (first line, left, right, and text inset)
 
 Numbers conflates style attributes that can be stored in paragraph
 styles (the style menu in the text panel) with the settings that are
 available on the Style tab of the Text panel. Some attributes in Numbers
-are not applied to new cells when a style is applied. To keep the API
-simple, `numbers-parser` packs all styling into a single
-[Style](https://masaccio.github.io/numbers-parser/#numbers_parser.Style)
-object. When a document is saved, the attributes not stored in a
-paragraph style are applied to each cell that includes it.
+are not applied to new cells when a style is applied.
+
+To keep the API simple, `numbers-parser` packs all styling into a single
+[Style](https://masaccio.github.io/numbers-parser/api/style.html) object. When a document is saved, the attributes
+not stored in a paragraph style are applied to each cell that includes it.
 
 Styles are read from cells using the
-[Cell.style](https://masaccio.github.io/numbers-parser/#numbers_parser.Cell.style)
-propert and you can add new styles with
-[Document.add_style](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_style).
+[Cell.style](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.style) property and you can
+add new styles with
+[Document.add_style](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_style).
 
-Since `Style` objects are shared, changing `Cell.style.font_size`
-will have the effect of changing the font size for that style and will
-in turn affect the styles of all cells using that style.
+```python
+red_text = doc.add_style(
+    name="Red Text",
+    font_name="Lucida Grande",
+    font_color=RGB(230, 25, 25),
+    font_size=14.0,
+    bold=True,
+    italic=True,
+    alignment=Alignment("right", "top"),
+)
+table.write("B2", "Red", style=red_text)
+table.set_cell_style("C2", red_text)
+```
 
-#### Cell Data Formatting
+### Cell Data Formatting
 
 Numbers has two different cell formatting types: data formats and custom
 formats.
@@ -230,23 +240,37 @@ internally by the package. Changing a data format for cell has no impact
 on any other cells.
 
 Cell formats are changed using
-[Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting):
+[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
-table.set_cell_formatting("C1", "date", date_time_format="EEEE, d MMMM yyyy")
-table.set_cell_formatting(0, 4, "number", decimal_places=3, negative_style=NegativeNumberStyle.RED)
+table.set_cell_formatting(
+   "C1",
+   "date",
+   date_time_format="EEEE, d MMMM yyyy"
+)
+table.set_cell_formatting(
+   0,
+   4,
+   "number",
+   decimal_places=3,
+   negative_style=NegativeNumberStyle.RED
+)
 ```
 
 Custom formats are shared across a Document and can be applied to
 multiple cells in multiple tables. Editing a custom format changes the
 appearance of data in all cells that share that format. You must first
 add a custom format to the document using
-[Document.add_custom_format](https://masaccio.github.io/numbers-parser/#numbers_parser.Document.add_custom_format)
+[Document.add_custom_format()](https://masaccio.github.io/numbers-parser/api/document.html#numbers_parser.Document.add_custom_format)
 before assigning it to cells using
-[Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting):
+[Table.set_cell_formatting()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_formatting):
 
 ```python
-long_date = doc.add_custom_format(name="Long Date", type="date", date_time_format="EEEE, d MMMM yyyy")
+long_date = doc.add_custom_format(
+   name="Long Date",
+   type="date",
+   date_time_format="EEEE, d MMMM yyyy"
+)
 table.set_cell_formatting("C1", "custom", format=long_date)
 ```
 
@@ -257,7 +281,7 @@ example, US dollars are referred to as `US$` whereas Euros and British
 Pounds are referred to using their symbols of `€` and `£`
 respectively.
 
-#### Borders
+### Borders
 
 `numbers-parser` supports reading and writing cell borders, though the
 interface for each differs. Individual cells can have each of their four
@@ -266,13 +290,11 @@ table to allow for drawing borders across multiple cells. Setting the
 border of merged cells is not possible unless the edge of the cells is
 at the end of the merged region.
 
-Borders are represented using the
-[Border](https://masaccio.github.io/numbers-parser/#numbers_parser.Border)
-class that can be initialized with line width, color and line style. The
+Borders are represented using the [Border](https://masaccio.github.io/numbers-parser/api/border.html) class
+that can be initialized with line width, color and line style. The
 current state of a cell border is read using the
-[Cell.border](https://masaccio.github.io/numbers-parser/#numbers_parser.Cell.border)
-property. The
-[Table.set_cell_border](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_border)
+[Cell.border](https://masaccio.github.io/numbers-parser/api/cells.html#numbers_parser.Cell.border) property
+and [Table.set_cell_border()](https://masaccio.github.io/numbers-parser/api/table.html#numbers_parser.Table.set_cell_border)
 sets the border for a cell edge or a range of cells.
 
 ## API
@@ -289,25 +311,30 @@ format, iterating through all the spreadsheets passed on the
 command-line.
 
 ```text
-usage: cat-numbers [-h] [-T | -S | -b] [-V] [--debug] [--formulas]
-                   [--formatting] [-s SHEET] [-t TABLE] [document ...]
+usage: cat-numbers [-h] [-T | -S | -b] [-V] [--formulas] [--formatting]
+                  [-s SHEET] [-t TABLE] [--debug]
+                  [document ...]
 
 Export data from Apple Numbers spreadsheet tables
 
 positional arguments:
-  document                 Document(s) to export
-
-optional arguments:
-  -h, --help               show this help message and exit
-  -T, --list-tables        List the names of tables and exit
-  -S, --list-sheets        List the names of sheets and exit
-  -b, --brief              Don't prefix data rows with name of sheet/table (default: false)
+  document              Document(s) to export
+
+options:
+  -h, --help            show this help message and exit
+  -T, --list-tables     List the names of tables and exit
+  -S, --list-sheets     List the names of sheets and exit
+  -b, --brief           Don't prefix data rows with name of sheet/table
+                        (default: false)
   -V, --version
-  --debug                  Enable debug output
-  --formulas               Dump formulas instead of formula results
-  --formatting             Dump formatted cells (durations) as they appear in Numbers
-  -s SHEET, --sheet SHEET  Names of sheet(s) to include in export
-  -t TABLE, --table TABLE  Names of table(s) to include in export
+  --formulas            Dump formulas instead of formula results
+  --formatting          Dump formatted cells (durations) as they appear
+                        in Numbers
+  -s SHEET, --sheet SHEET
+                        Names of sheet(s) to include in export
+  -t TABLE, --table TABLE
+                        Names of table(s) to include in export
+  --debug               Enable debug logging
 ```
 
 Note: `--formatting` will return different capitalization for 12-hour
@@ -328,10 +355,6 @@ Current known limitations of `numbers-parser` are:
   worksheet which does not take into account title or caption size
 - New sheets insert tables with formats copied from the first table in
   the previous sheet rather than default table formats
-- Creating custom cell formats and cell data formats is experimental
-  and not all formats are supported. See
-  [Table.set_cell_formatting](https://masaccio.github.io/numbers-parser/#numbers_parser.Table.set_cell_formatting)
-  for more details.
 - Due to a limitation in Python’s
   [ZipFile](https://docs.python.org/3/library/zipfile.html), Python
   versions older than 3.11 do not support image filenames with UTF-8
@@ -343,5 +366,4 @@ Current known limitations of `numbers-parser` are:
 
 ## License
 
-All code in this repository is licensed under the [MIT
-License](https://github.com/masaccio/numbers-parser/blob/master/LICENSE.rst)
+All code in this repository is licensed under the [MIT License](https://github.com/masaccio/numbers-parser/blob/master/LICENSE.rst).

{numbers_parser-4.8.0 → numbers_parser-4.9.0}/pyproject.toml

@@ -12,7 +12,7 @@ name = "numbers-parser"
 packages = [{include = "numbers_parser", from = "src"}]
 readme = "README.md"
 repository = "https://github.com/masaccio/numbers-parser"
-version = "4.8.0"
+version = "4.9.0"
 
 [tool.poetry.scripts]
 cat-numbers = "numbers_parser._cat_numbers:main"
@@ -53,6 +53,7 @@ enum-tools = "^0.11.0"
 sphinx-toolbox = "^3.5.0"
 sphinx-nefertiti = "^0.2.1"
 sphinx-markdown-builder = "^0.6.6"
+sphinx-copybutton = "^0.5.2"
 
 [build-system]
 build-backend = "poetry.core.masonry.api"