├── .codecov.yml ├── .flake8 ├── .github └── workflows │ └── ci.yml ├── .gitignore ├── .pre-commit-config.yaml ├── LICENSE.txt ├── MANIFEST.in ├── README.md ├── justfile ├── pyproject.toml ├── setup.cfg ├── src └── termplotlib │ ├── __init__.py │ ├── barh.py │ ├── figure.py │ ├── helpers.py │ ├── hist.py │ ├── plot.py │ └── subplot.py ├── tests ├── test_barh.py ├── test_figure.py ├── test_hist.py ├── test_plot.py ├── test_scatter.py └── test_subplot.py └── tox.ini /.codecov.yml: -------------------------------------------------------------------------------- 1 | comment: no 2 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | ignore = E203, E266, E501, W503 3 | max-line-length = 80 4 | max-complexity = 18 5 | select = B,C,E,F,W,T4,B9 6 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: ci 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | lint: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Check out repo 16 | uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v2 19 | - name: Run pre-commit 20 | uses: pre-commit/action@v2.0.3 21 | 22 | build: 23 | runs-on: ubuntu-latest 24 | strategy: 25 | matrix: 26 | python-version: ["3.7", "3.8", "3.9", "3.10"] 27 | steps: 28 | - uses: actions/setup-python@v2 29 | with: 30 | python-version: ${{ matrix.python-version }} 31 | - uses: actions/checkout@v2 32 | - name: Install dependencies 33 | run: | 34 | sudo apt-get install -y gnuplot 35 | - name: Test with tox 36 | run: | 37 | pip install tox 38 | tox -- --cov termplotlib --cov-report xml --cov-report term 39 | - uses: codecov/codecov-action@v1 40 | if: ${{ matrix.python-version == '3.9' }} 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.swp 3 | *.prof 4 | MANIFEST 5 | dist/ 6 | build/ 7 | .coverage 8 | .cache/ 9 | *.egg-info/ 10 | .pytest_cache/ 11 | venv/ 12 | .idea/ 13 | .tox/ 14 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/PyCQA/isort 3 | rev: 5.9.3 4 | hooks: 5 | - id: isort 6 | 7 | - repo: https://github.com/psf/black 8 | rev: 21.9b0 9 | hooks: 10 | - id: black 11 | language_version: python3 12 | 13 | - repo: https://github.com/PyCQA/flake8 14 | rev: 4.0.1 15 | hooks: 16 | - id: flake8 17 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include tests/*.py 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # termplotlib 2 | 3 | [![PyPi Version](https://img.shields.io/pypi/v/termplotlib.svg?style=flat-square)](https://pypi.org/project/termplotlib) 4 | [![PyPI pyversions](https://img.shields.io/pypi/pyversions/termplotlib.svg?style=flat-square)](https://pypi.org/pypi/termplotlib/) 5 | [![GitHub stars](https://img.shields.io/github/stars/nschloe/termplotlib.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/nschloe/termplotlib) 6 | [![PyPi downloads](https://img.shields.io/pypi/dm/termplotlib.svg?style=flat-square)](https://pypistats.org/packages/termplotlib) 7 | 8 | [![gh-actions](https://img.shields.io/github/workflow/status/nschloe/termplotlib/ci?style=flat-square)](https://github.com/nschloe/termplotlib/actions?query=workflow%3Aci) 9 | [![codecov](https://img.shields.io/codecov/c/github/nschloe/termplotlib.svg?style=flat-square)](https://codecov.io/gh/nschloe/termplotlib) 10 | [![LGTM](https://img.shields.io/lgtm/grade/python/github/nschloe/termplotlib.svg?style=flat-square)](https://lgtm.com/projects/g/nschloe/termplotlib) 11 | [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) 12 | 13 | termplotlib is a Python library for all your terminal plotting needs. It aims to work 14 | like [matplotlib](https://matplotlib.org/). 15 | 16 | ### Line plots 17 | 18 | For line plots, termplotlib relies on [gnuplot](http://www.gnuplot.info/). 19 | With that installed, the code 20 | 21 | ```python 22 | import termplotlib as tpl 23 | import numpy as np 24 | 25 | x = np.linspace(0, 2 * np.pi, 10) 26 | y = np.sin(x) 27 | 28 | fig = tpl.figure() 29 | fig.plot(x, y, label="data", width=50, height=15) 30 | fig.show() 31 | ``` 32 | 33 | produces 34 | 35 | 36 | 37 | ``` 38 | 1 +---------------------------------------+ 39 | 0.8 | ** ** | 40 | 0.6 | * ** data ******* | 41 | 0.4 | ** | 42 | 0.2 |* ** | 43 | 0 | ** | 44 | | * | 45 | -0.2 | ** ** | 46 | -0.4 | ** * | 47 | -0.6 | ** | 48 | -0.8 | **** ** | 49 | -1 +---------------------------------------+ 50 | 0 1 2 3 4 5 6 7 51 | ``` 52 | 53 | ### Horizontal histograms 54 | 55 | ```python 56 | import termplotlib as tpl 57 | import numpy as np 58 | 59 | rng = np.random.default_rng(123) 60 | sample = rng.standard_normal(size=1000) 61 | counts, bin_edges = np.histogram(sample) 62 | 63 | fig = tpl.figure() 64 | fig.hist(counts, bin_edges, orientation="horizontal", force_ascii=False) 65 | fig.show() 66 | ``` 67 | 68 | produces 69 | 70 | ![hist1](https://nschloe.github.io/termplotlib/hist1.png) 71 | 72 | Horizontal bar charts are covered as well. This 73 | 74 | ```python 75 | import termplotlib as tpl 76 | 77 | fig = tpl.figure() 78 | fig.barh([3, 10, 5, 2], ["Cats", "Dogs", "Cows", "Geese"], force_ascii=True) 79 | fig.show() 80 | ``` 81 | 82 | produces 83 | 84 | 85 | 86 | ``` 87 | Cats [ 3] ************ 88 | Dogs [10] **************************************** 89 | Cows [ 5] ******************** 90 | Geese [ 2] ******** 91 | ``` 92 | 93 | ### Vertical histograms 94 | 95 | ```python 96 | import termplotlib as tpl 97 | import numpy as np 98 | 99 | rng = np.random.default_rng(123) 100 | sample = rng.standard_normal(size=1000) 101 | counts, bin_edges = np.histogram(sample, bins=40) 102 | fig = tpl.figure() 103 | fig.hist(counts, bin_edges, grid=[15, 25], force_ascii=False) 104 | fig.show() 105 | ``` 106 | 107 | produces 108 | 109 | ![hist2](https://nschloe.github.io/termplotlib/hist2.png) 110 | 111 | ### Tables 112 | 113 | Support for tables has moved over to 114 | [termtables](https://github.com/nschloe/termtables). 115 | 116 | ### Installation 117 | 118 | termplotlib is [available from the Python Package 119 | Index](https://pypi.org/project/termplotlib/), so simply do 120 | 121 | ``` 122 | pip install termplotlib 123 | ``` 124 | 125 | to install. 126 | 127 | ### Testing 128 | 129 | To run the termplotlib unit tests, check out this repository and type 130 | 131 | ``` 132 | pytest 133 | ``` 134 | 135 | ### Similar projects 136 | 137 | - [asciichart](https://github.com/kroitor/asciichart) 138 | - [bashplotlib](https://github.com/glamp/bashplotlib) 139 | - [plotext](https://github.com/piccolomo/plotext) 140 | - [plotille](https://github.com/tammoippen/plotille) 141 | -------------------------------------------------------------------------------- /justfile: -------------------------------------------------------------------------------- 1 | version := `python3 -c "from configparser import ConfigParser; p = ConfigParser(); p.read('setup.cfg'); print(p['metadata']['version'])"` 2 | 3 | default: 4 | @echo "\"just publish\"?" 5 | 6 | tag: 7 | @if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi 8 | curl -H "Authorization: token `cat ~/.github-access-token`" -d '{"tag_name": "v{{version}}"}' https://api.github.com/repos/nschloe/termplotlib/releases 9 | 10 | upload: clean 11 | @if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi 12 | # https://stackoverflow.com/a/58756491/353337 13 | python3 -m build --sdist --wheel . 14 | twine upload dist/* 15 | 16 | publish: tag upload 17 | 18 | clean: 19 | @find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf 20 | @rm -rf src/*.egg-info/ build/ dist/ .tox/ 21 | 22 | format: 23 | isort . 24 | black . 25 | blacken-docs README.md 26 | 27 | lint: 28 | black --check . 29 | flake8 . 30 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=42", "wheel"] 3 | build-backend = "setuptools.build_meta" 4 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = termplotlib 3 | version = 0.3.9 4 | author = Nico Schlömer 5 | author_email = nico.schloemer@gmail.com 6 | description = Python plotting for the command line 7 | url = https://github.com/nschloe/termplotlib 8 | project_urls = 9 | Code=https://github.com/nschloe/termplotlib 10 | Issues=https://github.com/nschloe/termplotlib/issues 11 | Funding=https://github.com/sponsors/nschloe 12 | long_description = file: README.md 13 | long_description_content_type = text/markdown 14 | license = GPL-3.0-or-later 15 | classifiers = 16 | Development Status :: 4 - Beta 17 | Environment :: Console 18 | Intended Audience :: Developers 19 | License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) 20 | Operating System :: OS Independent 21 | Programming Language :: Python 22 | Programming Language :: Python :: 3 23 | Programming Language :: Python :: 3.7 24 | Programming Language :: Python :: 3.8 25 | Programming Language :: Python :: 3.9 26 | Programming Language :: Python :: 3.10 27 | Topic :: System :: Shells 28 | Topic :: Multimedia :: Graphics 29 | keywords = 30 | graphics 31 | plotting 32 | terminal 33 | ascii 34 | matplotlib 35 | 36 | [options] 37 | package_dir = 38 | =src 39 | packages = find: 40 | install_requires = 41 | numpy >= 1.20 42 | python_requires = >=3.7 43 | 44 | [options.packages.find] 45 | where=src 46 | -------------------------------------------------------------------------------- /src/termplotlib/__init__.py: -------------------------------------------------------------------------------- 1 | from .figure import Figure, figure 2 | from .helpers import get_gnuplot_version 3 | from .subplot import SubplotGrid, subplot_grid 4 | 5 | __all__ = ["Figure", "figure", "SubplotGrid", "subplot_grid", "get_gnuplot_version"] 6 | -------------------------------------------------------------------------------- /src/termplotlib/barh.py: -------------------------------------------------------------------------------- 1 | import decimal 2 | from typing import List, Optional 3 | 4 | import numpy as np 5 | from numpy.typing import ArrayLike 6 | 7 | from .helpers import is_unicode_standard_output 8 | 9 | 10 | def barh( 11 | vals: List[int], 12 | labels: Optional[List[str]] = None, 13 | max_width: int = 40, 14 | bar_width: int = 1, 15 | show_vals: bool = True, 16 | val_format: Optional[str] = None, 17 | force_ascii: bool = False, 18 | ): 19 | partition = _get_partition(vals, max_width) 20 | partition = np.repeat(partition, bar_width, axis=1) 21 | 22 | if is_unicode_standard_output() and not force_ascii: 23 | chars = [" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉", "█"] 24 | else: 25 | chars = [" ", "*", "*", "*", "*", "*", "*", "*", "*"] 26 | 27 | fmt = [] 28 | if labels is not None: 29 | max_len = max(len(str(label)) for label in labels) 30 | cfmt = f"{{:{max_len}s}}" 31 | fmt.append(cfmt) 32 | 33 | if show_vals: 34 | if val_format is not None: 35 | cfmt = val_format 36 | elif np.issubdtype(np.asarray(vals).dtype, float): 37 | # find max decimal length 38 | # https://stackoverflow.com/a/6190291/353337 39 | num_digits = max( 40 | -decimal.Decimal(str(val)).as_tuple().exponent for val in vals 41 | ) 42 | cfmt = f"{{:.{num_digits}f}}" 43 | elif np.issubdtype(np.asarray(vals).dtype, np.integer): 44 | max_len = max(len(str(val)) for val in vals) 45 | cfmt = f"{{:{max_len}d}}" 46 | else: 47 | cfmt = "{}" 48 | fmt.append("[" + cfmt + "]") 49 | 50 | fmt.append("{}") 51 | fmt = " ".join(fmt) 52 | 53 | out = [] 54 | for k, (val, num_full, remainder) in enumerate( 55 | zip(vals, partition[0], partition[1]) 56 | ): 57 | data = [] 58 | if labels is not None: 59 | data.append(str(labels[k])) 60 | if show_vals: 61 | data.append(val) 62 | 63 | # Cut off trailing zeros 64 | data.append("".join([chars[-1]] * num_full + [chars[remainder]])) 65 | out.append(fmt.format(*data)) 66 | 67 | return out 68 | 69 | 70 | def _get_partition(values: ArrayLike, max_size: int): 71 | values = np.asarray(values) 72 | assert np.all(values >= 0) 73 | maxval = np.max(values) 74 | if maxval == 0: 75 | maxval = 1 76 | 77 | eighths = np.around(values / maxval * max_size * 8).astype(int) 78 | return np.array([eighths // 8, eighths % 8]) 79 | -------------------------------------------------------------------------------- /src/termplotlib/figure.py: -------------------------------------------------------------------------------- 1 | from typing import Optional 2 | 3 | from .barh import barh 4 | from .helpers import create_padding_tuple 5 | from .hist import hist 6 | from .plot import plot 7 | 8 | 9 | def figure(*args, **kwargs): 10 | return Figure(*args, **kwargs) 11 | 12 | 13 | class Figure: 14 | def __init__(self, width: Optional[int] = None, padding: int = 0): 15 | self._content = [] 16 | self._width = width 17 | self._subfigures = None 18 | self._padding = create_padding_tuple(padding) 19 | 20 | def __rich_console__(self, *args): 21 | yield self.get_string() 22 | 23 | def aprint(self, string): 24 | self._content.append(string.split("\n")) 25 | 26 | def show(self): 27 | print(self.get_string()) 28 | 29 | def get_string(self, remove_trailing_whitespace=True): 30 | lines = [] 31 | 32 | padding_lr = self._padding[1] + self._padding[3] 33 | 34 | if self._width is None: 35 | line_lengths = [len(line) for c in self._content for line in c] 36 | width = max(line_lengths) if line_lengths else 0 37 | width += padding_lr 38 | else: 39 | width = self._width 40 | 41 | # Top padding 42 | lines += self._padding[0] * [" " * width] 43 | 44 | pr = " " * self._padding[1] 45 | pl = " " * self._padding[3] 46 | lines += [ 47 | pl + line[: width - padding_lr] + pr for c in self._content for line in c 48 | ] 49 | 50 | # Bottom padding 51 | lines += self._padding[2] * [" " * width] 52 | 53 | if remove_trailing_whitespace: 54 | lines = [line.rstrip() for line in lines] 55 | 56 | return "\n".join(lines) 57 | 58 | def hist(self, *args, **kwargs): 59 | self._content.append(hist(*args, **kwargs)) 60 | 61 | def barh(self, *args, **kwargs): 62 | self._content.append(barh(*args, **kwargs)) 63 | 64 | def plot(self, *args, **kwargs): 65 | self._content.append(plot(*args, **kwargs)) 66 | -------------------------------------------------------------------------------- /src/termplotlib/helpers.py: -------------------------------------------------------------------------------- 1 | import re 2 | import subprocess 3 | import sys 4 | from typing import List, Tuple, Union 5 | 6 | 7 | def create_padding_tuple(padding: Union[int, List[int], Tuple[int, int]]): 8 | # self._padding is a 4-tuple: top, right, bottom, left (just like CSS) 9 | if isinstance(padding, int): 10 | out = (padding, padding, padding, padding) 11 | else: 12 | if len(padding) == 1: 13 | out = (padding[0], padding[0], padding[0], padding[0]) 14 | elif len(padding) == 2: 15 | out = (padding[0], padding[1], padding[0], padding[1]) 16 | elif len(padding) == 3: 17 | out = (padding[0], padding[1], padding[2], padding[1]) 18 | else: 19 | assert len(padding) == 4 20 | out = (padding[0], padding[1], padding[2], padding[3]) 21 | return out 22 | 23 | 24 | def is_unicode_standard_output(): 25 | if sys.stdout.encoding is None: 26 | return True 27 | 28 | return hasattr(sys.stdout, "encoding") and sys.stdout.encoding.lower() in ( 29 | "utf-8", 30 | "utf8", 31 | ) 32 | 33 | 34 | def get_gnuplot_version(): 35 | out = subprocess.check_output(["gnuplot", "--version"]).decode() 36 | m = re.match("gnuplot (\\d).(\\d) patchlevel (\\d)\n", out) 37 | if m is None: 38 | raise RuntimeError("Couldn't get gnuplot version") 39 | 40 | return int(m.group(1)), int(m.group(2)), int(m.group(3)) 41 | -------------------------------------------------------------------------------- /src/termplotlib/hist.py: -------------------------------------------------------------------------------- 1 | from typing import List, Optional 2 | 3 | import numpy as np 4 | 5 | from .barh import _get_partition, barh 6 | from .helpers import is_unicode_standard_output 7 | 8 | 9 | def hist( 10 | counts: List[int], 11 | bin_edges: List[float], 12 | orientation: str = "vertical", 13 | max_width: int = 40, 14 | grid=None, 15 | bar_width: int = 1, 16 | strip: bool = False, 17 | force_ascii: bool = False, 18 | ): 19 | if orientation == "vertical": 20 | return hist_vertical( 21 | counts, 22 | xgrid=grid, 23 | bar_width=bar_width, 24 | strip=strip, 25 | force_ascii=force_ascii, 26 | ) 27 | 28 | assert orientation == "horizontal", f"Unknown orientation '{orientation}'" 29 | return hist_horizontal( 30 | counts, 31 | bin_edges, 32 | max_width=max_width, 33 | bar_width=bar_width, 34 | force_ascii=force_ascii, 35 | ) 36 | 37 | 38 | def hist_horizontal( 39 | counts: List[int], 40 | bin_edges: List[float], 41 | max_width: int = 40, 42 | bar_width: int = 1, 43 | show_bin_edges: bool = True, 44 | show_counts: bool = True, 45 | force_ascii: bool = False, 46 | ): 47 | if show_bin_edges: 48 | labels = [ 49 | f"{bin_edges[k]:+.2e} - {bin_edges[k+1]:+.2e}" 50 | for k in range(len(bin_edges) - 1) 51 | ] 52 | else: 53 | labels = None 54 | 55 | return barh( 56 | counts, 57 | labels=labels, 58 | max_width=max_width, 59 | bar_width=bar_width, 60 | show_vals=show_counts, 61 | force_ascii=force_ascii, 62 | ) 63 | 64 | 65 | def hist_vertical( 66 | counts: List[int], 67 | max_height: int = 10, 68 | bar_width: int = 2, 69 | strip: bool = False, 70 | xgrid: Optional[List[int]] = None, 71 | force_ascii: bool = False, 72 | ): 73 | if xgrid is None: 74 | xgrid = [] 75 | 76 | partition = _get_partition(counts, max_height) 77 | 78 | if strip: 79 | # Cut off leading and trailing rows of 0 80 | num_head_rows_delete = np.argmax(np.any(partition != 0, axis=0)) 81 | num_tail_rows_delete = np.argmax(np.any(partition != 0, axis=0)[::-1]) 82 | 83 | n = partition.shape[1] 84 | partition = partition[:, num_head_rows_delete : n - num_tail_rows_delete] 85 | else: 86 | num_head_rows_delete = 0 87 | 88 | matrix = _get_matrix_of_eighths(partition[0], partition[1], max_height, bar_width) 89 | 90 | if is_unicode_standard_output() and not force_ascii: 91 | block_chars = [" ", "▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"] 92 | left_seven_eighths = "▉" 93 | else: 94 | block_chars = [" ", "*", "*", "*", "*", "*", "*", "*", "*"] 95 | left_seven_eighths = "*" 96 | 97 | block_chars = np.array(block_chars) 98 | 99 | out = [] 100 | for row in np.flipud(matrix.T): 101 | # converts row into block chars 102 | c = block_chars[row] 103 | 104 | # add grid lines 105 | for i in xgrid: 106 | pos = (i - num_head_rows_delete) * bar_width - 1 107 | if row[pos] == 8 and (pos + 1 == len(row) or row[pos + 1] > 0): 108 | c[pos] = left_seven_eighths 109 | 110 | out.append("".join(c)) 111 | 112 | return out 113 | 114 | 115 | def _get_matrix_of_eighths( 116 | nums_full_blocks, remainders, max_size, bar_width: int 117 | ) -> np.ndarray: 118 | """ 119 | Returns a matrix of integers between 0-8 encoding bar lengths in histogram. 120 | 121 | For instance, if one of the sublists is [8, 8, 8, 3, 0, 0, 0, 0, 0, 0], it means 122 | that the first 3 segments should be graphed with full blocks, the 4th block should 123 | be 3/8ths full, and that the rest of the bar should be empty. 124 | """ 125 | matrix = np.zeros((len(nums_full_blocks), max_size), dtype=int) 126 | 127 | for row, num_full_blocks, remainder in zip(matrix, nums_full_blocks, remainders): 128 | row[:num_full_blocks] = 8 129 | if num_full_blocks < matrix.shape[1]: 130 | row[num_full_blocks] = remainder 131 | 132 | return np.repeat(matrix, bar_width, axis=0) 133 | -------------------------------------------------------------------------------- /src/termplotlib/plot.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | from typing import List, Optional, Tuple 3 | 4 | 5 | def plot( 6 | x: List[float], 7 | y: List[float], 8 | width: int = 80, 9 | height: int = 25, 10 | label: Optional[str] = None, 11 | xlim: Optional[Tuple[float, float]] = None, 12 | ylim: Optional[Tuple[float, float]] = None, 13 | xlabel: Optional[str] = None, 14 | title: Optional[str] = None, 15 | extra_gnuplot_arguments: Optional[List[str]] = None, 16 | plot_command: str = "plot '-' w lines", 17 | ticks_scale: int = 0, 18 | ): 19 | p = subprocess.Popen( 20 | ["gnuplot"], 21 | stdout=subprocess.PIPE, 22 | stdin=subprocess.PIPE, 23 | stderr=subprocess.PIPE, 24 | ) 25 | 26 | gnuplot_input = [] 27 | 28 | gnuplot_input.append(f"set term dumb mono {width},{height}") 29 | 30 | # gnuplot_input.append("set tics nomirror") 31 | gnuplot_input.append(f"set tics scale {ticks_scale}") 32 | 33 | if xlim: 34 | gnuplot_input.append(f"set xrange [{xlim[0]}:{xlim[1]}]") 35 | 36 | if ylim: 37 | gnuplot_input.append(f"set yrange [{ylim[0]}:{ylim[1]}]") 38 | 39 | if xlabel: 40 | gnuplot_input.append(f'set xlabel "{xlabel}"') 41 | 42 | if title: 43 | gnuplot_input.append(f'set title "{title}"') 44 | 45 | if extra_gnuplot_arguments: 46 | gnuplot_input += extra_gnuplot_arguments 47 | 48 | string = plot_command 49 | if label: 50 | string += f" title '{label}'" 51 | else: 52 | string += " notitle" 53 | 54 | gnuplot_input.append(string) 55 | 56 | for xx, yy in zip(x, y): 57 | gnuplot_input.append(f"{xx:e} {yy:e}") 58 | gnuplot_input.append("e") 59 | 60 | out = p.communicate(input="\n".join(gnuplot_input).encode())[0] 61 | 62 | return _remove_empty_lines(out.decode()) 63 | 64 | 65 | def _remove_empty_lines(string: str): 66 | return string.split("\n")[1:-2] 67 | -------------------------------------------------------------------------------- /src/termplotlib/subplot.py: -------------------------------------------------------------------------------- 1 | from typing import List, Optional, Tuple, Union 2 | 3 | from .figure import Figure 4 | 5 | 6 | def subplot_grid(*args, **kwargs): 7 | return SubplotGrid(*args, **kwargs) 8 | 9 | 10 | class SubplotGrid: 11 | def __init__( 12 | self, 13 | layout, 14 | width: Optional[int] = None, 15 | column_widths: Optional[List[int]] = None, 16 | border_style: str = "thin", 17 | padding: Union[int, List[int], Tuple[int, int]] = (1, 2), 18 | ): 19 | assert ( 20 | len(layout) == 2 21 | ), "layout must be an interable of length 2 (rows and columns)" 22 | 23 | self._layout = layout 24 | 25 | if border_style is None: 26 | self._border_chars = None 27 | elif len(border_style) == 1: 28 | self._border_chars = 11 * [border_style] 29 | elif isinstance(border_style, list): 30 | assert len(border_style) == 11 31 | self._border_chars = border_style 32 | else: 33 | self._border_chars = { 34 | "thin": ["─", "│", "┌", "┐", "└", "┘", "├", "┤", "┬", "┴", "┼"], 35 | "thin rounded": ["─", "│", "╭", "╮", "╰", "╯", "├", "┤", "┬", "┴", "┼"], 36 | "thick": ["━", "┃", "┏", "┓", "┗", "┛", "┣", "┫", "┳", "┻", "╋"], 37 | "double": ["═", "║", "╔", "╗", "╚", "╝", "╠", "╣", "╦", "╩", "╬"], 38 | "ascii": ["-", "|", "-", "-", "-", "-", "|", "|", "-", "-", "+"], 39 | }[border_style] 40 | 41 | border_width = 1 42 | self._num_borders = layout[1] + 1 43 | 44 | if column_widths is None: 45 | if width is None: 46 | self._column_widths = [None] * layout[1] 47 | else: 48 | self._column_widths = [ 49 | (width - self._num_borders * border_width) // layout[1] 50 | for _ in range(layout[1]) 51 | ] 52 | for k in range((width - self._num_borders * border_width) % layout[1]): 53 | self._column_widths[k] += 1 54 | else: 55 | assert ( 56 | width is None 57 | ), "At most one of `width` and `column_widths` can be specified." 58 | assert len(column_widths) == layout[1] 59 | self._column_widths = column_widths 60 | 61 | self._subfigures = [ 62 | [Figure(self._column_widths[j], padding=padding) for j in range(layout[1])] 63 | for _ in range(layout[0]) 64 | ] 65 | 66 | def show(self): 67 | print(self.get_string()) 68 | 69 | def get_string(self): 70 | # compute column width 71 | cstrings = [ 72 | [item.get_string(remove_trailing_whitespace=False) for item in row] 73 | for row in self._subfigures 74 | ] 75 | column_widths = [ 76 | max( 77 | len(line) 78 | for i in range(self._layout[0]) 79 | for line in cstrings[i][j].split("\n") 80 | ) 81 | for j in range(self._layout[1]) 82 | ] 83 | 84 | string = [] 85 | 86 | if self._border_chars: 87 | string += [ 88 | self._border_chars[2] 89 | + self._border_chars[8].join( 90 | [s * self._border_chars[0] for s in column_widths] 91 | ) 92 | + self._border_chars[3] 93 | ] 94 | 95 | # collect the subfigure rows 96 | srows = [] 97 | for row in self._subfigures: 98 | cstrings = [item.get_string().split("\n") for item in row] 99 | max_num_lines = max(len(item) for item in cstrings) 100 | pp = [] 101 | for k in range(max_num_lines): 102 | p = [] 103 | for j, cstring in enumerate(cstrings): 104 | try: 105 | s = cstring[k] 106 | except IndexError: 107 | s = "" 108 | # truncate or extend with spaces to match the column width 109 | if len(s) >= column_widths[j]: 110 | s = s[: column_widths[j]] 111 | else: 112 | s += " " * (column_widths[j] - len(s)) 113 | p.append(s) 114 | if self._border_chars: 115 | join_char = self._border_chars[1] 116 | else: 117 | join_char = "" 118 | pp.append(join_char + join_char.join(p) + join_char) 119 | srows.append("\n".join([p.rstrip() for p in pp])) 120 | 121 | if self._border_chars: 122 | intermediate_border_row = ( 123 | "\n" 124 | + self._border_chars[6] 125 | + self._border_chars[10].join( 126 | [s * self._border_chars[0] for s in column_widths] 127 | ) 128 | + self._border_chars[7] 129 | + "\n" 130 | ) 131 | else: 132 | intermediate_border_row = "\n" 133 | string += [intermediate_border_row.join(srows)] 134 | 135 | if self._border_chars: 136 | # final row 137 | string += [ 138 | self._border_chars[4] 139 | + self._border_chars[9].join( 140 | [s * self._border_chars[0] for s in column_widths] 141 | ) 142 | + self._border_chars[5] 143 | ] 144 | 145 | return "\n".join([s.rstrip() for s in string]) 146 | 147 | def __getitem__(self, ij): 148 | i, j = ij 149 | if i >= self._layout[0]: 150 | raise IndexError( 151 | f"Row index too large! (idx {i}, only {self._layout[0]} rows)" 152 | ) 153 | if j >= self._layout[1]: 154 | raise IndexError( 155 | f"Col index too large! (idx {j}, only {self._layout[1]} cols)" 156 | ) 157 | return self._subfigures[i][j] 158 | -------------------------------------------------------------------------------- /tests/test_barh.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | import pytest 4 | 5 | import termplotlib as tpl 6 | 7 | 8 | @pytest.mark.skipif( 9 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 10 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 11 | ) 12 | def test_barh(): 13 | fig = tpl.figure() 14 | fig.barh([3, 10, 5, 2], ["Cats", "Dogs", "Cows", "Geese"]) 15 | # fig.show() 16 | string = fig.get_string() 17 | 18 | assert ( 19 | string 20 | == """\ 21 | Cats [ 3] ████████████ 22 | Dogs [10] ████████████████████████████████████████ 23 | Cows [ 5] ████████████████████ 24 | Geese [ 2] ████████\ 25 | """ 26 | ) 27 | 28 | 29 | def test_barh_ascii(): 30 | fig = tpl.figure() 31 | fig.barh([3, 10, 5, 2], ["Cats", "Dogs", "Cows", "Geese"], force_ascii=True) 32 | # fig.show() 33 | string = fig.get_string() 34 | 35 | assert ( 36 | string 37 | == """\ 38 | Cats [ 3] ************ 39 | Dogs [10] **************************************** 40 | Cows [ 5] ******************** 41 | Geese [ 2] ********\ 42 | """ 43 | ) 44 | 45 | 46 | @pytest.mark.skipif( 47 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 48 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 49 | ) 50 | def test_barh_floats(): 51 | fig = tpl.figure() 52 | fig.barh([0.3, 0.4, 0.6, 0.2], ["Cats", "Dogs", "Cows", "Geese"]) 53 | # fig.show() 54 | string = fig.get_string() 55 | 56 | assert ( 57 | string 58 | == """\ 59 | Cats [0.3] ████████████████████ 60 | Dogs [0.4] ██████████████████████████▋ 61 | Cows [0.6] ████████████████████████████████████████ 62 | Geese [0.2] █████████████▍\ 63 | """ 64 | ) 65 | 66 | 67 | def test_barh_floats_different_precision(): 68 | fig = tpl.figure() 69 | fig.barh([3, 2.5341234], ["Cats", "Dogs"]) 70 | # fig.show() 71 | string = fig.get_string() 72 | 73 | ref = """\ 74 | Cats [3.0000000] ████████████████████████████████████████ 75 | Dogs [2.5341234] █████████████████████████████████▊""" 76 | 77 | assert string == ref, "\n" + string 78 | 79 | 80 | def test_div_by_zero(): 81 | fig = tpl.figure() 82 | fig.barh([0, 0], ["Eggs", "Dogs"]) 83 | string = fig.get_string() 84 | print(string) 85 | assert ( 86 | string 87 | == """\ 88 | Eggs [0] 89 | Dogs [0]\ 90 | """ 91 | ) 92 | 93 | 94 | if __name__ == "__main__": 95 | # test_horizontal_ascii() 96 | # test_barh() 97 | test_barh_floats() 98 | -------------------------------------------------------------------------------- /tests/test_figure.py: -------------------------------------------------------------------------------- 1 | import termplotlib as tpl 2 | 3 | 4 | def test_simple(): 5 | fig = tpl.figure() 6 | fig.aprint("abc") 7 | string = fig.get_string() 8 | assert string == """abc""" 9 | 10 | 11 | def test_padding_1(): 12 | fig = tpl.figure(padding=1) 13 | fig.aprint("abc") 14 | string = fig.get_string() 15 | assert ( 16 | string 17 | == """ 18 | abc 19 | """ 20 | ) 21 | 22 | 23 | def test_padding_1b(): 24 | fig = tpl.figure(padding=(1,)) 25 | fig.aprint("abc") 26 | string = fig.get_string() 27 | assert ( 28 | string 29 | == """ 30 | abc 31 | """ 32 | ) 33 | 34 | 35 | def test_padding_2(): 36 | fig = tpl.figure(padding=(1, 2)) 37 | fig.aprint("abc") 38 | string = fig.get_string() 39 | assert ( 40 | string 41 | == """ 42 | abc 43 | """ 44 | ) 45 | 46 | 47 | def test_padding_3(): 48 | fig = tpl.figure(padding=(1, 2, 3)) 49 | fig.aprint("abc") 50 | string = fig.get_string() 51 | assert ( 52 | string 53 | == """ 54 | abc 55 | 56 | 57 | """ 58 | ) 59 | 60 | 61 | def test_padding_4(): 62 | fig = tpl.figure(padding=(1, 2, 3, 4)) 63 | fig.aprint("abc") 64 | string = fig.get_string() 65 | assert ( 66 | string 67 | == """ 68 | abc 69 | 70 | 71 | """ 72 | ) 73 | fig.show() 74 | -------------------------------------------------------------------------------- /tests/test_hist.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | import numpy as np 4 | import pytest 5 | 6 | import termplotlib as tpl 7 | 8 | 9 | @pytest.mark.skipif( 10 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 11 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 12 | ) 13 | def test_horizontal(): 14 | rng = np.random.default_rng(123) 15 | sample = rng.standard_normal(size=1000) 16 | counts, bin_edges = np.histogram(sample) 17 | fig = tpl.figure() 18 | fig.hist(counts, bin_edges, orientation="horizontal") 19 | # fig.show() 20 | string = fig.get_string() 21 | 22 | ref = """\ 23 | -3.30e+00 - -2.66e+00 [ 8] █▎ 24 | -2.66e+00 - -2.03e+00 [ 22] ███▌ 25 | -2.03e+00 - -1.39e+00 [ 50] ████████ 26 | -1.39e+00 - -7.56e-01 [123] ███████████████████▋ 27 | -7.56e-01 - -1.20e-01 [236] █████████████████████████████████████▊ 28 | -1.20e-01 - +5.16e-01 [250] ████████████████████████████████████████ 29 | +5.16e-01 - +1.15e+00 [172] ███████████████████████████▌ 30 | +1.15e+00 - +1.79e+00 [111] █████████████████▊ 31 | +1.79e+00 - +2.42e+00 [ 22] ███▌ 32 | +2.42e+00 - +3.06e+00 [ 6] █\ 33 | """ 34 | 35 | assert string == ref, string 36 | 37 | 38 | def test_horizontal_ascii(): 39 | rng = np.random.default_rng(123) 40 | sample = rng.standard_normal(size=1000) 41 | counts, bin_edges = np.histogram(sample) 42 | fig = tpl.figure() 43 | fig.hist(counts, bin_edges, orientation="horizontal", force_ascii=True) 44 | string = fig.get_string() 45 | 46 | ref = """\ 47 | -3.30e+00 - -2.66e+00 [ 8] ** 48 | -2.66e+00 - -2.03e+00 [ 22] **** 49 | -2.03e+00 - -1.39e+00 [ 50] ******** 50 | -1.39e+00 - -7.56e-01 [123] ******************** 51 | -7.56e-01 - -1.20e-01 [236] ************************************** 52 | -1.20e-01 - +5.16e-01 [250] **************************************** 53 | +5.16e-01 - +1.15e+00 [172] **************************** 54 | +1.15e+00 - +1.79e+00 [111] ****************** 55 | +1.79e+00 - +2.42e+00 [ 22] **** 56 | +2.42e+00 - +3.06e+00 [ 6] *\ 57 | """ 58 | 59 | assert string == ref, string 60 | 61 | 62 | @pytest.mark.skipif( 63 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 64 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 65 | ) 66 | def test_vertical(): 67 | rng = np.random.default_rng(123) 68 | sample = rng.standard_normal(size=1000) 69 | counts, bin_edges = np.histogram(sample, bins=40) 70 | fig = tpl.figure() 71 | fig.hist(counts, bin_edges) 72 | fig.show() 73 | 74 | string = fig.get_string() 75 | 76 | ref = """\ 77 | ▇ █ 78 | ▁ █ ▁█ ▄ 79 | █ █▂██▁█ 80 | █▅██████ ▄▄ 81 | ▃████████▃██ ▆ 82 | ████████████▇█ 83 | ▅▅▇██████████████▁▅ 84 | ▂███████████████████▃ 85 | ▃▁ ▅▇█████████████████████ 86 | ▂ ▂▄ ▄███████████████████████████▆▄▅▃▂ ▁\ 87 | """ 88 | 89 | assert string == ref, "\n" + string 90 | 91 | 92 | def test_vertical_ascii(): 93 | rng = np.random.default_rng(123) 94 | sample = rng.standard_normal(size=1000) 95 | counts, bin_edges = np.histogram(sample, bins=40) 96 | fig = tpl.figure() 97 | fig.hist(counts, bin_edges, force_ascii=True) 98 | # fig.show() 99 | 100 | string = fig.get_string() 101 | 102 | ref = """\ 103 | * * 104 | * * ** * 105 | * ****** 106 | ******** ** 107 | ************ * 108 | ************** 109 | ******************* 110 | ********************* 111 | ** *********************** 112 | * ** ********************************* *""" 113 | 114 | assert string == ref, "\n" + string 115 | 116 | 117 | @pytest.mark.skipif( 118 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 119 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 120 | ) 121 | def test_vertical_grid(): 122 | rng = np.random.default_rng(123) 123 | sample = rng.standard_normal(size=1000) 124 | counts, bin_edges = np.histogram(sample, bins=40) 125 | fig = tpl.figure() 126 | fig.hist(counts, bin_edges, grid=[15, 25]) 127 | # fig.show() 128 | string = fig.get_string() 129 | 130 | ref = """\ 131 | ▇ █ 132 | ▁ █ ▁█ ▄ 133 | █ █▂██▁█ 134 | █▅██████ ▄▄ 135 | ▃████████▃██ ▆ 136 | █████████▉██▇█ 137 | ▅▅▇█████████▉████▁▅ 138 | ▂██▉█████████▉██████▃ 139 | ▃▁ ▅▇███▉█████████▉███████ 140 | ▂ ▂▄ ▄████████▉█████████▉████████▆▄▅▃▂ ▁""" 141 | 142 | assert string == ref, "\n" + string 143 | 144 | 145 | @pytest.mark.skipif( 146 | sys.stdout.encoding.upper() not in ["UTF-8", "UTF8"], 147 | reason=f"Need UTF-8 terminal (not {sys.stdout.encoding})", 148 | ) 149 | def test_vertical_strip(): 150 | rng = np.random.default_rng(20) 151 | sample = rng.standard_normal(size=10000) 152 | counts, bin_edges = np.histogram(sample) 153 | fig = tpl.figure() 154 | fig.hist(counts, bin_edges, grid=[5, 8], strip=True) 155 | string = fig.get_string() 156 | 157 | ref = """\ 158 | ▂█ 159 | ▉█ 160 | ▉█ 161 | ▉█▃ 162 | ▃▉██ 163 | █▉██ 164 | █▉██ 165 | █▉██▆ 166 | ██▉███ 167 | ▁▄██▉██▉▆▁""" 168 | 169 | assert string == ref, "\n" + string 170 | 171 | 172 | if __name__ == "__main__": 173 | # test_horizontal_ascii() 174 | test_vertical_grid() 175 | -------------------------------------------------------------------------------- /tests/test_plot.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | import pytest 3 | 4 | import termplotlib as tpl 5 | 6 | 7 | def test_plot(): 8 | x = np.linspace(0, 2 * np.pi, 10) 9 | y = np.sin(x) 10 | 11 | fig = tpl.figure() 12 | fig.plot(x, y, label="data", width=50, height=15) 13 | string = fig.get_string() 14 | 15 | ref = """ 1 +---------------------------------------+ 16 | 0.8 | ** ** | 17 | 0.6 | * ** data ******* | 18 | 0.4 | ** | 19 | 0.2 |* ** | 20 | 0 | ** | 21 | | * | 22 | -0.2 | ** ** | 23 | -0.4 | ** * | 24 | -0.6 | ** | 25 | -0.8 | **** ** | 26 | -1 +---------------------------------------+ 27 | 0 1 2 3 4 5 6 7""" 28 | 29 | assert string == ref 30 | 31 | 32 | def test_nolabel(): 33 | x = np.linspace(0, 2 * np.pi, 10) 34 | y = np.sin(x) 35 | 36 | fig = tpl.figure() 37 | fig.plot(x, y, width=50, height=15) 38 | string = fig.get_string() 39 | 40 | ref = """ 1 +---------------------------------------+ 41 | 0.8 | ** ** | 42 | 0.6 | * ** | 43 | 0.4 | ** | 44 | 0.2 |* ** | 45 | 0 | ** | 46 | | * | 47 | -0.2 | ** ** | 48 | -0.4 | ** * | 49 | -0.6 | ** | 50 | -0.8 | **** ** | 51 | -1 +---------------------------------------+ 52 | 0 1 2 3 4 5 6 7""" 53 | 54 | assert string == ref 55 | 56 | 57 | @pytest.mark.skipif( 58 | tpl.get_gnuplot_version() < (5, 4), reason="Need at least gnuplot 5.4" 59 | ) 60 | def test_plot_lim(): 61 | x = np.linspace(0, 2 * np.pi, 10) 62 | y = np.sin(x) 63 | 64 | fig = tpl.figure() 65 | fig.plot( 66 | x, 67 | y, 68 | label="data", 69 | width=50, 70 | height=15, 71 | xlim=[-1, 1], 72 | ylim=[-1, 1], 73 | xlabel="x vals", 74 | title="header", 75 | ) 76 | string = fig.get_string() 77 | 78 | # for some reason, this gives a different result locally; perhaps a different 79 | # gnuplot version 80 | ref = """ 81 | header 82 | 1 +---------------------------------------+ 83 | | ********| 84 | 0.5 | ************ | 85 | | **** | 86 | 0 | *** | 87 | | | 88 | -0.5 | | 89 | | | 90 | -1 +---------------------------------------+ 91 | -1 -0.5 0 0.5 1 92 | x vals""" 93 | 94 | assert string == ref, string 95 | -------------------------------------------------------------------------------- /tests/test_scatter.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | 3 | import termplotlib as tpl 4 | 5 | 6 | def test_scatter(): 7 | rng = np.random.default_rng(0) 8 | x = np.arange(0.0, 50.0, 2.0) 9 | y = x ** 1.3 + rng.random(x.shape) * 30.0 10 | 11 | fig = tpl.figure() 12 | fig.plot(x, y, plot_command="plot '-' w points", width=50, height=15) 13 | # fig.show() 14 | string = fig.get_string() 15 | 16 | ref = """\ 17 | 180 +---------------------------------------+ 18 | 160 | A AA | 19 | 140 | | 20 | | A A | 21 | 120 | AA A A | 22 | 100 | A | 23 | 80 | A A | 24 | 60 | A A A | 25 | | A AA A A | 26 | 40 | A | 27 | 20 | A A | 28 | 0 +---------------------------------------+ 29 | 0 5 10 15 20 25 30 35 40 45 50""" 30 | 31 | assert string == ref, string 32 | 33 | 34 | if __name__ == "__main__": 35 | test_scatter() 36 | -------------------------------------------------------------------------------- /tests/test_subplot.py: -------------------------------------------------------------------------------- 1 | import termplotlib as tpl 2 | 3 | 4 | def _generate_content(*args, **kwargs): 5 | grid = tpl.subplot_grid((2, 3), *args, **kwargs) 6 | grid[0, 0].aprint("Some text") 7 | grid[0, 1].aprint("Some more text\nand more") 8 | grid[0, 2].aprint("Some more text\nand more\neven more") 9 | grid[1, 0].aprint("Some more text\nand more\neven more") 10 | grid[1, 1].aprint("Some more text\nand more") 11 | grid[1, 2].aprint("Some text") 12 | return grid 13 | 14 | 15 | def test_subplot(): 16 | grid = tpl.subplot_grid((1, 2), width=20) 17 | grid[0, 0].aprint("Some text") 18 | grid[0, 1].aprint("Some more text") 19 | string = grid.get_string() 20 | assert ( 21 | string 22 | == """┌─────────┬────────┐ 23 | │ │ │ 24 | │ Some │ Some │ 25 | │ │ │ 26 | └─────────┴────────┘""" 27 | ) 28 | 29 | 30 | def test_subplot_custom_border(): 31 | grid = tpl.subplot_grid((1, 2), border_style="x", width=20) 32 | grid[0, 0].aprint("Some text") 33 | grid[0, 1].aprint("Some more text") 34 | string = grid.get_string() 35 | assert ( 36 | string 37 | == """xxxxxxxxxxxxxxxxxxxx 38 | x x x 39 | x Some x Some x 40 | x x x 41 | xxxxxxxxxxxxxxxxxxxx""" 42 | ) 43 | 44 | 45 | def test_subplot2(): 46 | grid = tpl.subplot_grid((1, 2), width=20, border_style="thick") 47 | grid[0, 0].aprint("Some text") 48 | grid[0, 1].aprint("Some more text\nand more") 49 | string = grid.get_string() 50 | assert ( 51 | string 52 | == """┏━━━━━━━━━┳━━━━━━━━┓ 53 | ┃ ┃ ┃ 54 | ┃ Some ┃ Some ┃ 55 | ┃ ┃ and ┃ 56 | ┃ ┃ ┃ 57 | ┗━━━━━━━━━┻━━━━━━━━┛""" 58 | ) 59 | 60 | 61 | def test_subplot_padding(): 62 | grid = tpl.subplot_grid((1, 2), width=20, padding=2, border_style="double") 63 | grid[0, 0].aprint("Some text") 64 | grid[0, 1].aprint("Some more text\nand more") 65 | string = grid.get_string() 66 | assert ( 67 | string 68 | == """╔═════════╦════════╗ 69 | ║ ║ ║ 70 | ║ ║ ║ 71 | ║ Some ║ Some ║ 72 | ║ ║ and ║ 73 | ║ ║ ║ 74 | ║ ║ ║ 75 | ╚═════════╩════════╝""" 76 | ) 77 | 78 | 79 | def test_subplot_3x2(): 80 | grid = _generate_content(width=40) 81 | string = grid.get_string() 82 | 83 | assert ( 84 | string 85 | == """┌────────────┬────────────┬────────────┐ 86 | │ │ │ │ 87 | │ Some tex │ Some mor │ Some mor │ 88 | │ │ and more │ and more │ 89 | │ │ │ even mor │ 90 | │ │ │ │ 91 | ├────────────┼────────────┼────────────┤ 92 | │ │ │ │ 93 | │ Some mor │ Some mor │ Some tex │ 94 | │ and more │ and more │ │ 95 | │ even mor │ │ │ 96 | │ │ │ │ 97 | └────────────┴────────────┴────────────┘""" 98 | ) 99 | 100 | 101 | def test_subplot_ascii(): 102 | grid = _generate_content(width=40, border_style="ascii") 103 | string = grid.get_string() 104 | 105 | assert ( 106 | string 107 | == """---------------------------------------- 108 | | | | | 109 | | Some tex | Some mor | Some mor | 110 | | | and more | and more | 111 | | | | even mor | 112 | | | | | 113 | |------------+------------+------------| 114 | | | | | 115 | | Some mor | Some mor | Some tex | 116 | | and more | and more | | 117 | | even mor | | | 118 | | | | | 119 | ----------------------------------------""" 120 | ) 121 | 122 | 123 | def test_subplot_thin_rounded(): 124 | grid = _generate_content(width=40, border_style="thin rounded") 125 | string = grid.get_string() 126 | 127 | assert ( 128 | string 129 | == """╭────────────┬────────────┬────────────╮ 130 | │ │ │ │ 131 | │ Some tex │ Some mor │ Some mor │ 132 | │ │ and more │ and more │ 133 | │ │ │ even mor │ 134 | │ │ │ │ 135 | ├────────────┼────────────┼────────────┤ 136 | │ │ │ │ 137 | │ Some mor │ Some mor │ Some tex │ 138 | │ and more │ and more │ │ 139 | │ even mor │ │ │ 140 | │ │ │ │ 141 | ╰────────────┴────────────┴────────────╯""" 142 | ) 143 | 144 | 145 | def test_subplot_custom(): 146 | grid = _generate_content( 147 | width=40, border_style=["-", "|", "-", "-", "-", "-", "|", "|", "T", "-", "X"] 148 | ) 149 | string = grid.get_string() 150 | 151 | assert ( 152 | string 153 | == """-------------T------------T------------- 154 | | | | | 155 | | Some tex | Some mor | Some mor | 156 | | | and more | and more | 157 | | | | even mor | 158 | | | | | 159 | |------------X------------X------------| 160 | | | | | 161 | | Some mor | Some mor | Some tex | 162 | | and more | and more | | 163 | | even mor | | | 164 | | | | | 165 | ----------------------------------------""" 166 | ) 167 | 168 | grid.show() 169 | 170 | 171 | def test_subplot_no_borders(): 172 | grid = _generate_content(width=40, border_style=None) 173 | string = grid.get_string() 174 | 175 | ref = """ 176 | Some tex Some mor Some mor 177 | and more and more 178 | even mor 179 | 180 | 181 | Some mor Some mor Some tex 182 | and more and more 183 | even mor""" 184 | 185 | assert string == ref 186 | 187 | 188 | def test_subplot_column_widths(): 189 | grid = _generate_content(column_widths=(30, 15, 20)) 190 | string = grid.get_string() 191 | 192 | print(string) 193 | 194 | assert ( 195 | string 196 | == """┌──────────────────────────────┬───────────────┬────────────────────┐ 197 | │ │ │ │ 198 | │ Some text │ Some more t │ Some more text │ 199 | │ │ and more │ and more │ 200 | │ │ │ even more │ 201 | │ │ │ │ 202 | ├──────────────────────────────┼───────────────┼────────────────────┤ 203 | │ │ │ │ 204 | │ Some more text │ Some more t │ Some text │ 205 | │ and more │ and more │ │ 206 | │ even more │ │ │ 207 | │ │ │ │ 208 | └──────────────────────────────┴───────────────┴────────────────────┘""" 209 | ) 210 | 211 | 212 | if __name__ == "__main__": 213 | test_subplot_padding() 214 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = py3 3 | isolated_build = True 4 | 5 | [testenv] 6 | deps = 7 | numpy 8 | pytest 9 | pytest-cov 10 | pytest-codeblocks 11 | commands = 12 | pytest {posargs} --codeblocks 13 | --------------------------------------------------------------------------------