├── test ├── __init__.py └── test_pyfancy.py ├── pyfancy ├── demo │ └── import.txt ├── __init__.py ├── demo.py └── pyfancy.py ├── requirements.txt ├── PULL_REQUEST_TEMPLATE.md ├── CONTRIBUTING.md ├── .travis.yml ├── setup.py ├── ISSUE_TEMPLATE.md ├── .gitignore ├── LICENSE ├── CODE_OF_CONDUCT.md ├── setup.cfg ├── README.rst └── NOTICE.md /test/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pyfancy/demo/import.txt: -------------------------------------------------------------------------------- 1 | {red hi} 2 | -------------------------------------------------------------------------------- /pyfancy/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = ["pyfancy"] 2 | 3 | from pyfancy import pyfancy 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pip==9.0.1 2 | pyformat==0.7 3 | pygments==2.2.0 4 | pypandoc==1.4 5 | pyroma==2.4 6 | ddt==1.2.0 -------------------------------------------------------------------------------- /PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ### What issue(s) does this fix? 2 | 3 | *This pr fixes #000* 4 | 5 | ### Is this complete or a WIP? 6 | 7 | *Complete* 8 | 9 | ### Other 10 | 11 | *Anything else that is important.* 12 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | - Every PR must be reviewed by one other person at the least before getting merged. 2 | - Proper tags must be used for organization + communication reasons. 3 | - Travis must pass before merging. 4 | - If you want to tackle an issue assign yourself or if you want to suggest someone else assign them. 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | python: 4 | - 2.7 5 | - 3.4 6 | - 3.5 7 | - 3.6 8 | - nightly 9 | 10 | matrix: 11 | allow_failures: 12 | - python: nightly 13 | 14 | install: 15 | - sudo apt-get install pandoc 16 | - python -m pip install -r requirements.txt 17 | 18 | before_script: 19 | - pyformat --in-place pyfancy/pyfancy.py pyfancy/demo.py 20 | - pyroma . 21 | 22 | script: 23 | - python pyfancy/demo.py 24 | - python -m pytest 25 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """A setuptools based setup module. 2 | 3 | See: 4 | https://packaging.python.org/en/latest/distributing.html 5 | https://github.com/pypa/sampleproject 6 | """ 7 | 8 | # Always prefer setuptools over distutils 9 | from setuptools import setup 10 | 11 | setup( 12 | # Although 'package_data' is the preferred approach, in some case you may 13 | # need to place data files outside of your packages. See: 14 | # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa 15 | # In this case, 'data_file' will be installed into '/my_data' 16 | ) 17 | -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Problem Template 2 | 3 | *What is your problem in as much detail as possible.* 4 | 5 | ### What SHOULD happen? 6 | 7 | *Tell us what you think should happen.* 8 | 9 | ### What DOES happen? 10 | 11 | *What happens that should not.* 12 | 13 | ### Steps to reproduce 14 | 1. I did this 15 | 16 | ### Python version and OS 17 | 18 | *Python 2.7 and MacOS High Siera* 19 | 20 | ### Other (logs, code or anything else that is important) 21 | 22 | ``` 23 | ``` 24 | 25 | # Suggestion Template 26 | 27 | ### What are you requesting? 28 | 29 | *Tell us your suggestion in as much detail as possible. Give us examples how it could be used.* 30 | 31 | ### How could this be implemented. 32 | 33 | *Syntax/Libraries/Code* 34 | -------------------------------------------------------------------------------- /pyfancy/demo.py: -------------------------------------------------------------------------------- 1 | from pyfancy import pyfancy 2 | 3 | pyfancy().red("Hello").raw(", ").blue("world!").output() 4 | pyfancy().multi("Multicolored text").output() 5 | pyfancy().rainbow("Rainbow text").output() 6 | pyfancy("{red foo {bold bar} baz}").output() 7 | pyfancy().black_bg("Black background").output() 8 | pyfancy().green_bg("Green background").output() 9 | pyfancy().red_bg("Red background").output() 10 | pyfancy().black().yellow_bg("Yellow background").output() 11 | pyfancy().blue_bg("Blue background").output() 12 | pyfancy().purple_bg("Purple background").output() 13 | pyfancy().cyan_bg("Cyan background").output() 14 | pyfancy().black().gray_bg("Gray background").output() 15 | pyfancy().read("pyfancy/demo/import.txt").output() 16 | pyfancy().red("This should not be seen!").reset().output() 17 | print(pyfancy().red("Hello").raw(", ").blue("world!").strip()) 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ###Python### 2 | 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | env/ 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | downloads/ 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 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | 45 | # Translations 46 | *.mo 47 | *.pot 48 | 49 | # Django stuff: 50 | *.log 51 | 52 | # Sphinx documentation 53 | docs/_build/ 54 | 55 | # PyBuilder 56 | target/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Cosmic Open Source Projects 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /test/test_pyfancy.py: -------------------------------------------------------------------------------- 1 | import os 2 | import tempfile 3 | import unittest 4 | 5 | from ddt import data, ddt, unpack 6 | from pyfancy.pyfancy import pyfancy 7 | 8 | 9 | def ESCAPE(code): 10 | return '\033[{}m'.format(code) 11 | 12 | 13 | RESET_FMT = ESCAPE(0) 14 | TEST_DATA = [{'name': k, 'code': v} for k, v in pyfancy.codes.items()] 15 | 16 | 17 | def color(name, text, reset=True): 18 | colored = ESCAPE(pyfancy.codes[name]) + text 19 | if reset: 20 | colored += RESET_FMT 21 | return colored 22 | 23 | 24 | @ddt 25 | class PyfancyTest(unittest.TestCase): 26 | @data(*TEST_DATA) 27 | @unpack 28 | def test_code(self, name, code): 29 | expected = ESCAPE(code) + 'test' + RESET_FMT 30 | actual = getattr(pyfancy(), name)('test').get() 31 | self.assertEqual(actual, expected) 32 | 33 | def test_mixed(self): 34 | expected = color('red', 'foo', False) 35 | expected += color('blue', 'bar') 36 | actual = pyfancy().red('foo').blue('bar').get() 37 | self.assertEqual(actual, expected) 38 | 39 | def test_rainbow(self): 40 | text = 'rpygcb' 41 | expected = ''.join( 42 | color(c, ch, c == 'blue') 43 | for c, ch in zip( 44 | ['red', 'light_red', 'yellow', 'green', 'light_blue', 'blue'], 45 | text 46 | ) 47 | ) 48 | actual = pyfancy().rainbow(text).get() 49 | self.assertEqual(actual, expected) 50 | 51 | def test_reset(self): 52 | expected = color('red', 'test') 53 | pf = pyfancy().red('test') 54 | self.assertEqual(pf.get(), expected) 55 | expected = '\x1b[0m' 56 | actual = pf.reset().get() 57 | self.assertEqual(actual, expected) 58 | 59 | def test_read_from_file(self): 60 | fd, filename = tempfile.mkstemp() 61 | os.write(fd, '{red hi}\n'.encode()) 62 | os.close(fd) 63 | expected = color('red', 'hi') 64 | expected += '\n' + RESET_FMT 65 | actual = pyfancy().read(filename).get() 66 | os.remove(filename) 67 | self.assertEqual(actual, expected) 68 | 69 | 70 | if __name__ == '__main__': 71 | unittest.main() 72 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 6 | 7 | ## Our Standards 8 | 9 | Examples of behavior that contributes to creating a positive environment include: 10 | 11 | * Using welcoming and inclusive language 12 | * Being respectful of differing viewpoints and experiences 13 | * Gracefully accepting constructive criticism 14 | * Focusing on what is best for the community 15 | * Showing empathy towards other community members 16 | 17 | Examples of unacceptable behavior by participants include: 18 | 19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances 20 | * Trolling, insulting/derogatory comments, and personal or political attacks 21 | * Public or private harassment 22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission 23 | * Other conduct which could reasonably be considered inappropriate in a professional setting 24 | 25 | ## Our Responsibilities 26 | 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 28 | 29 | Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 30 | 31 | ## Scope 32 | 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 34 | 35 | ## Enforcement 36 | 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at andrewrodebaugh [at] gmail [dot] com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. 38 | 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 40 | 41 | ## Attribution 42 | 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] 44 | 45 | [homepage]: http://contributor-covenant.org 46 | [version]: http://contributor-covenant.org/version/1/4/ 47 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # setup.cfg configuration instead of setup.py 2 | # https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files 3 | [metadata] 4 | name = pyfancy 5 | description = "Simple terminal formatting in Python" 6 | long_description = file: README.rst 7 | # long_description = file: README.MD 8 | # Versions should comply with PEP440. For a discussion on single-sourcing 9 | # the version across setup.py and the project code, see 10 | # https://packaging.python.org/en/latest/single_source_version.html 11 | version = 2.4.5 12 | # Author details 13 | author = pyfancy 14 | author_email = aquahydration@gmail.com 15 | # The project's main homepage. 16 | url = https://github.com/ilovecode1/Pyfancy-2 17 | # Choose your license 18 | license = MIT 19 | # What does your project relate to? 20 | keywords = pyfancy ansi color colour terminal 21 | # See https://pypi.python.org/pypi?%3Aaction=list_classifiers 22 | # How mature is this project? Common values are 23 | # 3 - Alpha 24 | # 4 - Beta 25 | # 5 - Production/Stable 26 | # Indicate who your project is intended for 27 | # Pick your license as you wish (should match "license" above) 28 | # Specify the Python versions you support here. In particular, ensure 29 | # that you indicate whether you support Python 2, Python 3 or both. 30 | classifiers = 31 | Development Status :: 4 - Beta 32 | Intended Audience :: Developers 33 | Topic :: Software Development :: Build Tools 34 | License :: OSI Approved :: MIT License 35 | Programming Language :: Python :: 2 36 | Programming Language :: Python :: 2.7 37 | Programming Language :: Python :: 3 38 | Programming Language :: Python :: 3.3 39 | Programming Language :: Python :: 3.4 40 | Programming Language :: Python :: 3.5 41 | Programming Language :: Python :: 3.6 42 | 43 | [options] 44 | # Unpack your project to .egg or no? 45 | zip_safe = False 46 | # You can just specify the packages manually here if your project is 47 | # simple. Or you can use find. 48 | packages = find: 49 | # Alternatively, if you want to distribute just a my_module.py, uncomment 50 | # this: 51 | # py_modules=["my_module"], 52 | 53 | # List run-time dependencies here. These will be installed by pip when 54 | # your project is installed. For an analysis of "install_requires" vs pip's 55 | # requirements files see: 56 | # https://packaging.python.org/en/latest/requirements.html 57 | # install_requires = 58 | # pygments 59 | # pypandoc 60 | 61 | [options.extras_require] 62 | # List additional groups of dependencies here (e.g. development 63 | # dependencies). You can install these using the following syntax, 64 | # for example: 65 | # $ pip install -e .[dev,test] 66 | # dev = 67 | # check-manifest 68 | # test = 69 | # coverage 70 | 71 | [options.entry_points] 72 | # To provide executable scripts, use entry points in preference to the 73 | # "scripts" keyword. Entry points provide cross-platform support and allow 74 | # pip to create the appropriate form of executable for the target platform. 75 | # console_scripts = 76 | # sample = sample:main 77 | 78 | # [options.package_data] 79 | # sample = package_data.dat 80 | 81 | # [options.packages.find] 82 | # Exclude specific packages 83 | # exclude = 84 | # contrib 85 | # docs 86 | # tests 87 | 88 | [bdist_wheel] 89 | # This flag says that the code is written to work on both Python 2 and Python 90 | # 3. If at all possible, it is good practice to do this. If you cannot, you 91 | # will need to generate wheels for each Python version that you support. 92 | universal=1 93 | -------------------------------------------------------------------------------- /pyfancy/pyfancy.py: -------------------------------------------------------------------------------- 1 | # Provides methods for manipulating text styling in specific terminals. 2 | # Uses a basic chaining method where text properties are added by calling 3 | # methods with related names. 4 | # 5 | # For example, to print "Hello, world!" in red: 6 | # print pyfancy().red("Hello, world!").get() 7 | # 8 | # Styles can be changed for different text components. Example: 9 | # print pyfancy().red("Hello").raw(", ").blue("world!").get() 10 | # 11 | # No output text is necessary when calling a styling method. This allows 12 | # styles to be stacked: 13 | # print pyfancy().red().bold("Hello, world!").get() 14 | # 15 | # There are two provided ways to access the modified text. The first is 16 | # direct access to the string object called "out". However, accessing this 17 | # object will not reset the style, so any text outputted after will have 18 | # the same style as whatever the text was at the end of the chain. 19 | # 20 | # The get() method is better for accessing text because it resets the text 21 | # style so no new text will have unwanted styling. 22 | 23 | 24 | class pyfancy: 25 | 26 | def __str__(self): 27 | return self.get() 28 | 29 | def __init__(self, parseText='', obj=''): 30 | # Stores output text, for reset use get() 31 | self.out = str(obj) 32 | self.parseText = str(parseText) 33 | if (self.parseText != ''): 34 | self.parse(self.parseText) 35 | 36 | codes = { # The different escape codes 37 | 'raw': 0, 38 | 'bold': 1, 39 | 'dim': 2, 40 | 'underlined': 4, 41 | 'blinking': 5, 42 | 'inverted': 7, 43 | 'hidden': 8, 44 | 'black': 30, 45 | 'red': 31, 46 | 'green': 32, 47 | 'yellow': 33, 48 | 'blue': 34, 49 | 'magenta': 35, 50 | 'cyan': 36, 51 | 'light_gray': 37, 52 | 'black_bg': 40, 53 | 'red_bg': 41, 54 | 'green_bg': 42, 55 | 'yellow_bg': 43, 56 | 'blue_bg': 44, 57 | 'purple_bg': 45, 58 | 'cyan_bg': 46, 59 | 'gray_bg': 47, 60 | 'dark_gray': 90, 61 | 'light_red': 91, 62 | 'light_green': 92, 63 | 'light_yellow': 93, 64 | 'light_blue': 94, 65 | 'light_magenta': 95, 66 | 'light_cyan': 96, 67 | 'white': 97, 68 | 'dark_gray_bg': 100, 69 | 'light_red_bg': 101, 70 | 'light_green_bg': 102, 71 | 'light_yellow_bg': 103, 72 | 'light_blue_bg': 104, 73 | 'light_purple_bg': 105, 74 | 'light_cyan_bg': 106, 75 | 'white_bg': 107 76 | } 77 | 78 | # Stores output text, for reset use get() 79 | out = '' 80 | 81 | # Returns output text and resets properties 82 | def get(self): 83 | return self.out + '\033[0m' 84 | 85 | # Outputs text using print (should work in Python 2 and 3) 86 | def output(self): 87 | print(self.get()) 88 | 89 | # Adds new text without changing the styling 90 | def add(self, addition): 91 | self.out += addition 92 | return self 93 | 94 | def read(self, file): 95 | f = open(file, 'r') 96 | self.parse(f.read()) 97 | f.close() 98 | return self 99 | 100 | def reset(self): 101 | self.out = '' 102 | return self 103 | 104 | # Alternate between all the colours of the rainbow 105 | # No orange, replaced with lightRed 106 | # No purple/violet so I ignored it 107 | def rainbow(self, addition=''): 108 | x = 0 109 | for i in range(len(addition)): 110 | if (addition[i] in [' ', '\t', '\n', '\r']): 111 | x += 1 112 | [self.red, self.light_red, self.yellow, self.green, 113 | self.light_blue, self.blue][(i - x) % 6](addition[i]) 114 | return self 115 | 116 | def strip(self): 117 | text = '' 118 | i = 0 119 | while i < len(self.out): 120 | if self.out[i] == '\033': 121 | if i + 1 >= len(self.out): 122 | return text + '\033' 123 | if self.out[i + 1] == '[': 124 | i += 1 125 | if 'm' in self.out[i:]: 126 | while self.out[i] != 'm': 127 | i += 1 128 | i += 1 129 | else: 130 | text += '\033' 131 | text += self.out[i] 132 | i += 1 133 | return text 134 | 135 | # Simply apply the attribute with the given name 136 | def attr(self, name): 137 | if name in self.codes: 138 | self.out += '\033[%dm' % self.codes[name] 139 | 140 | # Parses text and automatically assigns attributes 141 | # Attributes are specified through brackets 142 | # For example, .parse("{red Hello}") is the same as .red("Hello") 143 | # Multiple attributes can be specified by commas, eg {red,bold Hello} 144 | # Brackets can be nested, eg {red Hello, {bold world}!} 145 | # Brackets can be escaped with backslashes 146 | def parse(self, text): 147 | i = 0 # Current index 148 | props = [] # Property stack; required for nested brackets 149 | while i < len(text): 150 | c = text[i] 151 | if c == '\\': # Escape character 152 | i += 1 153 | if i < len(text): 154 | self.out += text[i] 155 | elif c == '{': # New property list 156 | prop = '' # Current property 157 | i += 1 158 | curprops = [] # Properties that are part of this bracket 159 | while text[i] != ' ': 160 | if i + 1 == len(text): 161 | return self 162 | if text[i] == ',': 163 | # Properties separated by commas 164 | self.attr(prop) 165 | curprops.append(prop) 166 | prop = '' 167 | i += 1 168 | prop += text[i] 169 | i += 1 170 | self.attr(prop) 171 | curprops.append(prop) 172 | # Add properties to property stack 173 | props.append(curprops) 174 | elif c == '}': 175 | # Reset styling 176 | self.raw() 177 | # Remove last entry from property stack 178 | if len(props) >= 1: 179 | props.pop() 180 | # Apply all properties from any surrounding brackets 181 | for plist in props: 182 | for p in plist: 183 | self.attr(p) 184 | else: 185 | self.out += c 186 | i += 1 187 | return self 188 | 189 | # Multicolored text 190 | def multi(self, string): 191 | i = 31 # ID of escape code; starts at 31 (red) and goes to 36 (cyan) 192 | for c in string: # Iterate through string 193 | self.out += '\033[' + str(i) + 'm' + c 194 | i += 1 # Why u no have ++i? >:( 195 | if(i > 36): 196 | i = 31 197 | return self 198 | 199 | # Adds a formatting function to pyfancy with the specified name 200 | # and formatting code 201 | # This shouldn't be exported 202 | 203 | 204 | def _add(name, number): 205 | def inner(self, addition=''): 206 | self.out += '\033[%dm%s' % (number, addition) 207 | return self 208 | setattr(pyfancy, name, inner) 209 | 210 | 211 | # Generate all default color / format codes 212 | for item in pyfancy.codes.items(): 213 | if len(item) > 1: # Just in case 214 | _add(item[0], item[1]) 215 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | |Build Status| |FOSSA Status Shield Badge| 2 | 3 | Download 4 | ~~~~~~~~ 5 | 6 | Go to the `releases 7 | page `__ and download 8 | the latest (or previous) version. 9 | 10 | Or use pip ``pip install pyfancy`` 11 | 12 | Overview 13 | ~~~~~~~~ 14 | 15 | pyfancy is a simple Python library that provides a mechanism for easily 16 | styling text in some terminal environments. Text is styled by chaining 17 | together methods that add escape codes for color modifiers to the text. 18 | 19 | Usage 20 | ~~~~~ 21 | 22 | Formatting using pyfancy all follows the same basic pattern. First, 23 | there is the initializer, which just sets up the pyfancy object. Next is 24 | a chain of function calls that provide text formatting. Finally, there 25 | is a last method chained on which either returns the text string with 26 | format escape codes, or which directly outputs the text using the print 27 | statement / method. (The output method *should* be compatible with 28 | Python 2 and 3.) 29 | 30 | This chain of code looks basically like this: 31 | 32 | .. code:: python 33 | 34 | pyfancy().[chained statements].output() # To print using print statement / method 35 | pyfancy().[chained statements].get() # To get formatted text string 36 | 37 | There are two different ways to use the chained statements. The first is 38 | to provide the text that is to be chained as part of the statement call. 39 | For example, the following prints “Hello, world!” in red: 40 | 41 | .. code:: python 42 | 43 | pyfancy().red("Hello, world!").output() 44 | 45 | However, chained statements are really just modifiers with an optional 46 | text argument. The following example works identically to the previous 47 | example: 48 | 49 | .. code:: python 50 | 51 | pyfancy().red().add("Hello, world!").output() 52 | 53 | Using chained statements, then, allows for modifiers to be stacked: 54 | 55 | .. code:: python 56 | 57 | pyfancy().red().bold().add("Hello, world!").output() 58 | 59 | # or 60 | 61 | pyfancy().red().bold("Hello, world!").output() 62 | 63 | # The red() and bold() calls can also be in the opposite order. 64 | 65 | Of course, there can only be, for example, one color active at a time. 66 | This allows for the creation of multicolored statements: 67 | 68 | .. code:: python 69 | 70 | pyfancy().red("Hello").magenta(", ").blue("world!").output() 71 | 72 | It is also possible to reset all styles, either to get default styling, 73 | or to ensure that styles are reset, using the ``raw`` modifier: 74 | 75 | .. code:: python 76 | 77 | pyfancy().raw("You walk into a ").red().bold("DANGEROUS").raw(" room.").output() 78 | 79 | Parsing is a simple, shorter and faster way to use Pyfancy 2. Instead 80 | of: 81 | 82 | .. code:: python 83 | 84 | pyfancy().red("Hello").blue(" world!").output() 85 | 86 | You can do this: 87 | 88 | .. code:: python 89 | 90 | pyfancy("{red Hello {blue world!}}").output() 91 | 92 | For parsing you can also import from a text file: 93 | 94 | .. code:: python 95 | 96 | pyfancy().open("import.txt").output() 97 | 98 | In order to use pyfancy, import the module with 99 | ``from pyfancy.pyfancy import pyfancy``. 100 | 101 | Types of effects 102 | ~~~~~~~~~~~~~~~~ 103 | 104 | +-------------+-----------------+--------------+ 105 | | Text Effect | Background | | 106 | +=============+=================+==============+ 107 | | | | | 108 | +-------------+-----------------+--------------+ 109 | | bold | n/a | | 110 | +-------------+-----------------+--------------+ 111 | | dim | n/a | Light/Dark | 112 | +-------------+-----------------+--------------+ 113 | | underlined | n/a | n/a | 114 | +-------------+-----------------+--------------+ 115 | | blinking | n/a | n/a | 116 | +-------------+-----------------+--------------+ 117 | | black | black_bg | n/a | 118 | +-------------+-----------------+--------------+ 119 | | red | red_bg | dark_red | 120 | +-------------+-----------------+--------------+ 121 | | green | green_bg | dark_green | 122 | +-------------+-----------------+--------------+ 123 | | yellow | yellow_bg | dark_yellow | 124 | +-------------+-----------------+--------------+ 125 | | blue | blue_bg | dark_blue | 126 | +-------------+-----------------+--------------+ 127 | | magenta | n/a | dark_magenta | 128 | +-------------+-----------------+--------------+ 129 | | cyan | n/a | dark_cyan | 130 | +-------------+-----------------+--------------+ 131 | | n/a | gray_bg | light_gray | 132 | +-------------+-----------------+--------------+ 133 | | white | n/a | n/a | 134 | +-------------+-----------------+--------------+ 135 | | rainbow | n/a | n/a | 136 | +-------------+-----------------+--------------+ 137 | | multi | n/a | n/a | 138 | +-------------+-----------------+--------------+ 139 | | n/a | dark_gray_bg | dark_gray | 140 | +-------------+-----------------+--------------+ 141 | | n/a | light_red_bg | light_red | 142 | +-------------+-----------------+--------------+ 143 | | n/a | light_green_bg | light_green | 144 | +-------------+-----------------+--------------+ 145 | | n/a | light_yellow_bg | light_yellow | 146 | +-------------+-----------------+--------------+ 147 | | n/a | light_blue_bg | light_blue | 148 | +-------------+-----------------+--------------+ 149 | | n/a | light_purple_bg | light_purple | 150 | +-------------+-----------------+--------------+ 151 | | n/a | light_cyan_bg | light_cyan | 152 | +-------------+-----------------+--------------+ 153 | | n/a | white_bg | white | 154 | +-------------+-----------------+--------------+ 155 | 156 | License 157 | ~~~~~~~ 158 | 159 | Pyfancy-2 is under the MIT license. 160 | 161 | |FOSSA Status Large Badge| 162 | 163 | Contributors 164 | ~~~~~~~~~~~~ 165 | 166 | *Note:* Because v2 was made in a `fork`_ the contribution graph does not truely reflect the contributions made by the bellow contributers. 167 | 168 | Project by `CosmicWebServices`_ 169 | 170 | `TheMonsterFromTheDeep`_ 171 | 172 | `joker314`_ 173 | 174 | `baranskistad`_ 175 | 176 | `jonathan50`_ 177 | 178 | `rogersouza`_ 179 | 180 | `vutondesign`_ 181 | 182 | `cruxicheiros`_ 183 | 184 | `hiccup01`_ 185 | 186 | `Kristinita`_ 187 | 188 | .. _CosmicWebServices: https://github.com/CosmicWebServices 189 | .. _TheMonsterFromTheDeep: https://github.com/TheMonsterFromTheDeep 190 | .. _joker314: https://github.com/joker314 191 | .. _baranskistad: https://github.com/baranskistad 192 | .. _jonathan50: https://github.com/Jonathan50 193 | .. _rogersouza: https://github.com/rogersouza 194 | .. _vutondesign: https://github.com/vutondesign 195 | .. _cruxicheiros: https://github.com/cruxicheiros 196 | .. _hiccup01: https://github.com/hiccup01 197 | .. _Kristinita: https://github.com/Kristinita 198 | .. _fork: https://github.com/TheMonsterFromTheDeep/pyfancy 199 | 200 | .. |Build Status| image:: https://travis-ci.org/ilovecode1/Pyfancy-2.svg?branch=master 201 | :target: https://travis-ci.org/ilovecode1/Pyfancy-2 202 | .. |FOSSA Status Shield Badge| image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Filovecode1%2FPyfancy-2.svg?type=shield 203 | :target: https://app.fossa.io/projects/git%2Bgithub.com%2Filovecode1%2FPyfancy-2?ref=badge_shield 204 | .. |FOSSA Status Large Badge| image:: https://app.fossa.io/api/projects/git%2Bgithub.com%2Filovecode1%2FPyfancy-2.svg?type=large 205 | :target: https://app.fossa.io/projects/git%2Bgithub.com%2Filovecode1%2FPyfancy-2?ref=badge_large 206 | -------------------------------------------------------------------------------- /NOTICE.md: -------------------------------------------------------------------------------- 1 | # 3rd-Party Software for [Pyfancy-2]() 2 | 3 | The following 3rd-party software components may be used by or distributed with **Pyfancy-2**. This document was automatically generated by [FOSSA](http://fossa.io) on 01/19/18; any information relevant to third-party vendors listed below are collected using common, reasonable means. 4 | 5 | 6 | ## License Scan 7 | 8 | 9 | ### MIT License (Expat) 10 |

