tocs 1.0.2__tar.gz → 1.0.4__tar.gz

{tocs-1.0.2 → tocs-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tocs
-Version: 1.0.2
+Version: 1.0.4
 Summary: Generate TOC for markdown files
 Author-email: Andrea Bondanini <bondaniniandrea@gmail.com>
 License: MIT
@@ -17,37 +17,34 @@ Requires-Dist: black; extra == "dev"
 Dynamic: license-file
 
 # tocs
+[![PyPI](https://img.shields.io/pypi/v/tocs)](https://pypi.org/project/tocs/)
+
 **tocs** is a simple CLI application written in Python that generates **the table of contents (TOC)** section for markdown files.<br>
 As a person who loves to write personal technical notes in markdown files, I needed something simple to use.
 
 ## How to install and use tocs
-**Prerequisites:** Python 3.11.9+ and pipx installed (`pip install pipx`).
+**Prerequisites:** Python 3.11.9+
+
+### Installation
+```bash
+pip install tocs
+```
 
-At the moment only a **manual installation** is available:
-- clone the repository
-- from the root of the repository: `pipx install .`
-- to upgrade tocs version: `pipx upgrade tocs`
+### Update
+```bash
+pip install --upgrade tocs
+```
 
-**Basic usage:**<br>
+### Basic usage:
 - `tocs input_file.md` - Generate TOC for the file
+- `tocs --depth 2 input_file.md` - Limit the TOC generation to headers up to a specified depth
+- `tocs --dry-run input_file.md` - Preview TOC without modifying the file
 - `tocs --help` - Show usage instructions
 - `tocs --version` - Display version information
 
 ### tocs example
 Given the following markdown file **input_file.md**:
 ```md
-# header 1
-Lorem ipsum dolor sit amet...
-
-## header 2
-Lorem ipsum dolor sit amet...
-
-### header 3
-Lorem ipsum dolor sit amet...
-```
-
-Add two tags where you want the TOCs table:
-```md
 <!-- init-tocs -->
 <!-- end-tocs -->
 

{tocs-1.0.2 → tocs-1.0.4}/README.md

@@ -1,35 +1,32 @@
 # tocs
+[![PyPI](https://img.shields.io/pypi/v/tocs)](https://pypi.org/project/tocs/)
+
 **tocs** is a simple CLI application written in Python that generates **the table of contents (TOC)** section for markdown files.<br>
 As a person who loves to write personal technical notes in markdown files, I needed something simple to use.
 
 ## How to install and use tocs
-**Prerequisites:** Python 3.11.9+ and pipx installed (`pip install pipx`).
+**Prerequisites:** Python 3.11.9+
+
+### Installation
+```bash
+pip install tocs
+```
 
-At the moment only a **manual installation** is available:
-- clone the repository
-- from the root of the repository: `pipx install .`
-- to upgrade tocs version: `pipx upgrade tocs`
+### Update
+```bash
+pip install --upgrade tocs
+```
 
-**Basic usage:**<br>
+### Basic usage:
 - `tocs input_file.md` - Generate TOC for the file
+- `tocs --depth 2 input_file.md` - Limit the TOC generation to headers up to a specified depth
+- `tocs --dry-run input_file.md` - Preview TOC without modifying the file
 - `tocs --help` - Show usage instructions
 - `tocs --version` - Display version information
 
 ### tocs example
 Given the following markdown file **input_file.md**:
 ```md
-# header 1
-Lorem ipsum dolor sit amet...
-
-## header 2
-Lorem ipsum dolor sit amet...
-
-### header 3
-Lorem ipsum dolor sit amet...
-```
-
-Add two tags where you want the TOCs table:
-```md
 <!-- init-tocs -->
 <!-- end-tocs -->
 

{tocs-1.0.2 → tocs-1.0.4}/pyproject.toml

@@ -3,7 +3,7 @@ name = "tocs"
 description = "Generate TOC for markdown files"
 authors = [{ name = "Andrea Bondanini", email = "bondaniniandrea@gmail.com" }]
 license = { text = "MIT" }
-version = "1.0.2"
+version = "1.0.4"
 requires-python = ">=3.11.9"
 readme = "README.md"
 keywords = ["markdown", "tocs", "cli", "documentation", "generator"]

{tocs-1.0.2 → tocs-1.0.4}/tocs/main.py

@@ -114,7 +114,7 @@ def main():
     parser.add_argument(
         "--depth", type=int, help="Maximum header depth to include in TOC"
     )
-    parser.add_argument("--version", action="version", version="tocs 1.0.2")
+    parser.add_argument("--version", action="version", version="tocs 1.0.4")
     args = parser.parse_args()
     path = Path(args.file).resolve()
 

{tocs-1.0.2 → tocs-1.0.4}/tocs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tocs
-Version: 1.0.2
+Version: 1.0.4
 Summary: Generate TOC for markdown files
 Author-email: Andrea Bondanini <bondaniniandrea@gmail.com>
 License: MIT
@@ -17,37 +17,34 @@ Requires-Dist: black; extra == "dev"
 Dynamic: license-file
 
 # tocs
+[![PyPI](https://img.shields.io/pypi/v/tocs)](https://pypi.org/project/tocs/)
+
 **tocs** is a simple CLI application written in Python that generates **the table of contents (TOC)** section for markdown files.<br>
 As a person who loves to write personal technical notes in markdown files, I needed something simple to use.
 
 ## How to install and use tocs
-**Prerequisites:** Python 3.11.9+ and pipx installed (`pip install pipx`).
+**Prerequisites:** Python 3.11.9+
+
+### Installation
+```bash
+pip install tocs
+```
 
-At the moment only a **manual installation** is available:
-- clone the repository
-- from the root of the repository: `pipx install .`
-- to upgrade tocs version: `pipx upgrade tocs`
+### Update
+```bash
+pip install --upgrade tocs
+```
 
-**Basic usage:**<br>
+### Basic usage:
 - `tocs input_file.md` - Generate TOC for the file
+- `tocs --depth 2 input_file.md` - Limit the TOC generation to headers up to a specified depth
+- `tocs --dry-run input_file.md` - Preview TOC without modifying the file
 - `tocs --help` - Show usage instructions
 - `tocs --version` - Display version information
 
 ### tocs example
 Given the following markdown file **input_file.md**:
 ```md
-# header 1
-Lorem ipsum dolor sit amet...
-
-## header 2
-Lorem ipsum dolor sit amet...
-
-### header 3
-Lorem ipsum dolor sit amet...
-```
-
-Add two tags where you want the TOCs table:
-```md
 <!-- init-tocs -->
 <!-- end-tocs -->