ascii-art-python 1.2.0__tar.gz → 1.2.1__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.
Files changed (20) hide show
  1. {ascii_art_python-1.2.0/ascii_art_python.egg-info → ascii_art_python-1.2.1}/PKG-INFO +36 -1
  2. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/README.md +35 -0
  3. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/__init__.py +1 -1
  4. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1/ascii_art_python.egg-info}/PKG-INFO +36 -1
  5. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/pyproject.toml +1 -1
  6. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/LICENSE +0 -0
  7. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/MANIFEST.in +0 -0
  8. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/ascii_base.py +0 -0
  9. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/assets/fonts/GoogleSansCode-Regular.ttf +0 -0
  10. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/assets/fonts/KreativeSquareSM.ttf +0 -0
  11. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/cli.py +0 -0
  12. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/full_mode.py +0 -0
  13. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/new_skool.py +0 -0
  14. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python/old_skool.py +0 -0
  15. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python.egg-info/SOURCES.txt +0 -0
  16. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python.egg-info/dependency_links.txt +0 -0
  17. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python.egg-info/entry_points.txt +0 -0
  18. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python.egg-info/requires.txt +0 -0
  19. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/ascii_art_python.egg-info/top_level.txt +0 -0
  20. {ascii_art_python-1.2.0 → ascii_art_python-1.2.1}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ascii_art_python
3
- Version: 1.2.0
3
+ Version: 1.2.1
4
4
  Summary: A Python library and CLI tool for converting images and videos into ASCII art.
5
5
  Author-email: Guillem Prieur <prieurguillem38@gmail.com>
6
6
  Project-URL: Homepage, https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
@@ -88,6 +88,7 @@ This module provides advanced tools for converting classic images and videos int
88
88
  - Video to ASCII animation with sound extraction.
89
89
  - Play video directly in the terminal.
90
90
  - Export to `.txt`, `.png`, `.mp4`, or `.avi`.
91
+ - A command-line interface that allows you to do everything listed above.
91
92
 
92
93
  ## 📦 Installation
93
94
 