The MIT License (MIT)

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

11 | 12 | 13 | 14 | 15 | 16 | ## Direct Dependencies 17 | 18 | 19 | Library|Licenses 20 | -------|-------- 21 | **[pip (9.0.1)](#pip)**|mit 22 | 23 | 24 | 25 | 26 | ### Details 27 | 28 | 29 | #### **pip (9.0.1)** 30 | 31 | * Description 32 | pip 33 | === 34 | 35 | The `PyPA recommended 36 | `_ 37 | tool for installing Python packages. 38 | 39 | \* `Installation `_ 40 | \* `Documentation `_ 41 | \* `Changelog `_ 42 | \* `Github Page `_ 43 | \* `Issue Tracking `_ 44 | \* `User mailing list `_ 45 | \* `Dev mailing list `_ 46 | \* User IRC: #pypa on Freenode. 47 | \* Dev IRC: #pypa-dev on Freenode. 48 | 49 | 50 | .. image:: https://img.shields.io/pypi/v/pip.svg 51 | :target: https://pypi.python.org/pypi/pip 52 | 53 | .. image:: https://img.shields.io/travis/pypa/pip/master.svg 54 | :target: http://travis-ci.org/pypa/pip 55 | 56 | .. image:: https://img.shields.io/appveyor/ci/pypa/pip.svg 57 | :target: https://ci.appveyor.com/project/pypa/pip/history 58 | 59 | .. image:: https://readthedocs.org/projects/pip/badge/?version=stable 60 | :target: https://pip.pypa.io/en/stable 61 | 62 | Code of Conduct 63 | --------------- 64 | 65 | Everyone interacting in the pip project's codebases, issue trackers, chat 66 | rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_. 67 | 68 | .. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/ 69 | 70 | 71 | 72 | 73 | 74 | * Licenses 75 | * mit 76 | 77 | 78 | * Authors 79 | * [python-virtualenv@groups.google.com](author) 80 | 81 | 82 | * License tags 83 | * Open Source,OSI-Approved,Permissive 84 | 85 | 86 | * Other Licenses 87 | * CNRI Python License (CNRI-Python) 88 | * bsd3 89 | * Dual-license 90 | * lgpl2 91 | * apache2 92 | 93 | 94 | * Source 95 | * Pip 96 | 97 | 98 | * Project Url 99 | https://pip.pypa.io/ 100 | 101 | 102 | * Notes 103 | * Licensed under MIT. 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | ***Deep dependencies not included. Enable this in FOSSA to include deeper data.*** 113 | 114 | 115 | 116 | ## Licenses 117 | 118 | 119 | ### MIT License (Expat) 120 |

