plotext-plus 1.0.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.
- plotext_plus-1.0.1/.gitignore +204 -0
- plotext_plus-1.0.1/LICENSE +23 -0
- plotext_plus-1.0.1/PKG-INFO +303 -0
- plotext_plus-1.0.1/README.md +263 -0
- plotext_plus-1.0.1/docs/api.md +149 -0
- plotext_plus-1.0.1/docs/aspect.md +127 -0
- plotext_plus-1.0.1/docs/bar.md +283 -0
- plotext_plus-1.0.1/docs/basic.md +258 -0
- plotext_plus-1.0.1/docs/chart_classes.md +405 -0
- plotext_plus-1.0.1/docs/datetime.md +110 -0
- plotext_plus-1.0.1/docs/decorator.md +128 -0
- plotext_plus-1.0.1/docs/environments.md +281 -0
- plotext_plus-1.0.1/docs/image.md +76 -0
- plotext_plus-1.0.1/docs/mcp-server.md +943 -0
- plotext_plus-1.0.1/docs/notes.md +211 -0
- plotext_plus-1.0.1/docs/settings.md +84 -0
- plotext_plus-1.0.1/docs/special.md +209 -0
- plotext_plus-1.0.1/docs/subplots.md +87 -0
- plotext_plus-1.0.1/docs/themes.md +363 -0
- plotext_plus-1.0.1/docs/utilities.md +235 -0
- plotext_plus-1.0.1/docs/video.md +90 -0
- plotext_plus-1.0.1/examples/advanced_features.py +153 -0
- plotext_plus-1.0.1/examples/basic_plots.py +116 -0
- plotext_plus-1.0.1/examples/chart_classes_demo.py +301 -0
- plotext_plus-1.0.1/examples/interactive_demo.py +828 -0
- plotext_plus-1.0.1/examples/theme_showcase_demo.py +305 -0
- plotext_plus-1.0.1/pyproject.toml +76 -0
- plotext_plus-1.0.1/src/plotext_plus/__init__.py +31 -0
- plotext_plus-1.0.1/src/plotext_plus/__main__.py +2 -0
- plotext_plus-1.0.1/src/plotext_plus/_api.py +828 -0
- plotext_plus-1.0.1/src/plotext_plus/_build.py +270 -0
- plotext_plus-1.0.1/src/plotext_plus/_core.py +581 -0
- plotext_plus-1.0.1/src/plotext_plus/_date.py +60 -0
- plotext_plus-1.0.1/src/plotext_plus/_default.py +83 -0
- plotext_plus-1.0.1/src/plotext_plus/_dict.py +210 -0
- plotext_plus-1.0.1/src/plotext_plus/_doc.py +707 -0
- plotext_plus-1.0.1/src/plotext_plus/_doc_utils.py +291 -0
- plotext_plus-1.0.1/src/plotext_plus/_figure.py +488 -0
- plotext_plus-1.0.1/src/plotext_plus/_global.py +370 -0
- plotext_plus-1.0.1/src/plotext_plus/_matrix.py +171 -0
- plotext_plus-1.0.1/src/plotext_plus/_monitor.py +848 -0
- plotext_plus-1.0.1/src/plotext_plus/_output.py +136 -0
- plotext_plus-1.0.1/src/plotext_plus/_shtab.py +9 -0
- plotext_plus-1.0.1/src/plotext_plus/_themes.py +343 -0
- plotext_plus-1.0.1/src/plotext_plus/_utility.py +853 -0
- plotext_plus-1.0.1/src/plotext_plus/api.py +828 -0
- plotext_plus-1.0.1/src/plotext_plus/charts.py +42 -0
- plotext_plus-1.0.1/src/plotext_plus/core.py +581 -0
- plotext_plus-1.0.1/src/plotext_plus/mcp_cli.py +79 -0
- plotext_plus-1.0.1/src/plotext_plus/mcp_server.py +505 -0
- plotext_plus-1.0.1/src/plotext_plus/plotext_cli.py +375 -0
- plotext_plus-1.0.1/src/plotext_plus/plotting.py +92 -0
- plotext_plus-1.0.1/src/plotext_plus/themes.py +29 -0
- plotext_plus-1.0.1/src/plotext_plus/utilities.py +52 -0
- plotext_plus-1.0.1/src/plotext_plus/utils.py +370 -0
- plotext_plus-1.0.1/tests/__init__.py +1 -0
- plotext_plus-1.0.1/tests/test_chart_classes.py +201 -0
- plotext_plus-1.0.1/tests/test_image_video.py +165 -0
- plotext_plus-1.0.1/tests/test_integration.py +66 -0
- plotext_plus-1.0.1/tests/test_new_api.py +171 -0
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.so
|
|
6
|
+
.Python
|
|
7
|
+
build/
|
|
8
|
+
develop-eggs/
|
|
9
|
+
dist/
|
|
10
|
+
downloads/
|
|
11
|
+
eggs/
|
|
12
|
+
.eggs/
|
|
13
|
+
lib/
|
|
14
|
+
lib64/
|
|
15
|
+
parts/
|
|
16
|
+
sdist/
|
|
17
|
+
var/
|
|
18
|
+
wheels/
|
|
19
|
+
share/python-wheels/
|
|
20
|
+
*.egg-info/
|
|
21
|
+
.installed.cfg
|
|
22
|
+
*.egg
|
|
23
|
+
MANIFEST
|
|
24
|
+
|
|
25
|
+
# PyInstaller
|
|
26
|
+
*.manifest
|
|
27
|
+
*.spec
|
|
28
|
+
|
|
29
|
+
# Installer logs
|
|
30
|
+
pip-log.txt
|
|
31
|
+
pip-delete-this-directory.txt
|
|
32
|
+
|
|
33
|
+
# Unit test / coverage reports
|
|
34
|
+
htmlcov/
|
|
35
|
+
.tox/
|
|
36
|
+
.nox/
|
|
37
|
+
.coverage
|
|
38
|
+
.coverage.*
|
|
39
|
+
.cache
|
|
40
|
+
nosetests.xml
|
|
41
|
+
coverage.xml
|
|
42
|
+
*.cover
|
|
43
|
+
*.py,cover
|
|
44
|
+
.hypothesis/
|
|
45
|
+
.pytest_cache/
|
|
46
|
+
cover/
|
|
47
|
+
|
|
48
|
+
# Translations
|
|
49
|
+
*.mo
|
|
50
|
+
*.pot
|
|
51
|
+
|
|
52
|
+
# Django stuff:
|
|
53
|
+
*.log
|
|
54
|
+
local_settings.py
|
|
55
|
+
db.sqlite3
|
|
56
|
+
db.sqlite3-journal
|
|
57
|
+
|
|
58
|
+
# Flask stuff:
|
|
59
|
+
instance/
|
|
60
|
+
.webassets-cache
|
|
61
|
+
|
|
62
|
+
# Scrapy stuff:
|
|
63
|
+
.scrapy
|
|
64
|
+
|
|
65
|
+
# Sphinx documentation
|
|
66
|
+
docs/_build/
|
|
67
|
+
|
|
68
|
+
# PyBuilder
|
|
69
|
+
.pybuilder/
|
|
70
|
+
target/
|
|
71
|
+
|
|
72
|
+
# Jupyter Notebook
|
|
73
|
+
.ipynb_checkpoints
|
|
74
|
+
|
|
75
|
+
# IPython
|
|
76
|
+
profile_default/
|
|
77
|
+
ipython_config.py
|
|
78
|
+
|
|
79
|
+
# pyenv
|
|
80
|
+
.python-version
|
|
81
|
+
|
|
82
|
+
# pipenv
|
|
83
|
+
Pipfile.lock
|
|
84
|
+
|
|
85
|
+
# poetry
|
|
86
|
+
poetry.lock
|
|
87
|
+
|
|
88
|
+
# pdm
|
|
89
|
+
.pdm.toml
|
|
90
|
+
|
|
91
|
+
# PEP 582
|
|
92
|
+
__pypackages__/
|
|
93
|
+
|
|
94
|
+
# Celery stuff
|
|
95
|
+
celerybeat-schedule
|
|
96
|
+
celerybeat.pid
|
|
97
|
+
|
|
98
|
+
# SageMath parsed files
|
|
99
|
+
*.sage.py
|
|
100
|
+
|
|
101
|
+
# Environments
|
|
102
|
+
.env
|
|
103
|
+
.venv
|
|
104
|
+
env/
|
|
105
|
+
venv/
|
|
106
|
+
ENV/
|
|
107
|
+
env.bak/
|
|
108
|
+
venv.bak/
|
|
109
|
+
|
|
110
|
+
# Spyder project settings
|
|
111
|
+
.spyderproject
|
|
112
|
+
.spyproject
|
|
113
|
+
|
|
114
|
+
# Rope project settings
|
|
115
|
+
.ropeproject
|
|
116
|
+
|
|
117
|
+
# mkdocs documentation
|
|
118
|
+
/site
|
|
119
|
+
|
|
120
|
+
# mypy
|
|
121
|
+
.mypy_cache/
|
|
122
|
+
.dmypy.json
|
|
123
|
+
dmypy.json
|
|
124
|
+
|
|
125
|
+
# Pyre type checker
|
|
126
|
+
.pyre/
|
|
127
|
+
|
|
128
|
+
# pytype static type analyzer
|
|
129
|
+
.pytype/
|
|
130
|
+
|
|
131
|
+
# Cython debug symbols
|
|
132
|
+
cython_debug/
|
|
133
|
+
|
|
134
|
+
# UV (Modern Python Package Manager)
|
|
135
|
+
.uv/
|
|
136
|
+
# Note: uv.lock should be committed for reproducible builds
|
|
137
|
+
|
|
138
|
+
# IDE
|
|
139
|
+
.vscode/
|
|
140
|
+
.idea/
|
|
141
|
+
*.swp
|
|
142
|
+
*.swo
|
|
143
|
+
*~
|
|
144
|
+
.#*
|
|
145
|
+
\#*
|
|
146
|
+
|
|
147
|
+
# macOS
|
|
148
|
+
.DS_Store
|
|
149
|
+
.AppleDouble
|
|
150
|
+
.LSOverride
|
|
151
|
+
Icon?
|
|
152
|
+
._*
|
|
153
|
+
|
|
154
|
+
# Windows
|
|
155
|
+
Thumbs.db
|
|
156
|
+
ehthumbs.db
|
|
157
|
+
Desktop.ini
|
|
158
|
+
$RECYCLE.BIN/
|
|
159
|
+
*.cab
|
|
160
|
+
*.msi
|
|
161
|
+
*.msix
|
|
162
|
+
*.msm
|
|
163
|
+
*.msp
|
|
164
|
+
*.lnk
|
|
165
|
+
|
|
166
|
+
# Linux
|
|
167
|
+
*~
|
|
168
|
+
.fuse_hidden*
|
|
169
|
+
.directory
|
|
170
|
+
.Trash-*
|
|
171
|
+
.nfs*
|
|
172
|
+
|
|
173
|
+
# Project specific
|
|
174
|
+
examples/output/
|
|
175
|
+
*.png
|
|
176
|
+
*.jpg
|
|
177
|
+
*.gif
|
|
178
|
+
*.mp4
|
|
179
|
+
*.avi
|
|
180
|
+
*.mov
|
|
181
|
+
temp/
|
|
182
|
+
tmp/
|
|
183
|
+
|
|
184
|
+
# Temporary test files (not official tests)
|
|
185
|
+
/test_*.py
|
|
186
|
+
test_banner_width_fix.py
|
|
187
|
+
test_comprehensive.py
|
|
188
|
+
test_output/
|
|
189
|
+
|
|
190
|
+
# Documentation builds
|
|
191
|
+
docs/build/
|
|
192
|
+
docs/_build/
|
|
193
|
+
|
|
194
|
+
# Backup files
|
|
195
|
+
*.bak
|
|
196
|
+
*.backup
|
|
197
|
+
*.orig
|
|
198
|
+
|
|
199
|
+
# Log files
|
|
200
|
+
*.log
|
|
201
|
+
|
|
202
|
+
# Temporary files
|
|
203
|
+
.tmp/
|
|
204
|
+
.temp/
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) [2025] [Christopher C. Mitchell]
|
|
4
|
+
Copyright (c) [2021] [Savino Piccolomo] Original plotext library
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
23
|
+
|
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: plotext_plus
|
|
3
|
+
Version: 1.0.1
|
|
4
|
+
Summary: Modern terminal plotting library with enhanced visual features, themes, and AI integration
|
|
5
|
+
Project-URL: Homepage, https://github.com/ccmitchellusa/plotext_plus
|
|
6
|
+
Project-URL: Repository, https://github.com/ccmitchellusa/plotext_plus.git
|
|
7
|
+
Project-URL: Issues, https://github.com/ccmitchellusa/plotext_plus/issues
|
|
8
|
+
Project-URL: Documentation, https://github.com/ccmitchellusa/plotext_plus/tree/main/docs
|
|
9
|
+
Author-email: Chris Mitchell <chris@ccmitchellusa.com>
|
|
10
|
+
License-Expression: MIT
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: ai,charts,cli,graphs,mcp,plotting,terminal,visualization
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Intended Audience :: Science/Research
|
|
16
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Scientific/Engineering :: Visualization
|
|
23
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
24
|
+
Classifier: Topic :: Terminals
|
|
25
|
+
Requires-Python: >=3.11
|
|
26
|
+
Requires-Dist: chuk-term>=0.1.0
|
|
27
|
+
Provides-Extra: completion
|
|
28
|
+
Requires-Dist: shtab; extra == 'completion'
|
|
29
|
+
Provides-Extra: image
|
|
30
|
+
Requires-Dist: pillow>=8.4; extra == 'image'
|
|
31
|
+
Provides-Extra: mcp
|
|
32
|
+
Requires-Dist: chuk-mcp-server>=0.2.3; extra == 'mcp'
|
|
33
|
+
Provides-Extra: video
|
|
34
|
+
Requires-Dist: ffpyplayer>=4.3.5; extra == 'video'
|
|
35
|
+
Requires-Dist: opencv-python>=4.5.5; extra == 'video'
|
|
36
|
+
Requires-Dist: pafy>=0.5.5; extra == 'video'
|
|
37
|
+
Requires-Dist: pillow>=8.4; extra == 'video'
|
|
38
|
+
Requires-Dist: youtube-dl==2020.12.2; extra == 'video'
|
|
39
|
+
Description-Content-Type: text/markdown
|
|
40
|
+
|
|
41
|
+
# ๐ Plotext+ - Modern Terminal Plotting
|
|
42
|
+
|
|
43
|
+
[](https://badge.fury.io/py/plotext_plus)
|
|
44
|
+
[](https://github.com/ccmitchellusa/plotext_plus/stargazers)
|
|
45
|
+
[](https://pepy.tech/project/plotext_plus)
|
|
46
|
+
[](https://github.com/ccmitchellusa/plotext_plus/issues)
|
|
47
|
+
[](https://github.com/ccmitchellusa/plotext_plus/pulls)
|
|
48
|
+
|
|
49
|
+

|
|
50
|
+
|
|
51
|
+
**Plotext+ plots directly in your terminal** with stunning visuals, modern APIs, and professional styling. Plotext+ is a redesigned version of the original [plotext](https://github.com/piccolomo/plotext) library by Savino Piccolomo. New features include an updated API with object oriented features, an MCP server to make the project easily usable with AI & LLM scenarios, new themes and integration with chuk-term to make sure it works in the awesome [mcp-cli](https://github.com/chrishayuk/mcp-cli) by Chris Hay.
|
|
52
|
+
|
|
53
|
+
## โจ Key Features
|
|
54
|
+
|
|
55
|
+
๐ฏ **Multiple Plot Types**: [scatter](docs/basic.md#scatter-plot), [line](docs/basic.md#line-plot), [bar](docs/bar.md), [histogram](docs/bar.md#histogram-plot), [candlestick](docs/datetime.md#candlestick-plot), [heatmap](docs/special.md), [confusion matrix](docs/special.md#confusion-matrix), and more
|
|
56
|
+
|
|
57
|
+
๐จ **Rich Visuals**: [Banner mode](docs/chart_classes.md), [themes](docs/themes.md), [colored text](docs/utilities.md#colored-text), automatic terminal width detection
|
|
58
|
+
|
|
59
|
+
๐ **Advanced Features**: [Subplots](docs/subplots.md), [datetime plots](docs/datetime.md), [image/GIF display](docs/image.md), [video streaming](docs/video.md) (including YouTube)
|
|
60
|
+
|
|
61
|
+
๐ง **Modern APIs**: Clean public API, object-oriented charts, quick functions, 100% backward compatible
|
|
62
|
+
|
|
63
|
+
๐ค **AI Integration**: [MCP server](docs/mcp-server.md) for direct AI client access (Claude, etc.)
|
|
64
|
+
|
|
65
|
+
โก **Zero Dependencies**: No required dependencies (optional packages for multimedia and AI integration)
|
|
66
|
+
|
|
67
|
+

|
|
68
|
+
|
|
69
|
+
## ๐ Quick Start
|
|
70
|
+
|
|
71
|
+
### Installation
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
# Modern Python package management
|
|
75
|
+
uv add plotext_plus
|
|
76
|
+
|
|
77
|
+
# Traditional installation
|
|
78
|
+
pip install plotext_plus
|
|
79
|
+
|
|
80
|
+
# With optional dependencies
|
|
81
|
+
pip install plotext_plus[image,video] # Multimedia support
|
|
82
|
+
pip install plotext_plus[mcp] # AI integration (MCP server)
|
|
83
|
+
pip install plotext_plus[image,video,mcp] # All features
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Basic Usage
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
import plotext_plus as plt
|
|
90
|
+
|
|
91
|
+
# Simple scatter plot
|
|
92
|
+
plt.scatter([1, 2, 3, 4], [1, 4, 9, 16])
|
|
93
|
+
plt.title("My First Plot")
|
|
94
|
+
plt.show()
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Enhanced Visual Styling โจ
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
import plotext_plus as plt
|
|
101
|
+
|
|
102
|
+
# Enable beautiful banner mode
|
|
103
|
+
plt.banner_mode(True, "๐ Data Analysis Dashboard")
|
|
104
|
+
|
|
105
|
+
# Apply professional themes
|
|
106
|
+
plt.theme('professional')
|
|
107
|
+
|
|
108
|
+
# Create styled plot
|
|
109
|
+
plt.plot([1, 2, 3, 4], [1, 4, 2, 3], label="Data Series")
|
|
110
|
+
plt.title("Enhanced Line Plot")
|
|
111
|
+
plt.xlabel("Time")
|
|
112
|
+
plt.ylabel("Values")
|
|
113
|
+
plt.show()
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Modern Chart Classes ๐ฏ
|
|
117
|
+
|
|
118
|
+
```python
|
|
119
|
+
import plotext_plus as plt
|
|
120
|
+
|
|
121
|
+
# Object-oriented chart creation with method chaining
|
|
122
|
+
chart = (plt.ScatterChart([1, 2, 3, 4], [1, 4, 9, 16])
|
|
123
|
+
.title("Scientific Analysis")
|
|
124
|
+
.xlabel("X Variable")
|
|
125
|
+
.ylabel("Y Variable")
|
|
126
|
+
.color('blue')
|
|
127
|
+
.show())
|
|
128
|
+
|
|
129
|
+
# Quick one-liner plots
|
|
130
|
+
plt.quick_scatter(x_data, y_data, title="Quick Analysis")
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Public API ๐ง
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
import plotext_plus as plt
|
|
137
|
+
|
|
138
|
+
# Access organized functionality
|
|
139
|
+
plt.plotting.bar(categories, values) # Main plotting functions
|
|
140
|
+
plt.themes.apply_theme('dark_mode') # Theme management
|
|
141
|
+
plt.utilities.log_success("Plot ready!") # Helper utilities
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### AI Integration ๐ค
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
# Install with MCP (Model Context Protocol) support
|
|
148
|
+
pip install plotext_plus[mcp]
|
|
149
|
+
|
|
150
|
+
# Start the MCP server for AI clients like Claude
|
|
151
|
+
plotext-mcp
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**Use with Claude Desktop**: Add to your `claude_desktop_config.json`:
|
|
155
|
+
|
|
156
|
+
```json
|
|
157
|
+
{
|
|
158
|
+
"mcpServers": {
|
|
159
|
+
"plotext-plus": {
|
|
160
|
+
"command": "plotext-mcp",
|
|
161
|
+
"args": [],
|
|
162
|
+
"env": {}
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Now AI clients can create plots directly:
|
|
169
|
+
|
|
170
|
+
```text
|
|
171
|
+
"Create a scatter plot showing x=[1,2,3,4,5] vs y=[1,4,9,16,25] with title 'Quadratic Function'"
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## ๐๏ธ Architecture & API
|
|
175
|
+
|
|
176
|
+
### Public API Structure
|
|
177
|
+
|
|
178
|
+
```python
|
|
179
|
+
# ๐ฏ Main Modules (Public API - no underscores)
|
|
180
|
+
plotext_plus.plotting # Core plotting functions
|
|
181
|
+
plotext_plus.charts # Object-oriented chart classes
|
|
182
|
+
plotext_plus.themes # Theme and styling system
|
|
183
|
+
plotext_plus.utilities # Helper functions and tools
|
|
184
|
+
|
|
185
|
+
# ๐ Internal Modules (Private - with underscores)
|
|
186
|
+
plotext_plus._core # Internal implementation
|
|
187
|
+
plotext_plus._api # Internal API details
|
|
188
|
+
plotext_plus._themes # Theme internals
|
|
189
|
+
# ... other internal modules
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Project Structure
|
|
193
|
+
|
|
194
|
+
```bash
|
|
195
|
+
plotext_plus/
|
|
196
|
+
โโโ src/plotext_plus/ # Modern src-layout
|
|
197
|
+
โ โโโ plotting.py # ๐ฏ Main plotting functions (PUBLIC)
|
|
198
|
+
โ โโโ charts.py # ๐ฏ Chart classes (PUBLIC)
|
|
199
|
+
โ โโโ themes.py # ๐ฏ Theme system (PUBLIC)
|
|
200
|
+
โ โโโ utilities.py # ๐ฏ Utilities (PUBLIC)
|
|
201
|
+
โ โโโ _*.py # ๐ Internal modules (PRIVATE)
|
|
202
|
+
โโโ examples/ # Interactive demos
|
|
203
|
+
โ โโโ interactive_demo.py # Full interactive showcase
|
|
204
|
+
โ โโโ theme_showcase_demo.py # Theme comparison tool
|
|
205
|
+
โโโ tests/ # Test suites
|
|
206
|
+
โโโ docs/ # Comprehensive documentation
|
|
207
|
+
โโโ pyproject.toml # Modern packaging
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## ๐จ Enhanced Features
|
|
211
|
+
|
|
212
|
+
### ๐ญ Visual Enhancements
|
|
213
|
+
|
|
214
|
+
- **Professional Banners**: Automatic width detection and border styling
|
|
215
|
+
- **Advanced Theming**: Multiple built-in themes with chuk-term integration
|
|
216
|
+
- **Smart Layouts**: Charts automatically resize to fit terminal dimensions
|
|
217
|
+
- **Rich Colors**: 24-bit color support with automatic fallbacks
|
|
218
|
+
|
|
219
|
+
### ๐ Developer Experience
|
|
220
|
+
|
|
221
|
+
- **Clean API**: Public modules clearly separated from internals
|
|
222
|
+
- **Method Chaining**: Fluent interface for complex plot creation
|
|
223
|
+
- **Quick Functions**: One-liner plots for rapid prototyping
|
|
224
|
+
- **Type Safety**: Better IDE support and autocomplete
|
|
225
|
+
- **Zero Breaking Changes**: 100% backward compatibility guaranteed
|
|
226
|
+
|
|
227
|
+
## ๐งช Try It Now
|
|
228
|
+
|
|
229
|
+
```bash
|
|
230
|
+
# Install and run interactive demo
|
|
231
|
+
pip install plotext_plus
|
|
232
|
+
python -c "
|
|
233
|
+
import plotext_plus as plt
|
|
234
|
+
plt.banner_mode(True, '๐จ Plotext Plus Demo')
|
|
235
|
+
plt.scatter([1,2,3,4], [1,4,2,3], color='blue')
|
|
236
|
+
plt.title('Welcome to Plotext Plus!')
|
|
237
|
+
plt.show()
|
|
238
|
+
"
|
|
239
|
+
|
|
240
|
+
# Run comprehensive demos
|
|
241
|
+
git clone https://github.com/ccmitchellusa/plotext_plus.git
|
|
242
|
+
cd plotext_plus
|
|
243
|
+
python examples/interactive_demo.py # Full interactive showcase
|
|
244
|
+
python examples/theme_showcase_demo.py # Theme comparison
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## ๐ Complete Documentation
|
|
248
|
+
|
|
249
|
+
### ๐ฏ **Core Plotting**
|
|
250
|
+
|
|
251
|
+
- **[๐ Basic Plots](docs/basic.md)** - Scatter, line, and fundamental plotting
|
|
252
|
+
- **[๐ Bar Charts](docs/bar.md)** - Bar plots, histograms, and variations
|
|
253
|
+
- **[๐
DateTime Plots](docs/datetime.md)** - Time series and candlestick charts
|
|
254
|
+
- **[๐ฌ Special Plots](docs/special.md)** - Heatmaps, confusion matrices, error bars
|
|
255
|
+
- **[๐จ Decorator Plots](docs/decorator.md)** - Text, lines, and shape overlays
|
|
256
|
+
|
|
257
|
+
### ๐ผ๏ธ **Multimedia & Advanced**
|
|
258
|
+
|
|
259
|
+
- **[๐ผ๏ธ Image Plotting](docs/image.md)** - Display images and GIFs in terminal
|
|
260
|
+
- **[๐ฌ Video Streaming](docs/video.md)** - Play videos and YouTube content
|
|
261
|
+
- **[๐ Subplots](docs/subplots.md)** - Multiple plots and complex layouts
|
|
262
|
+
|
|
263
|
+
### โ๏ธ **Configuration & Styling**
|
|
264
|
+
|
|
265
|
+
- **[๐จ Themes](docs/themes.md)** - Built-in themes and customization
|
|
266
|
+
- **[โ๏ธ Settings](docs/settings.md)** - Plot configuration and options
|
|
267
|
+
- **[๐ Aspect](docs/aspect.md)** - Size, scaling, and layout control
|
|
268
|
+
- **[๐ง Chart Classes](docs/chart_classes.md)** - Object-oriented API reference
|
|
269
|
+
|
|
270
|
+
### ๐ ๏ธ **Tools & Integration**
|
|
271
|
+
|
|
272
|
+
- **[๐ง Utilities](docs/utilities.md)** - Helper functions and command-line tools
|
|
273
|
+
- **[๐ค MCP Server](docs/mcp-server.md)** - AI integration via Model Context Protocol
|
|
274
|
+
- **[๐ Environments](docs/environments.md)** - IDE and platform compatibility
|
|
275
|
+
- **[๐๏ธ API Structure](docs/api.md)** - Clean public API organization
|
|
276
|
+
- **[๐ Notes](docs/notes.md)** - Installation, tips, and troubleshooting
|
|
277
|
+
|
|
278
|
+
### ๐ **Getting Started Guides**
|
|
279
|
+
|
|
280
|
+
1. **[๐ Introduction](docs/basic.md#introduction)** - First steps with Plotext
|
|
281
|
+
2. **[๐ฆ Installation](docs/notes.md#install)** - Setup and dependencies
|
|
282
|
+
3. **[๐ฏ Quick Examples](#-quick-start)** - Jump right in with code samples
|
|
283
|
+
4. **[๐จ Theming Guide](docs/themes.md)** - Make your plots beautiful
|
|
284
|
+
5. **[๐ง Modern API Guide](docs/api.md)** - Use the clean public interface
|
|
285
|
+
|
|
286
|
+
## ๐ก Migration & Compatibility
|
|
287
|
+
|
|
288
|
+
**For Existing Users**: All your current code works unchanged! The new features are purely additive.
|
|
289
|
+
|
|
290
|
+
**For New Users**: Take advantage of the modern APIs and enhanced styling while learning the fundamentals.
|
|
291
|
+
|
|
292
|
+
```python
|
|
293
|
+
# โ
Your existing code still works
|
|
294
|
+
import plotext_plus as plt
|
|
295
|
+
plt.plot([1,2,3], [1,4,2])
|
|
296
|
+
plt.show()
|
|
297
|
+
|
|
298
|
+
# ๐ Enhanced with new features
|
|
299
|
+
plt.banner_mode(True, "๐ My Analysis")
|
|
300
|
+
plt.theme('professional')
|
|
301
|
+
plt.plot([1,2,3], [1,4,2])
|
|
302
|
+
plt.show()
|
|
303
|
+
```
|