@@ -112,6 +113,40 @@ import ascii_art_python as aap
112
113
  - `aap.old_skool`: An edge-detection based ASCII style using Canny/Sobel filters to draw contours with line characters (`-`, `/`, `\`, `|`).
113
114
  - `aap.full_mode`: A hybrid approach combining edge-detection for sharp contours and density-based characters for shading.
114
115
 
116
+ ## >_ Command-Line Interface
117
+
118
+ ### 1. Create and export an image or video as ASCII art
119
+
120
+ Here is the command and its parameters:
121
+
122
+ ```bash
123
+ aap-export [OPTIONS] SOURCE_PATH TARGET_FILENAME
124
+ ```
125
+
126
+ Here are the options:
127
+
128
+ | Option | Description |
129
+ |----------------------|----------------------------------------|
130
+ | -l, --length INTEGER | The number of characters in the output |
131
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
132
+ | --help | Show help message and exit. |
133
+
134
+ ### 2. Create and print an image or video as ASCII art into the terminal
135
+
136
+ Here is the command and its parameters:
137
+
138
+ ```bash
139
+ aap-echo [OPTIONS] SOURCE_PATH
140
+ ```
141
+
142
+ Here are the options:
143
+
144
+ | Option | Description |
145
+ |----------------------|----------------------------------------|
146
+ | -l, --length INTEGER | The number of characters in the output |
147
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
148
+ | --help | Show help message and exit. |
149
+
115
150
  ## 📚 API Reference
116
151
 
117
152
  ### 1. Enumerations (Enums)
@@ -51,6 +51,7 @@ This module provides advanced tools for converting classic images and videos int
51
51
  - Video to ASCII animation with sound extraction.
52
52
  - Play video directly in the terminal.
53
53
  - Export to `.txt`, `.png`, `.mp4`, or `.avi`.
54
+ - A command-line interface that allows you to do everything listed above.
54
55
 
55
56
  ## 📦 Installation
56
57
 
@@ -75,6 +76,40 @@ import ascii_art_python as aap
75
76
  - `aap.old_skool`: An edge-detection based ASCII style using Canny/Sobel filters to draw contours with line characters (`-`, `/`, `\`, `|`).
76
77
  - `aap.full_mode`: A hybrid approach combining edge-detection for sharp contours and density-based characters for shading.
77
78
 
79
+ ## >_ Command-Line Interface
80
+
81
+ ### 1. Create and export an image or video as ASCII art
82
+
83
+ Here is the command and its parameters:
84
+
85
+ ```bash
86
+ aap-export [OPTIONS] SOURCE_PATH TARGET_FILENAME
87
+ ```
88
+
89
+ Here are the options:
90
+
91
+ | Option | Description |
92
+ |----------------------|----------------------------------------|
93
+ | -l, --length INTEGER | The number of characters in the output |
94
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
95
+ | --help | Show help message and exit. |
96
+
97
+ ### 2. Create and print an image or video as ASCII art into the terminal
98
+
99
+ Here is the command and its parameters:
100
+
101
+ ```bash
102
+ aap-echo [OPTIONS] SOURCE_PATH
103
+ ```
104
+
105
+ Here are the options:
106
+
107
+ | Option | Description |
108
+ |----------------------|----------------------------------------|
109
+ | -l, --length INTEGER | The number of characters in the output |
110
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
111
+ | --help | Show help message and exit. |
112
+
78
113
  ## 📚 API Reference
79
114
 
80
115
  ### 1. Enumerations (Enums)
@@ -1,7 +1,7 @@
1
1
  """
2
2
  Module from https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
3
3
  """
4
- __version__ = "1.2.0"
4
+ __version__ = "1.2.1"
5
5
  from . import new_skool
6
6
  from . import old_skool
7
7
  from . import full_mode
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ascii_art_python
3
- Version: 1.2.0
3
+ Version: 1.2.1
4
4
  Summary: A Python library and CLI tool for converting images and videos into ASCII art.
5
5
  Author-email: Guillem Prieur <prieurguillem38@gmail.com>
6
6
  Project-URL: Homepage, https://gitlab.pprriieeuurr.fr/guill_prieur/ascii-art-python
@@ -88,6 +88,7 @@ This module provides advanced tools for converting classic images and videos int
88
88
  - Video to ASCII animation with sound extraction.
89
89
  - Play video directly in the terminal.
90
90
  - Export to `.txt`, `.png`, `.mp4`, or `.avi`.
91
+ - A command-line interface that allows you to do everything listed above.
91
92
 
92
93
  ## 📦 Installation
93
94
 
@@ -112,6 +113,40 @@ import ascii_art_python as aap
112
113
  - `aap.old_skool`: An edge-detection based ASCII style using Canny/Sobel filters to draw contours with line characters (`-`, `/`, `\`, `|`).
113
114
  - `aap.full_mode`: A hybrid approach combining edge-detection for sharp contours and density-based characters for shading.
114
115
 
116
+ ## >_ Command-Line Interface
117
+
118
+ ### 1. Create and export an image or video as ASCII art
119
+
120
+ Here is the command and its parameters:
121
+
122
+ ```bash
123
+ aap-export [OPTIONS] SOURCE_PATH TARGET_FILENAME
124
+ ```
125
+
126
+ Here are the options:
127
+
128
+ | Option | Description |
129
+ |----------------------|----------------------------------------|
130
+ | -l, --length INTEGER | The number of characters in the output |
131
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
132
+ | --help | Show help message and exit. |
133
+
134
+ ### 2. Create and print an image or video as ASCII art into the terminal
135
+
136
+ Here is the command and its parameters:
137
+
138
+ ```bash
139
+ aap-echo [OPTIONS] SOURCE_PATH
140
+ ```
141
+
142
+ Here are the options:
143
+
144
+ | Option | Description |
145
+ |----------------------|----------------------------------------|
146
+ | -l, --length INTEGER | The number of characters in the output |
147
+ | -m, --mode TEXT | full_mode / old_skool / new_skool |
148
+ | --help | Show help message and exit. |
149
+
115
150
  ## 📚 API Reference
116
151
 
117
152
  ### 1. Enumerations (Enums)
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "ascii_art_python"
7
- version = "1.2.0"
7
+ version = "1.2.1"
8
8
  authors = [
9
9
  { name="Guillem Prieur", email="prieurguillem38@gmail.com" },
10
10
  ]