The MIT License (MIT)

Copyright (c) <year> <copyright holders>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

121 | 122 | ### CNRI Python License (CNRI-Python) 123 |

CNRI OPEN SOURCE LICENSE AGREEMENT

IMPORTANT: PLEASE READ THE FOLLOWING AGREEMENT CAREFULLY.

BY CLICKING ON "ACCEPT" WHERE INDICATED BELOW, OR BY COPYING, INSTALLING OR OTHERWISE USING PYTHON 1.6, beta 1 SOFTWARE, YOU ARE DEEMED TO HAVE AGREED TO THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT.

1. This LICENSE AGREEMENT is between the Corporation for National Research Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191 ("CNRI"), and the Individual or Organization ("Licensee") accessing and otherwise using Python 1.6, beta 1 software in source or binary form and its associated documentation, as released at the www.python.org Internet site on August 4, 2000 ("Python 1.6b1").

2. Subject to the terms and conditions of this License Agreement, CNRI hereby grants Licensee a non-exclusive, royalty-free, world-wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use Python 1.6b1 alone or in any derivative version, provided, however, that CNRIs License Agreement is retained in Python 1.6b1, alone or in any derivative version prepared by Licensee.

Alternately, in lieu of CNRIs License Agreement, Licensee may substitute the following text (omitting the quotes): "Python 1.6, beta 1, is made available subject to the terms and conditions in CNRIs License Agreement. This Agreement may be located on the Internet using the following unique, persistent identifier (known as a handle): 1895.22/1011. This Agreement may also be obtained from a proxy server on the Internet using the URL:http://hdl.handle.net/1895.22/1011".

