├── .deepsource.toml ├── .github └── workflows │ ├── publish-to-pypi.yml │ ├── python-package.yml │ └── ruff.yaml ├── .gitignore ├── CHANGELOG.txt ├── CONTRIBUTORS.txt ├── LICENSE.txt ├── MANIFEST.in ├── README.rst ├── example_python.png ├── example_sensors.png ├── setup.cfg ├── setup.py ├── sparklines ├── __init__.py ├── __main__.py └── sparklines.py └── tests ├── __init__.py ├── demo-output └── test_sparkline.py /.deepsource.toml: -------------------------------------------------------------------------------- 1 | version = 1 2 | 3 | [[analyzers]] 4 | name = "python" 5 | enabled = true 6 | 7 | [analyzers.meta] 8 | runtime_version = "3.x.x" -------------------------------------------------------------------------------- /.github/workflows/publish-to-pypi.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python 🐍 distribution 📦 to PyPI 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | jobs: 8 | build-and-publish: 9 | name: Build and publish to PyPI 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | - name: Set up Python 14 | uses: actions/setup-python@v2 15 | with: 16 | python-version: '3.x' 17 | - name: Install dependencies 18 | run: | 19 | python -m pip install --upgrade pip 20 | pip install setuptools wheel twine 21 | - name: Build dist 22 | run: | 23 | python setup.py sdist bdist_wheel 24 | - name: Publish distribution 📦 to PyPI 25 | uses: pypa/gh-action-pypi-publish@v1.4.2 26 | with: 27 | user: __token__ 28 | password: ${{ secrets.UPLOAD_SPARKLINES_PYPI_API_TOKEN }} 29 | -------------------------------------------------------------------------------- /.github/workflows/python-package.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ "main" ] 9 | pull_request: 10 | branches: [ "main" ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | fail-fast: false 18 | matrix: 19 | python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "pypy-3.9"] 20 | 21 | steps: 22 | - uses: actions/checkout@v3 23 | - name: Set up Python ${{ matrix.python-version }} 24 | uses: actions/setup-python@v3 25 | with: 26 | python-version: ${{ matrix.python-version }} 27 | - name: Install dependencies 28 | run: | 29 | python -m pip install --upgrade pip 30 | python -m pip install pytest 31 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 32 | python -m pip install -e . 33 | - name: Test with pytest 34 | run: | 35 | pytest tests 36 | -------------------------------------------------------------------------------- /.github/workflows/ruff.yaml: -------------------------------------------------------------------------------- 1 | # https://github.com/chartboost/ruff-action 2 | name: Ruff 3 | 4 | on: [push, pull_request] 5 | 6 | jobs: 7 | ruff: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v3 11 | - uses: astral-sh/ruff-action@v3 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | 61 | #Ipython Notebook 62 | .ipynb_checkpoints 63 | -------------------------------------------------------------------------------- /CHANGELOG.txt: -------------------------------------------------------------------------------- 1 | 0.1.0: Initial version (unreleased) 2 | 3 | 0.2.0: First released version: 4 | 5 | - increased resolution with multiple output lines per sparkline 6 | - show gaps in input numbers for missing data 7 | - issue warnings for negative values (allowed, but misleading) 8 | - tested on Python 2 and 3 9 | - packaged code 10 | 11 | 0.3.0: Second release: 12 | 13 | - removed typos related to singular/plural forms of "sparkline/s" 14 | - added color emphasis in output using "termcolor" package (if present) 15 | 16 | 0.4.0: Third release: 17 | 18 | - made rounding consistent across Python 2 and 3 (bankers' rounding) 19 | - added future dependancy for this kind of rounding in Python 2 20 | - added filter to unclutter input numbers (remove commas, etc.) 21 | - added tox support 22 | - added more tests 23 | - added asciicast to README.rst 24 | 25 | 0.4.1: Fourth release: 26 | 27 | - improved command-line option -e/--emphasize to take only one argument, 28 | but can be used repeatedly now, which reduces unexpected behaviour 29 | 30 | 0.4.2: Fifth release: 31 | 32 | - fixed a buglet preventing pip install without future already installed 33 | 34 | 0.5.0: Sixth release: 35 | 36 | - dropped Python 2 support 37 | - replaced Travis build with GitHub build action 38 | - removed minified pytest code 39 | - added a fix regarding regex for Python 3.12 40 | -------------------------------------------------------------------------------- /CONTRIBUTORS.txt: -------------------------------------------------------------------------------- 1 | Dinu Gherman 2 | Tal Wrii 3 | Michael Gisi 4 | aldencolerain 5 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | 676 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include CHANGELOG.txt 2 | include CONTRIBUTORS.txt 3 | include LICENSE.txt 4 | include README.rst 5 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Sparklines 2 | ========== 3 | 4 | .. image:: https://img.shields.io/github/actions/workflow/status/deeplook/sparklines/python-package.yml 5 | :target: https://pypi.org/project/sparklines 6 | 7 | .. image:: https://img.shields.io/pypi/pyversions/sparklines.svg 8 | :target: https://pypi.org/project/sparklines 9 | 10 | .. image:: https://img.shields.io/pypi/v/sparklines.svg 11 | :target: https://pypi.org/project/sparklines/ 12 | 13 | .. image:: https://static.pepy.tech/badge/sparklines/month 14 | :target: https://pepy.tech/project/sparklines 15 | 16 | .. image:: https://img.shields.io/pypi/status/sparklines.svg 17 | :target: https://pypi.org/project/sparklines 18 | 19 | .. image:: https://img.shields.io/pypi/format/sparklines.svg 20 | :target: https://pypi.org/project/sparklines 21 | 22 | .. image:: https://img.shields.io/pypi/l/sparklines.svg 23 | :target: https://pypi.org/project/sparklines 24 | 25 | This Python package implements Edward Tufte's concept of sparklines_, but 26 | limited to text only e.g. like this: ▃▁▄▁▅█▂▅ (this I likely not displayed 27 | correctly in every browser). You can find more information about sparklines 28 | `on Wikipedia`_. This code was mainly developed for running simple 29 | plausibility tests in sensor networks as shown in fig. 1 below: 30 | 31 | .. figure:: https://raw.githubusercontent.com/deeplook/sparklines/main/example_sensors.png 32 | :width: 75% 33 | :alt: example usecase with sensor values 34 | :align: center 35 | 36 | Fig. 1: Example usecase for such "sparklines" on the command-line, 37 | showing IoT sensor values (generating code not included here). 38 | 39 | Due to limitations of available Unicode characters this works best when all 40 | values are positive. And even then true sparklines that look more like lines 41 | and less like bars are a real challenge, because they would need multiple 42 | characters with a single horizontal line on different vertical positions. This 43 | would work only with a dedicated font, which is way beyond the scope of this 44 | tool and which would significantly complicate its usage. So we stick to these 45 | characters: "▁▂▃▄▅▆▇█", and use a blank for missing values. 46 | 47 | Sample output 48 | ------------- 49 | 50 | This is a recorded sample session illustrating how to use ``sparklines`` (as 51 | GitHub doesn't render embedded Asciinema_ recordings you'll see here an image 52 | pointing to the respective 53 | `asciicast `_): 54 | 55 | .. image:: https://asciinema.org/a/5xwfvcrrk09fy3ml3a8n67hep.png 56 | :target: https://asciinema.org/a/5xwfvcrrk09fy3ml3a8n67hep 57 | 58 | Here is some example output on the command-line (please note that in some 59 | browsers the vertical alignment of these block characters might be displayed 60 | slightly wrong, the same effect can be seen for other repos referenced below): 61 | 62 | Examples for the code below: 63 | 64 | .. code-block:: bash 65 | 66 | $ sparklines 2 7 1 8 2 8 1 8 67 | ▂▇▁█▂█▁█ 68 | $ echo 2 7 1 8 2 8 1 8 | sparklines 69 | ▂▇▁█▂█▁█ 70 | $ sparklines < numbers.txt 71 | ▂▇▁█▂█▁█ 72 | $ sparklines 0 2. 1e0 73 | ▁█▅ 74 | 75 | 76 | Installation 77 | ------------ 78 | 79 | You can install this package using ``pip install sparklines`` from the `Python 80 | Package Index`_. 81 | You can also clone this repository and install it via ``python setup.py install`` 82 | or ``pip install -e .``. 83 | After installing, you will have access system-wide (or in your virtualenv 84 | if you have used that) to ``sparklines``, programmatically as well as via a 85 | command-line tool with the same name. 86 | 87 | Test 88 | ---- 89 | 90 | To run the test suite, download and unpack this repository or clone it, 91 | run `pip inastall pytest`, and run the command ``pytest tests`` in the 92 | unpacked archive. from the downloaded repository's root folder. 93 | 94 | 95 | Usage 96 | ----- 97 | 98 | Please note that the samples below might look a little funky (misaligned or 99 | even colored) in some browsers, but it should be totally fine when you print 100 | this in your terminal, Python or IPython session or your Python IDE of choice. 101 | Figure 2 below might show better what you should expect than the copied sample 102 | code thereafter: 103 | 104 | .. figure:: https://raw.githubusercontent.com/deeplook/sparklines/main/example_python.png 105 | :width: 65% 106 | :alt: example interactive invocation 107 | :align: center 108 | 109 | Fig. 2: Example invocation from a Python and an IPython session. 110 | 111 | 112 | Command-Line 113 | ............ 114 | 115 | Here are two sample invocations from the command-line, copied into this README: 116 | 117 | .. code-block:: console 118 | 119 | $ sparklines 1 2 3 4 5.0 null 3 2 1 120 | ▁▃▅▆█ ▅▃▁ 121 | 122 | $ sparklines -n 2 1 2 3 4 5.0 null 3 2 1 123 | ▁▅█ ▁ 124 | ▁▅███ █▅▁ 125 | 126 | 127 | Programmatic 128 | ............ 129 | 130 | And here are sample invocations from interactive Python sessions, copied into 131 | this README. The main function to use programmatically is 132 | ``sparklines.sparklines()``: 133 | 134 | .. code-block:: python 135 | 136 | In [1]: from sparklines import sparklines 137 | 138 | In [2]: for line in sparklines([1, 2, 3, 4, 5.0, None, 3, 2, 1]): 139 | ...: print(line) 140 | ...: 141 | ▁▃▅▆█ ▅▃▁ 142 | 143 | In [3]: for line in sparklines([1, 2, 3, 4, 5.0, None, 3, 2, 1], num_lines=2): 144 | print(line) 145 | ...: 146 | ▁▅█ ▁ 147 | ▁▅███ █▅▁ 148 | 149 | 150 | References 151 | ---------- 152 | 153 | This code was inspired by Zach Holman's `spark 154 | `_, converted to a Python module 155 | by Kenneth Reitz as `spark.py 156 | `_ 157 | and by RegKrieg to a Python package named `pysparklines `_. 158 | And Roger Allen provides an even `shorter spark.py 159 | `_. 160 | 161 | But since it is so short and easy to code in Python we can add a few nice 162 | extra features I was missing, like: 163 | 164 | - increasing resolution with multiple output lines per sparkline 165 | - showing gaps in input numbers for missing data 166 | - issuing warnings for negative values (allowed, but misleading) 167 | - highlighting values exceeding some threshold with a different 168 | color (if ``termcolor`` package is available) 169 | - wrapping long sparklines at some max. length 170 | - (todo) adding separator characters like ``:`` at regular intervals 171 | 172 | .. _Asciinema: https://asciinema.org 173 | .. _Python Package Index: https://pypi.python.org/pypi/sparklines/ 174 | .. _sparklines: http://www.edwardtufte.com/bboard/q-and-a-fetch-msg?msg_id=0001OR 175 | .. _on Wikipedia: https://en.wikipedia.org/wiki/Sparkline 176 | -------------------------------------------------------------------------------- /example_python.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/deeplook/sparklines/64a92a444b9f2283918e08c720bccbd839846f4e/example_python.png -------------------------------------------------------------------------------- /example_sensors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/deeplook/sparklines/64a92a444b9f2283918e08c720bccbd839846f4e/example_sensors.png -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description_file = README.rst 3 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import io 2 | import setuptools 3 | 4 | setuptools.setup( 5 | name="sparklines", 6 | version="0.5.0", 7 | author="Dinu Gherman", 8 | author_email="gherman@darwin.in-berlin.de", 9 | description="Generate sparklines for numbers using Unicode characters only.", 10 | license="GPL", 11 | keywords="visualization, chart, tool", 12 | url="https://github.com/deeplook/sparklines", 13 | packages=setuptools.find_packages(exclude="test"), 14 | long_description=io.open("README.rst", encoding="utf-8").read(), 15 | install_requires=[], 16 | entry_points={"console_scripts": ["sparklines=sparklines.__main__:main"]}, 17 | classifiers=[ 18 | "Development Status :: 4 - Beta", 19 | "Environment :: Console", 20 | "Intended Audience :: Developers", 21 | "Intended Audience :: End Users/Desktop", 22 | "Intended Audience :: Other Audience", 23 | "Programming Language :: Python :: 3.8", 24 | "Programming Language :: Python :: 3.9", 25 | "Programming Language :: Python :: 3.10", 26 | "Programming Language :: Python :: 3.11", 27 | "Programming Language :: Python :: 3.12", 28 | "Programming Language :: Python :: Implementation :: PyPy", 29 | "License :: OSI Approved :: GNU General Public License (GPL)", 30 | ], 31 | ) 32 | -------------------------------------------------------------------------------- /sparklines/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from sparklines.sparklines import * # noqa: F403 4 | -------------------------------------------------------------------------------- /sparklines/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | CLI entry point for the program. 5 | """ 6 | 7 | import argparse 8 | import importlib.util 9 | import re 10 | import sys 11 | from importlib.metadata import version 12 | 13 | if importlib.util.find_spec("termcolor"): 14 | HAVE_TERMCOLOR = True 15 | else: 16 | HAVE_TERMCOLOR = False 17 | 18 | if sys.version_info.major >= 3: 19 | from sparklines.sparklines import sparklines, demo 20 | else: 21 | from sparklines import sparklines, demo 22 | 23 | 24 | def _float_or_none(num_str): 25 | """Convert a string to a float if possible or None.""" 26 | 27 | try: 28 | res = float(num_str) 29 | except ValueError: 30 | res = None 31 | return res 32 | 33 | 34 | def test_valid_number(arg): 35 | """Argparse validator for input numbers, basically floats or null/none.""" 36 | # https://stackoverflow.com/questions/385558/extract-float-double-value 37 | 38 | # ok if we find (can parse) a float, returning the respective substring 39 | float_pat = r"[+-]? *(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?" 40 | m = re.search(float_pat, arg) 41 | if m: 42 | return m.group(0) 43 | 44 | # ok if we find a 'null' or 'none' string which is then returned 45 | m = re.search("(null|none)", arg.lower()) 46 | if m: 47 | return m.group(0) 48 | 49 | # otherwise not ok, making argparse barf 50 | raise ValueError() 51 | 52 | 53 | def test_valid_emphasis(arg): 54 | """Argparse validator for color filter expressions.""" 55 | 56 | pat = r"\w+\:(eq|gt|ge|lt|le)\:.+" 57 | if re.match(pat, arg): 58 | return arg 59 | else: 60 | raise ValueError() 61 | 62 | 63 | def main(argv=None): 64 | desc = """Sparklines on the command-line, e.g. ▃▁▄▁▄█▂▅ for 65 | 3 1 4 1 5 9 2 6. Please add bug reports and suggestions to 66 | https://github.com/deeplook/sparklines/issues.""" 67 | p = argparse.ArgumentParser(description=desc) 68 | 69 | p.add_argument( 70 | "-v", 71 | "--verbose", 72 | action="store_true", 73 | help="Provide more verbose (debugging) output (none for now).", 74 | ) 75 | 76 | p.add_argument( 77 | "-V", 78 | "--version", 79 | action="version", 80 | help="Display version number and quit.", 81 | version=version("sparklines"), 82 | ) 83 | 84 | help_d = """Show a few usage examples for given (mandatory) input 85 | values. All other options are ignored.""" 86 | p.add_argument("-d", "--demo", action="store_true", help=help_d) 87 | 88 | p.add_argument( 89 | "-m", "--min", type=float, help="Use this value as the minimum for scaling." 90 | ) 91 | 92 | p.add_argument( 93 | "-M", "--max", type=float, help="Use this value as the maximum for scaling." 94 | ) 95 | 96 | help_emph = """Emphasize input values below or above a certain 97 | threshold (e.g. "green:gt:5.0"). This option takes one argument 98 | value, but can be given repeatedly. Works only when optional 99 | dependancy "termcolor" is met (which is {0!s} here). Otherwise 100 | has no effect.""".format( 101 | HAVE_TERMCOLOR 102 | ) 103 | p.add_argument( 104 | "-e", 105 | "--emphasize", 106 | metavar="STRING", 107 | type=test_valid_emphasis, 108 | default=[], 109 | action="append", 110 | help=help_emph, 111 | ) 112 | 113 | help_n = """The number of lines for one sparkline (higher numbers 114 | increase the resolution). An integer >= 1 (default: 1).""" 115 | p.add_argument( 116 | "-n", "--num-lines", metavar="NUMBER", help=help_n, default="1", type=int 117 | ) 118 | 119 | help_nums = """A positive numeric value >= 0, e.g. 0, 3.14, 2e2. 120 | Negative numbers work, too, but will give unexpected results 121 | and raise a warning. The string values null and None (in any 122 | spelling) represent empty slots, but not the value 0!""" 123 | p.add_argument( 124 | "nums", 125 | metavar="VALUE", 126 | type=test_valid_number, 127 | help=help_nums, 128 | nargs="*", 129 | default=sys.stdin, 130 | ) 131 | 132 | help_wrap = """Wrap the graph to a new line after PERIOD 133 | data points. This is useful for data with natural periodicity: 134 | for example daily or weekly. 135 | """ 136 | p.add_argument("-w", "--wrap", metavar="PERIOD", type=int, help=help_wrap) 137 | 138 | a = args = p.parse_args(argv) 139 | 140 | numbers = args.nums 141 | if numbers == sys.stdin: 142 | numbers = numbers.read().strip().split() 143 | numbers = [_float_or_none(n) for n in numbers] 144 | 145 | if args.demo: 146 | print(demo(numbers)) 147 | sys.exit() 148 | 149 | for line in sparklines( 150 | numbers, 151 | num_lines=a.num_lines, 152 | emph=a.emphasize, 153 | verbose=a.verbose, 154 | minimum=a.min, 155 | maximum=a.max, 156 | wrap=args.wrap, 157 | ): 158 | print(line) 159 | 160 | 161 | if __name__ == "__main__": 162 | main() 163 | -------------------------------------------------------------------------------- /sparklines/sparklines.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | Text-based sparklines, e.g. on the command-line like this: ▃▁▄▁▄█▂▅. 5 | 6 | Please read the file README.rst for more information. 7 | """ 8 | 9 | import re 10 | import sys 11 | import warnings 12 | 13 | try: 14 | import termcolor 15 | 16 | HAVE_TERMCOLOR = True 17 | except ImportError: 18 | HAVE_TERMCOLOR = False 19 | 20 | 21 | blocks = " ▁▂▃▄▅▆▇█" 22 | 23 | 24 | def _check_negatives(numbers): 25 | """Raise warning for negative numbers.""" 26 | 27 | negatives = filter(lambda x: x < 0, filter(None, numbers)) 28 | if any(negatives): 29 | neg_values = ", ".join(map(str, negatives)) 30 | msg = "Found negative value(s): {0!s}. ".format(neg_values) 31 | msg += "While not forbidden, the output will look unexpected." 32 | warnings.warn(msg) 33 | 34 | 35 | def _check_emphasis(numbers, emph): 36 | """Find index postions in list of numbers to be emphasized according to emph.""" 37 | 38 | pat = r"(\w+)\:(eq|gt|ge|lt|le)\:(.+)" 39 | # find values to be highlighted 40 | emphasized = {} # index: color 41 | for (i, n) in enumerate(numbers): 42 | if n is None: 43 | continue 44 | for em in emph: 45 | color, op, value = re.match(pat, em).groups() 46 | value = float(value) 47 | if op == "eq" and n == value: 48 | emphasized[i] = color 49 | elif op == "gt" and n > value: 50 | emphasized[i] = color 51 | elif op == "ge" and n >= value: 52 | emphasized[i] = color 53 | elif op == "lt" and n < value: 54 | emphasized[i] = color 55 | elif op == "le" and n <= value: 56 | emphasized[i] = color 57 | return emphasized 58 | 59 | 60 | def scale_values(numbers, num_lines=1, minimum=None, maximum=None): 61 | """Scale input numbers to appropriate range.""" 62 | 63 | # find min/max values, ignoring Nones 64 | filtered = [n for n in numbers if n is not None] 65 | min_ = min(filtered) if minimum is None else minimum 66 | max_ = max(filtered) if maximum is None else maximum 67 | dv = max_ - min_ 68 | 69 | # clamp 70 | numbers = [max(min(n, max_), min_) if n is not None else None for n in numbers] 71 | 72 | if dv == 0: 73 | values = [4 * num_lines if x is not None else None for x in numbers] 74 | elif dv > 0: 75 | num_blocks = len(blocks) - 1 76 | 77 | min_index = 1.0 78 | max_index = num_lines * num_blocks 79 | 80 | values = [ 81 | ((max_index - min_index) * (x - min_)) / dv + min_index 82 | if x is not None 83 | else None 84 | for x in numbers 85 | ] 86 | 87 | values = [round(v) or 1 if v is not None else None for v in values] 88 | return values 89 | 90 | 91 | def sparklines( 92 | numbers=None, 93 | num_lines=1, 94 | emph=None, 95 | verbose=False, 96 | minimum=None, 97 | maximum=None, 98 | wrap=None, 99 | ): 100 | """ 101 | Return a list of 'sparkline' strings for a given list of input numbers. 102 | 103 | The list of input numbers may contain None values, too, for which the 104 | resulting sparkline will contain a blank character (a space). 105 | 106 | Examples: 107 | 108 | sparklines([3, 1, 4, 1, 5, 9, 2, 6]) 109 | -> ['▃▁▄▁▄█▂▅'] 110 | sparklines([3, 1, 4, 1, 5, 9, 2, 6], num_lines=2) 111 | -> [ 112 | ' █ ▂', 113 | '▅▁▆▁██▃█' 114 | ] 115 | """ 116 | if numbers is None: 117 | numbers = [] 118 | 119 | assert num_lines > 0 120 | 121 | if len(numbers) == 0: 122 | return [""] 123 | 124 | # raise warning for negative numbers 125 | _check_negatives(numbers) 126 | 127 | values = scale_values( 128 | numbers, num_lines=num_lines, minimum=minimum, maximum=maximum 129 | ) 130 | 131 | # find values to be highlighted 132 | emphasized = _check_emphasis(numbers, emph) if emph else {} 133 | 134 | point_index = 0 135 | subgraphs = [] 136 | for subgraph_values in batch(wrap, values): 137 | multi_values = [] 138 | for i in range(num_lines): 139 | multi_values.append( 140 | [min(v, 8) if v is not None else None for v in subgraph_values] 141 | ) 142 | subgraph_values = [ 143 | max(0, v - 8) if v is not None else None for v in subgraph_values 144 | ] 145 | multi_values.reverse() 146 | lines = [] 147 | for subgraph_values in multi_values: 148 | if HAVE_TERMCOLOR and emphasized: 149 | tc = termcolor.colored 150 | res = [ 151 | tc(blocks[int(v)], emphasized.get(point_index + i, "white")) 152 | if v is not None 153 | else " " 154 | for (i, v) in enumerate(subgraph_values) 155 | ] 156 | else: 157 | res = [ 158 | blocks[int(v)] if v is not None else " " for v in subgraph_values 159 | ] 160 | lines.append("".join(res)) 161 | subgraphs.append(lines) 162 | point_index += len(subgraph_values) 163 | 164 | return list_join("", subgraphs) 165 | 166 | 167 | def batch(batch_size, items): 168 | """Batch items into groups of batch_size.""" 169 | items = list(items) 170 | if batch_size is None: 171 | return [items] 172 | MISSING = object() 173 | padded_items = items + [MISSING] * (batch_size - 1) 174 | groups = zip(*[padded_items[i::batch_size] for i in range(batch_size)]) 175 | return [[item for item in group if item != MISSING] for group in groups] 176 | 177 | 178 | def list_join(separator, lists): 179 | result = [] 180 | for lst, _next in zip(lists[:], lists[1:]): 181 | result.extend(lst) 182 | result.append(separator) 183 | 184 | if lists: 185 | result.extend(lists[-1]) 186 | return result 187 | 188 | 189 | def demo(nums=None): 190 | """Print a few usage examples on stdout.""" 191 | if nums is None: 192 | nums = [] 193 | 194 | nums = nums or [3, 1, 4, 1, 5, 9, 2, 6] 195 | 196 | def fmt(num): 197 | return "{0:g}".format(num) if isinstance(num, (float, int)) else "None" 198 | 199 | nums1 = list(map(fmt, nums)) 200 | 201 | if __name__ == "__main__": 202 | prog = sys.argv[0] 203 | else: 204 | prog = "sparklines" 205 | 206 | result = [] 207 | 208 | result.append("Usage examples (command-line and programmatic use):") 209 | result.append("") 210 | 211 | result.append("- Standard one-line sparkline") 212 | result.append("{0!s} {1!s}".format(prog, " ".join(nums1))) 213 | result.append(">>> print(sparklines([{0!s}])[0])".format(", ".join(nums1))) 214 | result.append(sparklines(nums)[0]) 215 | result.append("") 216 | 217 | result.append("- Multi-line sparkline (n=2)") 218 | result.append("{0!s} -n 2 {1!s}".format(prog, " ".join(nums1))) 219 | result.append( 220 | ">>> for line in sparklines" 221 | "([{0!s}], num_lines=2): print(line)".format(", ".join(nums1)) 222 | ) 223 | for line in sparklines(nums, num_lines=2): 224 | result.append(line) 225 | result.append("") 226 | 227 | result.append("- Multi-line sparkline (n=3)") 228 | result.append("{0!s} -n 3 {1!s}".format(prog, " ".join(nums1))) 229 | result.append( 230 | ">>> for line in sparklines" 231 | "([{0!s}], num_lines=3): print(line)".format(", ".join(nums1)) 232 | ) 233 | for line in sparklines(nums, num_lines=3): 234 | result.append(line) 235 | result.append("") 236 | 237 | nums = nums + [None] + list(reversed(nums[:])) 238 | result.append("- Standard one-line sparkline with gap") 239 | result.append("{0!s} {1!s}".format(prog, " ".join(map(str, nums)))) 240 | result.append(">>> print(sparklines([{0!s}])[0])".format(", ".join(map(str, nums)))) 241 | result.append(sparklines(nums)[0]) 242 | return "\n".join(result) + "\n" 243 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/deeplook/sparklines/64a92a444b9f2283918e08c720bccbd839846f4e/tests/__init__.py -------------------------------------------------------------------------------- /tests/demo-output: -------------------------------------------------------------------------------- 1 | Usage examples (command-line and programmatic use): 2 | 3 | - Standard one-line sparkline 4 | sparklines 3 1 4 1 5 9 2 6 5 | >>> print(sparklines([3, 1, 4, 1, 5, 9, 2, 6])[0]) 6 | ▃▁▄▁▄█▂▅ 7 | 8 | - Multi-line sparkline (n=2) 9 | sparklines -n 2 3 1 4 1 5 9 2 6 10 | >>> for line in sparklines([3, 1, 4, 1, 5, 9, 2, 6], num_lines=2): print(line) 11 | █ ▂ 12 | ▅▁▇▁██▃█ 13 | 14 | - Multi-line sparkline (n=3) 15 | sparklines -n 3 3 1 4 1 5 9 2 6 16 | >>> for line in sparklines([3, 1, 4, 1, 5, 9, 2, 6], num_lines=3): print(line) 17 | █ 18 | ▂ ▄█ ▇ 19 | ▇▁█▁██▄█ 20 | 21 | - Standard one-line sparkline with gap 22 | sparklines 3 1 4 1 5 9 2 6 None 6 2 9 5 1 4 1 3 23 | >>> print(sparklines([3, 1, 4, 1, 5, 9, 2, 6, None, 6, 2, 9, 5, 1, 4, 1, 3])[0]) 24 | ▃▁▄▁▄█▂▅ ▅▂█▄▁▄▁▃ 25 | -------------------------------------------------------------------------------- /tests/test_sparkline.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | Run from the root folder with either 'python setup.py test' or 5 | 'py.test test/test_sparkline.py'. 6 | """ 7 | 8 | import os 9 | import re 10 | from pathlib import Path 11 | 12 | import pytest 13 | 14 | from sparklines import batch, scale_values, sparklines, demo 15 | from sparklines.__main__ import test_valid_number as is_valid_number, main 16 | 17 | 18 | def strip_ansi(text): 19 | """Remove ANSI escape sequences from a text.""" 20 | # http://stackoverflow.com/questions/14693701/how-can-i-remove-the-ansi-escape-sequences-from-a-string-in-python#14693789 21 | ansi_escape = re.compile(r"\x1b[^m]*m") 22 | return ansi_escape.sub("", text) 23 | 24 | 25 | def test_parse_float(): 26 | """Test parsing input numbers.""" 27 | 28 | t = is_valid_number 29 | 30 | assert t("4.5") == "4.5" 31 | assert t("-4.5") == "-4.5" 32 | assert t("4.") == "4." 33 | assert t(".5") == ".5" 34 | assert t("4.5e0") == "4.5e0" 35 | assert t("-4.5e0") == "-4.5e0" 36 | assert t("-4.5e-2") == "-4.5e-2" 37 | assert t("-.5e-2") == "-.5e-2" 38 | 39 | assert t("4.5,") == "4.5" 40 | assert t("4.5;") == "4.5" 41 | assert t('"4.5"') == "4.5" 42 | assert t("(4.5)") == "4.5" 43 | 44 | assert t("null") == "null" 45 | assert t("Null") == "null" 46 | assert t("none") == "none" 47 | assert t("None") == "none" 48 | 49 | assert t("None,") == "none" 50 | 51 | with pytest.raises(ValueError): 52 | t(",") 53 | with pytest.raises(ValueError): 54 | t("invalid") 55 | 56 | 57 | def test_scale0(): 58 | """Test scale...""" 59 | 60 | res = scale_values([1, 2, 3]) 61 | exp = [1.0, 4.0, 8.0] 62 | assert res == exp 63 | 64 | 65 | def test_scale1(): 66 | """Test scale...""" 67 | 68 | res = scale_values([1, 2, 3], num_lines=2) 69 | exp = [1.0, 8.0, 16.0] 70 | assert res == exp 71 | 72 | 73 | def test_batch(): 74 | batches = batch(3, range(10)) 75 | assert batches == [[0, 1, 2], [3, 4, 5], [6, 7, 8], [9]], batches 76 | 77 | batches = batch(None, range(3)) 78 | assert batches == [[0, 1, 2]] 79 | 80 | 81 | def test_scale_pi(): 82 | """Test scale Pi.""" 83 | 84 | res = scale_values([3, 1, 4, 1, 5, 9, 2, 6]) 85 | exp = [3, 1, 4, 1, 4, 8, 2, 5] 86 | assert res == exp 87 | 88 | 89 | def test_pi(): 90 | """Test first eight digits of Pi.""" 91 | 92 | res = sparklines([3, 1, 4, 1, 5, 9, 2, 6]) 93 | exp = ["▃▁▄▁▄█▂▅"] 94 | assert res == exp 95 | 96 | 97 | def test_minmax(): 98 | """Test two values, min and max.""" 99 | 100 | res = sparklines([1, 8]) 101 | exp = ["▁█"] # 1, 8 102 | assert res == exp 103 | 104 | 105 | def test_rounding0(): 106 | """Test two values, min and max.""" 107 | 108 | res = sparklines([1, 5, 8]) 109 | exp = ["▁▅█"] # 1, 5, 8 110 | assert res == exp 111 | 112 | 113 | def test_maximum(): 114 | res = sparklines([1, 2, 3, 10, 10], maximum=3) 115 | exp = ["▁▄███"] 116 | assert res == exp 117 | 118 | 119 | def test_maximum_internal_consistency(): 120 | res = sparklines([1, 2, 3, 10, 10, 1], maximum=3) 121 | exp = sparklines([1, 2, 3, 3, 3, 1], maximum=3) 122 | assert res == exp 123 | 124 | 125 | def test_minimum(): 126 | res = sparklines([0, 0, 11, 12, 13], minimum=10) 127 | exp = ["▁▁▃▆█"] 128 | assert res == exp 129 | 130 | 131 | def test_minimum_internal_consistency(): 132 | res = sparklines([0, 0, 11, 12, 13], minimum=10) 133 | exp = sparklines([10, 10, 11, 12, 13], minimum=10) 134 | assert res == exp 135 | 136 | 137 | def test1(): 138 | """Test single values all have the same four pixel high output character.""" 139 | 140 | for i in range(10): 141 | res = sparklines([i]) 142 | exp = ["▄"] 143 | assert res == exp 144 | 145 | 146 | def test_empty(): 147 | """Make sure degenerate cases don't fail.""" 148 | 149 | res = sparklines([]) 150 | exp = [""] 151 | # Produces an empty line from the command line 152 | # we might prefer empty output 153 | assert res == exp 154 | 155 | 156 | def test_multiline(): 157 | res = sparklines([1, 5, 8], num_lines=3) 158 | exp = [" █", " ▆█", "▁██"] 159 | assert res == exp 160 | 161 | 162 | def test_wrap(): 163 | res = sparklines([1, 2, 3, 1, 2, 3, 1, 2], wrap=3) 164 | exp = ["▁▄█", "", "▁▄█", "", "▁▄"] 165 | assert res == exp 166 | 167 | 168 | def test_wrap_scale(): 169 | res = sparklines([100, 50, 100, 20, 50, 20, 1, 1, 1], wrap=3) 170 | exp = ["█▄█", "", "▂▄▂", "", "▁▁▁"] 171 | assert res == exp 172 | 173 | 174 | def test_wrap_consistency(): 175 | res = sparklines([1, 2, 3, 1, 2, 3, 1, 2], wrap=3) 176 | exp = ( 177 | sparklines([1, 2, 3], maximum=3, minimum=1) 178 | + [""] 179 | + sparklines([1, 2, 3], maximum=3, minimum=1) 180 | + [""] 181 | + sparklines([1, 2], maximum=3, minimum=1) 182 | ) 183 | assert res == exp 184 | 185 | 186 | def test_wrap_escaping_consistency(): 187 | no_emph = sparklines([1, 2, 3, 1, 2, 3, 1, 2], wrap=3) 188 | stripped_emph = map( 189 | strip_ansi, sparklines([1, 2, 3, 1, 2, 3, 1, 2], wrap=3, emph=["green:le:1.0"]) 190 | ) 191 | assert no_emph == list(stripped_emph) 192 | 193 | 194 | def _test_wrap_escaping(): 195 | res = sparklines([1, 10, 1, 10, 1, 10], emph=["green:ge:2.0"], wrap=3) 196 | exp = [ 197 | "\x1b[37m▁\x1b[0m\x1b[32m█\x1b[0m\x1b[37m▁\x1b[0m", 198 | "", 199 | "\x1b[32m█\x1b[0m\x1b[37m▁\x1b[0m\x1b[32m█\x1b[0m", 200 | ] 201 | assert exp == res, (exp, res) 202 | 203 | 204 | def test_gaps(): 205 | res = sparklines([1, None, 1, 2]) 206 | exp = ["▁ ▁█"] 207 | assert exp == res 208 | res = sparklines([1, None, 1]) 209 | exp = ["▄ ▄"] 210 | assert exp == res, (exp, res) 211 | 212 | 213 | def test_demo_consistency(): 214 | ## todo: remove encoding hacks 215 | toplevel = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) 216 | with open(os.path.join(toplevel, "tests", "demo-output")) as stream: 217 | exp = stream.read() 218 | try: 219 | exp = exp.decode("utf8") 220 | except AttributeError: 221 | pass 222 | res = demo([]) 223 | 224 | with open("/tmp/blah", "w") as stream: 225 | try: 226 | stream.write(res) # .encode('utf8')) 227 | except UnicodeEncodeError: 228 | stream.write(res.encode("utf8")) 229 | 230 | assert exp == res, "Demo output has changed. Verify it and update demo-output!" 231 | 232 | 233 | def test_main_version(capsys): 234 | setup_py = Path(__file__).parent.parent / "setup.py" 235 | match = re.search('version="(.+)"', setup_py.read_text()) 236 | assert match 237 | expected_version = match.group(1) 238 | 239 | with pytest.raises(SystemExit) as excinfo: 240 | main(("--version",)) 241 | assert excinfo.value.code == 0 242 | 243 | out, _ = capsys.readouterr() 244 | assert out == f"{expected_version}\n" 245 | --------------------------------------------------------------------------------