3. In the event Licensee prepares a derivative work that is based on or incorporates Python 1.6b1 or any part thereof, and wants to make the derivative work available to the public as provided herein, then Licensee hereby agrees to indicate in any such work the nature of the modifications made to Python 1.6b1.

4. CNRI is making Python 1.6b1 available to Licensee on an "AS IS" basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6b1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING, MODIFYING OR DISTRIBUTING PYTHON 1.6b1, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of its terms and conditions.

7. This License Agreement shall be governed by and interpreted in all respects by the law of the State of Virginia, excluding conflict of law provisions. Nothing in this License Agreement shall be deemed to create any relationship of agency, partnership, or joint venture between CNRI and Licensee. This License Agreement does not grant permission to use CNRI trademarks or trade name in a trademark sense to endorse or promote products or services of Licensee, or any third party.

8. By clicking on the "ACCEPT" button where indicated, or by copying, installing or otherwise using Python 1.6b1, Licensee agrees to be bound by the terms and conditions of this License Agreement.

ACCEPT

124 | 125 | ### BSD 3-Clause License (Revised) 126 |

The BSD 3-Clause License The following is a BSD 3-Clause ("BSD New" or "BSD Simplified") license template. To generate your own license, change the values of OWNER, ORGANIZATION and YEAR from their original values as given here, and substitute your own.

Note: You may omit clause 3 and still be OSD-conformant. Despite its colloquial name "BSD New", this is not the newest version of the BSD license; it was followed by the even newer BSD-2-Clause version, sometimes known as the "Simplified BSD License". On January 9th, 2008 the OSI Board approved BSD-2-Clause, which is used by FreeBSD and others. It omits the final "no-endorsement" clause and is thus roughly equivalent to the MIT License.

Historical Background: The original license used on BSD Unix had four clauses. The advertising clause (the third of four clauses) required you to acknowledge use of U.C. Berkeley code in your advertising of any product using that code. It was officially rescinded by the Director of the Office of Technology Licensing of the University of California on July 22nd, 1999. He states that clause 3 is "hereby deleted in its entirety." The four clause license has not been approved by OSI. The license below does not contain the advertising clause.

This prelude is not part of the license.

OWNER = Regents of the University of California

ORGANIZATION = University of California, Berkeley

YEAR = 1998

In the original BSD license, both occurrences of the phrase "COPYRIGHT HOLDERS AND CONTRIBUTORS" in the disclaimer read "REGENTS AND CONTRIBUTORS".

License template

Copyright (c) $YEAR $OWNER, All rights reserved.

Redistribution and use in source and binary forms, with or without 127 | modification, are permitted provided that the following conditions are 128 | met:

    129 |
  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

130 | 131 | ### GNU Lesser General Public License v2.1 (LGPL-2.1) 132 |

GNU Lesser General Public License Version 2.1, February 1999

Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

[This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.]

Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users.

This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below.

When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things.

To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.

For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights.

We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.

To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others.

Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license.

Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs.

When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library.

We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances.

For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License.

In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system.

Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library.

The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run.

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you".

A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables.

The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".)

"Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library.

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does.

1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

a) The modified work must itself be a software library.

b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change.

c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License.

d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful.

(For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library.

In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices.

Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy.

This option is useful when you wish to copy part of the code of the Library into a program that is not a library.

4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.

If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code.

5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License.

However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables.

When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law.

If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.)

Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself.

6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications.

You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things:

a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.)

b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with.

c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution.

d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place.

e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy.

For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute.

7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things:

a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above.

b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.

8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it.

10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License.

11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation.

14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS

133 | 134 | ### Apache License 2.0 (Apache-2.0) 135 |

Apache License, Version 2.0 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License.

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License.

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution.

You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions.

Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks.

This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty.

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability.

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability.

While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

136 | 137 | 138 | 139 | 140 | 141 | [FOSSA]: # (Do not touch the comments below) 142 | 143 | [FOSSA]: # (==depsig=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855==) 144 | 145 | 146 | --------------------------------------------------------------------------------