effectual 0.1.0__py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- effectual/__init__.py +23 -0
- effectual/build.py +162 -0
- effectual/colors.py +63 -0
- effectual/config.py +27 -0
- effectual/dev.py +60 -0
- effectual/fileHash.py +32 -0
- effectual/minifier.py +51 -0
- effectual-0.1.0.dist-info/METADATA +19 -0
- effectual-0.1.0.dist-info/RECORD +12 -0
- effectual-0.1.0.dist-info/WHEEL +4 -0
- effectual-0.1.0.dist-info/entry_points.txt +2 -0
- effectual-0.1.0.dist-info/licenses/LICENSE +373 -0
effectual/__init__.py
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
import click
|
2
|
+
|
3
|
+
@click.group()
|
4
|
+
def main():
|
5
|
+
"""Effectual CLI - A simple command-line interface."""
|
6
|
+
pass
|
7
|
+
|
8
|
+
@click.command("dist")
|
9
|
+
def dist():
|
10
|
+
"""Bundles your source directory."""
|
11
|
+
from . import build
|
12
|
+
build.main()
|
13
|
+
|
14
|
+
@click.command("dev")
|
15
|
+
def dev():
|
16
|
+
"""Bundles your source directory."""
|
17
|
+
from . import dev
|
18
|
+
dev.main()
|
19
|
+
|
20
|
+
main.add_command(dist)
|
21
|
+
|
22
|
+
if __name__ == "__main__":
|
23
|
+
main()
|
effectual/build.py
ADDED
@@ -0,0 +1,162 @@
|
|
1
|
+
import os
|
2
|
+
import shutil
|
3
|
+
import zipfile
|
4
|
+
from pathlib import Path
|
5
|
+
from time import perf_counter
|
6
|
+
|
7
|
+
import rtoml
|
8
|
+
from .colors import completeColor, fileColor, folderColor, tagColor
|
9
|
+
from .config import loadConfig
|
10
|
+
from .fileHash import getFilehash
|
11
|
+
from .minifier import minifyFile, minifyToString
|
12
|
+
|
13
|
+
|
14
|
+
def bundleFiles(
|
15
|
+
sourceDirectory: Path,
|
16
|
+
outputDirectory: Path,
|
17
|
+
outputFileName: str,
|
18
|
+
compressionLevel: int,
|
19
|
+
minification: bool,
|
20
|
+
) -> None:
|
21
|
+
"""Bundles dependencies and scripts into a single .py archive
|
22
|
+
|
23
|
+
Args:
|
24
|
+
sourceDirectory (Path): Source directory which must contain a __main__.py script
|
25
|
+
outputDirectory (Path): Output directory for the bundle
|
26
|
+
outputFileName (str): Name of the output bundle
|
27
|
+
compressionLevel (int): Compression level for the bundle from 0-9
|
28
|
+
minification (bool): If the dependencies and scripts should be minified
|
29
|
+
"""
|
30
|
+
outputDirectory.mkdir(parents=True, exist_ok=True)
|
31
|
+
outputPath: Path = outputDirectory / outputFileName
|
32
|
+
|
33
|
+
if outputPath.exists():
|
34
|
+
outputPath.unlink()
|
35
|
+
|
36
|
+
with zipfile.ZipFile(
|
37
|
+
outputPath,
|
38
|
+
"w",
|
39
|
+
compresslevel=compressionLevel,
|
40
|
+
compression=zipfile.ZIP_DEFLATED,
|
41
|
+
) as bundler:
|
42
|
+
cachePath: Path = Path("./.effectual_cache/cachedPackages")
|
43
|
+
|
44
|
+
totalSize: int = int(0)
|
45
|
+
for cachedFile in cachePath.rglob("*"):
|
46
|
+
if cachedFile.is_dir() and not any(cachedFile.iterdir()):
|
47
|
+
continue
|
48
|
+
totalSize += cachedFile.stat().st_size
|
49
|
+
arcName = cachedFile.relative_to(cachePath)
|
50
|
+
bundler.write(cachedFile, arcname=arcName)
|
51
|
+
|
52
|
+
print(f"{tagColor('bundling')} || uv dependencies {folderColor(totalSize)}")
|
53
|
+
|
54
|
+
for pyFile in sourceDirectory.rglob("*.py"):
|
55
|
+
print(f"{tagColor('bundling')} || {pyFile.name} {fileColor(pyFile)}")
|
56
|
+
if minification:
|
57
|
+
fileContents = minifyToString(pyFile)
|
58
|
+
bundler.writestr(zinfo_or_arcname=pyFile.name, data=fileContents)
|
59
|
+
else:
|
60
|
+
bundler.write(pyFile, arcname=pyFile.name)
|
61
|
+
|
62
|
+
print(f"{tagColor('OUTPUT')} || {outputFileName} {fileColor(outputPath)}")
|
63
|
+
|
64
|
+
|
65
|
+
def dependencies(minify: bool) -> None:
|
66
|
+
with open("./pyproject.toml", "r", encoding="utf-8") as file:
|
67
|
+
packages: list[str] = dict(rtoml.load(file)).get("project").get("dependencies")
|
68
|
+
|
69
|
+
arguments: list[str] = ["--no-compile", "--quiet", "--no-binary=none", "--no-cache"]
|
70
|
+
|
71
|
+
pathToInstallTo: str = "./.effectual_cache/cachedPackages"
|
72
|
+
argumentString: str = " ".join(arguments)
|
73
|
+
|
74
|
+
if Path(pathToInstallTo).exists():
|
75
|
+
shutil.rmtree(pathToInstallTo)
|
76
|
+
|
77
|
+
for key in packages:
|
78
|
+
print(f"{tagColor('installing')} || {key}")
|
79
|
+
os.system(f'uv pip install "{key}" {argumentString} --target {pathToInstallTo}')
|
80
|
+
|
81
|
+
print(f"{tagColor('optimizing')} || {', '.join(packages)}")
|
82
|
+
|
83
|
+
import multiprocessing
|
84
|
+
|
85
|
+
with multiprocessing.Pool(processes=multiprocessing.cpu_count()) as pool:
|
86
|
+
pool.map(optimizeDependencies, Path(pathToInstallTo).rglob("*"))
|
87
|
+
|
88
|
+
|
89
|
+
def optimizeDependencies(file: Path) -> None:
|
90
|
+
if (
|
91
|
+
file.suffix in (".pyc", ".pyd", ".exe", ".typed")
|
92
|
+
or "__pycache__" in str(file)
|
93
|
+
or ".dist-info" in str(file)
|
94
|
+
or ".lock" in str(file)
|
95
|
+
):
|
96
|
+
try:
|
97
|
+
file.unlink()
|
98
|
+
except PermissionError:
|
99
|
+
pass
|
100
|
+
elif file.suffix == ".py":
|
101
|
+
minifyFile(file)
|
102
|
+
|
103
|
+
|
104
|
+
def main() -> None:
|
105
|
+
"""Entrypoint
|
106
|
+
|
107
|
+
Raises:
|
108
|
+
RuntimeError: In the event there is no source directory
|
109
|
+
"""
|
110
|
+
|
111
|
+
configData: dict = loadConfig("./pyproject.toml")
|
112
|
+
|
113
|
+
sourceDirectory: Path = Path(configData.get("sourceDirectory", "src/"))
|
114
|
+
outputDirectory: Path = Path(configData.get("outputDirectory", "out/"))
|
115
|
+
outputFileName: str = configData.get("outputFileName", "bundle.pyz")
|
116
|
+
compressionLevel: int = max(
|
117
|
+
0, min(9, configData.get("compressionLevel", 5))
|
118
|
+
) # Default level if not set
|
119
|
+
global minification
|
120
|
+
minification = configData.get("minification", True)
|
121
|
+
|
122
|
+
if not sourceDirectory.is_dir():
|
123
|
+
raise RuntimeError(
|
124
|
+
f"Source directory {sourceDirectory} does not exist or is not a directory."
|
125
|
+
)
|
126
|
+
|
127
|
+
uvHashPath: Path = Path("./.effectual_cache/pyprojectHash.toml")
|
128
|
+
currentHash: dict[str] = dict()
|
129
|
+
|
130
|
+
startTime = perf_counter()
|
131
|
+
|
132
|
+
Path("./.effectual_cache/").mkdir(parents=True, exist_ok=True)
|
133
|
+
currentHash["hashes"]: dict[dict] = dict()
|
134
|
+
currentHash["hashes"]["pyproject"] = getFilehash("./pyproject.toml")
|
135
|
+
currentHash["hashes"]["lock"] = getFilehash("./uv.lock")
|
136
|
+
|
137
|
+
if uvHashPath.exists():
|
138
|
+
with open(uvHashPath, "r") as file:
|
139
|
+
lastHash: dict = dict(rtoml.load(file)).get("hashes")
|
140
|
+
if currentHash["hashes"] != lastHash:
|
141
|
+
with open(uvHashPath, "w") as file:
|
142
|
+
rtoml.dump(currentHash, file)
|
143
|
+
dependencies(minify=minification)
|
144
|
+
else:
|
145
|
+
with open(uvHashPath, "x") as file:
|
146
|
+
rtoml.dump(currentHash, file)
|
147
|
+
dependencies(minify=minification)
|
148
|
+
|
149
|
+
bundleFiles(
|
150
|
+
sourceDirectory,
|
151
|
+
outputDirectory,
|
152
|
+
outputFileName,
|
153
|
+
compressionLevel,
|
154
|
+
minification,
|
155
|
+
)
|
156
|
+
endTime = perf_counter()
|
157
|
+
|
158
|
+
print(completeColor(f"Completed in {endTime - startTime:.4f}s"))
|
159
|
+
|
160
|
+
|
161
|
+
if "__main__" in __name__:
|
162
|
+
main()
|
effectual/colors.py
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
from pathlib import Path
|
2
|
+
|
3
|
+
from termcolor import colored
|
4
|
+
|
5
|
+
|
6
|
+
def fileColor(filePath: Path) -> str:
|
7
|
+
"""Creates a yellow string with the size of a file
|
8
|
+
|
9
|
+
Args:
|
10
|
+
filePath (Path): Path to the file
|
11
|
+
|
12
|
+
Returns:
|
13
|
+
str: Output string
|
14
|
+
"""
|
15
|
+
return colored(f"{str(round(filePath.stat().st_size / 1024, 3))}kB", "yellow")
|
16
|
+
|
17
|
+
|
18
|
+
def tagColor(nameOfTag: str) -> str:
|
19
|
+
"""Creates a blue tag with uppercase letters and squared brackets
|
20
|
+
|
21
|
+
Args:
|
22
|
+
nameOfTag (str): What the tag should be called
|
23
|
+
|
24
|
+
Returns:
|
25
|
+
str: Output string
|
26
|
+
"""
|
27
|
+
return colored(f"[{nameOfTag.upper()}]", "blue")
|
28
|
+
|
29
|
+
|
30
|
+
def errorColor(errorString: str) -> str:
|
31
|
+
"""Makes an error string red
|
32
|
+
|
33
|
+
Args:
|
34
|
+
errorString (str):
|
35
|
+
|
36
|
+
Returns:
|
37
|
+
str: Output string
|
38
|
+
"""
|
39
|
+
return colored(errorString, "red")
|
40
|
+
|
41
|
+
|
42
|
+
def folderColor(sizeOfFolder: int) -> str:
|
43
|
+
"""Writes out the size of a folder
|
44
|
+
|
45
|
+
Args:
|
46
|
+
sizeOfFolder (int): Size of the folder in bytes
|
47
|
+
|
48
|
+
Returns:
|
49
|
+
str: Output string
|
50
|
+
"""
|
51
|
+
return colored(f"{round((sizeOfFolder / 1024), 3)}kB", "yellow")
|
52
|
+
|
53
|
+
|
54
|
+
def completeColor(completeString: str) -> str:
|
55
|
+
"""Makes a string light magenta
|
56
|
+
|
57
|
+
Args:
|
58
|
+
completeString (str): String to be shown at end of process
|
59
|
+
|
60
|
+
Returns:
|
61
|
+
str: Output string
|
62
|
+
"""
|
63
|
+
return colored(completeString, "light_magenta")
|
effectual/config.py
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
import rtoml
|
2
|
+
|
3
|
+
|
4
|
+
def loadConfig(configPath: str) -> dict:
|
5
|
+
"""Loads effectual config from a file
|
6
|
+
|
7
|
+
Args:
|
8
|
+
configPath (str): Path to the config file
|
9
|
+
|
10
|
+
Raises:
|
11
|
+
RuntimeError: Invalid TOML format
|
12
|
+
RuntimeError: No configuration file found
|
13
|
+
|
14
|
+
Returns:
|
15
|
+
dict: _description_
|
16
|
+
"""
|
17
|
+
try:
|
18
|
+
with open(configPath, "r", encoding="utf-8") as file:
|
19
|
+
tomlFile: dict = dict(rtoml.load(file))
|
20
|
+
configData: dict = tomlFile.get("tool").get("effectual")
|
21
|
+
|
22
|
+
except ValueError as e:
|
23
|
+
raise RuntimeError(f"Invalid TOML in {configPath}: {e}")
|
24
|
+
except FileNotFoundError:
|
25
|
+
raise RuntimeError(f"Configuration file {configPath} not found.")
|
26
|
+
|
27
|
+
return configData
|
effectual/dev.py
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
import subprocess
|
2
|
+
import time
|
3
|
+
import zipfile
|
4
|
+
from pathlib import Path
|
5
|
+
|
6
|
+
from .colors import completeColor, fileColor, tagColor
|
7
|
+
from .config import loadConfig
|
8
|
+
from .fileHash import getAllHashes
|
9
|
+
|
10
|
+
|
11
|
+
def bundle(sourceDirectory: Path, outputFile: Path) -> None:
|
12
|
+
"""Bundles scripts into a single .py archive
|
13
|
+
|
14
|
+
Args:
|
15
|
+
sourceDirectory (Path): Path to the original python scripts
|
16
|
+
"""
|
17
|
+
startTime = time.perf_counter()
|
18
|
+
|
19
|
+
with zipfile.ZipFile(outputFile, "w") as bundler:
|
20
|
+
for pyFile in sourceDirectory.rglob("*.py"):
|
21
|
+
print(f"{tagColor('bundling')} || {pyFile.name} {fileColor(pyFile)}")
|
22
|
+
bundler.write(pyFile, arcname=pyFile.name)
|
23
|
+
endTime = time.perf_counter()
|
24
|
+
|
25
|
+
print(completeColor(f"Completed in {endTime - startTime:.4f}s"))
|
26
|
+
|
27
|
+
|
28
|
+
def main() -> None:
|
29
|
+
"""Super fast bundling for the 'task dev' command"""
|
30
|
+
|
31
|
+
configData: dict = loadConfig("./pyproject.toml")
|
32
|
+
sourceDirectory: Path = Path(configData.get("sourceDirectory", "src/"))
|
33
|
+
outputFileName: str = Path(configData.get("outputFileName", "bundle.pyz"))
|
34
|
+
devBundlePath: Path = Path("./.effectual_cache/dev/")
|
35
|
+
devBundlePath.mkdir(parents=True, exist_ok=True)
|
36
|
+
|
37
|
+
outputFile: Path = devBundlePath / outputFileName
|
38
|
+
|
39
|
+
bundle(sourceDirectory, outputFile)
|
40
|
+
|
41
|
+
runCommand = subprocess.Popen(["uv", "run", outputFile], shell=True)
|
42
|
+
|
43
|
+
lastHashList: list[str] = getAllHashes(sourceDirectory)
|
44
|
+
|
45
|
+
while True:
|
46
|
+
currentHashList: list[str] = getAllHashes(sourceDirectory)
|
47
|
+
if currentHashList != lastHashList:
|
48
|
+
lastHashList = currentHashList
|
49
|
+
runCommand.kill()
|
50
|
+
runCommand.wait()
|
51
|
+
outputFile.unlink()
|
52
|
+
print(f"{tagColor('reloaded')} || file change detected")
|
53
|
+
bundle(sourceDirectory, outputFile)
|
54
|
+
runCommand = subprocess.Popen(["uv", "run", outputFile], shell=True)
|
55
|
+
else:
|
56
|
+
time.sleep(0.1)
|
57
|
+
|
58
|
+
|
59
|
+
if __name__ == "__main__":
|
60
|
+
main()
|
effectual/fileHash.py
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
import hashlib
|
2
|
+
from multiprocessing import Pool
|
3
|
+
from pathlib import Path
|
4
|
+
|
5
|
+
|
6
|
+
def getFilehash(filePath: Path) -> str:
|
7
|
+
"""Gets the file hash of a single python script
|
8
|
+
|
9
|
+
Args:
|
10
|
+
filePath (Path): Path to the python script
|
11
|
+
|
12
|
+
Returns:
|
13
|
+
str: Hash of the python script
|
14
|
+
"""
|
15
|
+
with open(filePath, "rb") as file:
|
16
|
+
fileHash = hashlib.sha256(file.read()).hexdigest()
|
17
|
+
return fileHash
|
18
|
+
|
19
|
+
|
20
|
+
def getAllHashes(sourceDirectory: Path) -> list[str]:
|
21
|
+
"""Gets all hashes in directory
|
22
|
+
|
23
|
+
Args:
|
24
|
+
sourceDirectory (Path): Path to the python scripts
|
25
|
+
|
26
|
+
Returns:
|
27
|
+
dict[str]: Dictionary containing paths and hashes
|
28
|
+
"""
|
29
|
+
|
30
|
+
with Pool() as pool:
|
31
|
+
hashList: list[str] = pool.map(getFilehash, sourceDirectory.glob("*.py"))
|
32
|
+
return hashList
|
effectual/minifier.py
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
from pathlib import Path
|
2
|
+
|
3
|
+
from python_minifier import minify
|
4
|
+
|
5
|
+
|
6
|
+
def minifyFile(filePath: Path) -> None:
|
7
|
+
"""Minifies a file from a certain path
|
8
|
+
|
9
|
+
Args:
|
10
|
+
filePath (Path): Path to the file to minify
|
11
|
+
|
12
|
+
Raises:
|
13
|
+
RuntimeError: In the event the file cannot be found or an error has occurred
|
14
|
+
"""
|
15
|
+
try:
|
16
|
+
with filePath.open("r+", encoding="utf-8") as fileRW:
|
17
|
+
minifiedCode = minify(
|
18
|
+
fileRW.read(),
|
19
|
+
hoist_literals=False,
|
20
|
+
remove_literal_statements=True,
|
21
|
+
remove_debug=True,
|
22
|
+
)
|
23
|
+
|
24
|
+
fileRW.seek(0)
|
25
|
+
fileRW.write(minifiedCode)
|
26
|
+
fileRW.truncate()
|
27
|
+
|
28
|
+
except Exception as e:
|
29
|
+
raise RuntimeError(f"Failed to minify {filePath}: {e}")
|
30
|
+
|
31
|
+
|
32
|
+
def minifyToString(filePath: Path) -> str:
|
33
|
+
"""Minifies string of a python file
|
34
|
+
|
35
|
+
Args:
|
36
|
+
filePath (Path): Path to file to minify
|
37
|
+
|
38
|
+
Returns:
|
39
|
+
str: Minified string
|
40
|
+
"""
|
41
|
+
with filePath.open("r", encoding="utf-8") as fileR:
|
42
|
+
minifiedCode: str = str(
|
43
|
+
minify(
|
44
|
+
fileR.read(),
|
45
|
+
hoist_literals=False,
|
46
|
+
remove_literal_statements=True,
|
47
|
+
remove_debug=True,
|
48
|
+
)
|
49
|
+
).encode("utf-8")
|
50
|
+
|
51
|
+
return minifiedCode
|
@@ -0,0 +1,19 @@
|
|
1
|
+
Metadata-Version: 2.3
|
2
|
+
Name: effectual
|
3
|
+
Version: 0.1.0
|
4
|
+
Summary: Add your description here
|
5
|
+
Author-email: jake <jakewdr@proton.me>
|
6
|
+
Classifier: License :: OSI Approved :: MIT License
|
7
|
+
Classifier: Programming Language :: Python :: 3.8
|
8
|
+
Classifier: Programming Language :: Python :: 3.9
|
9
|
+
Classifier: Programming Language :: Python :: 3.10
|
10
|
+
Classifier: Programming Language :: Python :: 3.11
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
13
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
14
|
+
Requires-Python: >=3.11
|
15
|
+
Requires-Dist: click>=8.1.7
|
16
|
+
Requires-Dist: python-minifier>=2.11.3
|
17
|
+
Requires-Dist: rtoml>=0.11.0
|
18
|
+
Requires-Dist: ruff>=0.8.0
|
19
|
+
Requires-Dist: termcolor>=2.4.0
|
@@ -0,0 +1,12 @@
|
|
1
|
+
effectual/__init__.py,sha256=ZE_a-z_Bzr6fSfXxxOayV_q-pToLPnlMpHfARJk39vI,401
|
2
|
+
effectual/build.py,sha256=Fb6mKGJjDQZcQeLFH22bXgsdb6TlGRPotnXJws6emOQ,5515
|
3
|
+
effectual/colors.py,sha256=na7SEUSXM7aHvEKeIAn5shrZJtrBYq_ZUp121GRO_PQ,1411
|
4
|
+
effectual/config.py,sha256=LzGT8e-zq7Rc-HOp3-r6g1XRiN9v0sCq5aeWL0bqFLY,754
|
5
|
+
effectual/dev.py,sha256=Ia6LPvDbO5kkF9dRIw3H23sulmWT8pLis55-PRQIInI,2014
|
6
|
+
effectual/fileHash.py,sha256=m2oPjhAcSH0Qc7J7aMkmjOlgDr5Lzilcfl1ppeoDxI8,810
|
7
|
+
effectual/minifier.py,sha256=RlUD0mUNDi7YZ1P-dDL6Y4FlCkfiiJP8G4TpX2y45iI,1347
|
8
|
+
effectual-0.1.0.dist-info/METADATA,sha256=gGGioOJlFWquujFIdyJ85b-gVwP9_utfOb8ShahvWjE,733
|
9
|
+
effectual-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
|
10
|
+
effectual-0.1.0.dist-info/entry_points.txt,sha256=1W7EjlLZkw_Wz8V1SgdzzDis-CRE5IINyg74upsB0zU,40
|
11
|
+
effectual-0.1.0.dist-info/licenses/LICENSE,sha256=JoTeFzAOCkNGhvHsf4r2BFIHpLRXo_4EsrnOZV58XVA,17098
|
12
|
+
effectual-0.1.0.dist-info/RECORD,,
|
@@ -0,0 +1,373 @@
|
|
1
|
+
Mozilla Public License Version 2.0
|
2
|
+
==================================
|
3
|
+
|
4
|
+
1. Definitions
|
5
|
+
--------------
|
6
|
+
|
7
|
+
1.1. "Contributor"
|
8
|
+
means each individual or legal entity that creates, contributes to
|
9
|
+
the creation of, or owns Covered Software.
|
10
|
+
|
11
|
+
1.2. "Contributor Version"
|
12
|
+
means the combination of the Contributions of others (if any) used
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
14
|
+
|
15
|
+
1.3. "Contribution"
|
16
|
+
means Covered Software of a particular Contributor.
|
17
|
+
|
18
|
+
1.4. "Covered Software"
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
22
|
+
including portions thereof.
|
23
|
+
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
25
|
+
means
|
26
|
+
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
28
|
+
in Exhibit B to the Covered Software; or
|
29
|
+
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
32
|
+
terms of a Secondary License.
|
33
|
+
|
34
|
+
1.6. "Executable Form"
|
35
|
+
means any form of the work other than Source Code Form.
|
36
|
+
|
37
|
+
1.7. "Larger Work"
|
38
|
+
means a work that combines Covered Software with other material, in
|
39
|
+
a separate file or files, that is not Covered Software.
|
40
|
+
|
41
|
+
1.8. "License"
|
42
|
+
means this document.
|
43
|
+
|
44
|
+
1.9. "Licensable"
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
47
|
+
all of the rights conveyed by this License.
|
48
|
+
|
49
|
+
1.10. "Modifications"
|
50
|
+
means any of the following:
|
51
|
+
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
53
|
+
deletion from, or modification of the contents of Covered
|
54
|
+
Software; or
|
55
|
+
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
57
|
+
Software.
|
58
|
+
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
60
|
+
means any patent claim(s), including without limitation, method,
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
64
|
+
made, import, or transfer of either its Contributions or its
|
65
|
+
Contributor Version.
|
66
|
+
|
67
|
+
1.12. "Secondary License"
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
71
|
+
licenses.
|
72
|
+
|
73
|
+
1.13. "Source Code Form"
|
74
|
+
means the form of the work preferred for making modifications.
|
75
|
+
|
76
|
+
1.14. "You" (or "Your")
|
77
|
+
means an individual or a legal entity exercising rights under this
|
78
|
+
License. For legal entities, "You" includes any entity that
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
84
|
+
ownership of such entity.
|
85
|
+
|
86
|
+
2. License Grants and Conditions
|
87
|
+
--------------------------------
|
88
|
+
|
89
|
+
2.1. Grants
|
90
|
+
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
92
|
+
non-exclusive license:
|
93
|
+
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
98
|
+
as part of a Larger Work; and
|
99
|
+
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
102
|
+
Contributions or its Contributor Version.
|
103
|
+
|
104
|
+
2.2. Effective Date
|
105
|
+
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
108
|
+
distributes such Contribution.
|
109
|
+
|
110
|
+
2.3. Limitations on Grant Scope
|
111
|
+
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
114
|
+
distribution or licensing of Covered Software under this License.
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
116
|
+
Contributor:
|
117
|
+
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
119
|
+
or
|
120
|
+
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
123
|
+
Contributions with other software (except as part of its Contributor
|
124
|
+
Version); or
|
125
|
+
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
127
|
+
its Contributions.
|
128
|
+
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
131
|
+
the notice requirements in Section 3.4).
|
132
|
+
|
133
|
+
2.4. Subsequent Licenses
|
134
|
+
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
138
|
+
permitted under the terms of Section 3.3).
|
139
|
+
|
140
|
+
2.5. Representation
|
141
|
+
|
142
|
+
Each Contributor represents that the Contributor believes its
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
145
|
+
|
146
|
+
2.6. Fair Use
|
147
|
+
|
148
|
+
This License is not intended to limit any rights You have under
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
150
|
+
equivalents.
|
151
|
+
|
152
|
+
2.7. Conditions
|
153
|
+
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
155
|
+
in Section 2.1.
|
156
|
+
|
157
|
+
3. Responsibilities
|
158
|
+
-------------------
|
159
|
+
|
160
|
+
3.1. Distribution of Source Form
|
161
|
+
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
168
|
+
Form.
|
169
|
+
|
170
|
+
3.2. Distribution of Executable Form
|
171
|
+
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
173
|
+
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
178
|
+
than the cost of distribution to the recipient; and
|
179
|
+
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
181
|
+
License, or sublicense it under different terms, provided that the
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
184
|
+
|
185
|
+
3.3. Distribution of a Larger Work
|
186
|
+
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
188
|
+
provided that You also comply with the requirements of this License for
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
192
|
+
License permits You to additionally distribute such Covered Software
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
195
|
+
Software under the terms of either this License or such Secondary
|
196
|
+
License(s).
|
197
|
+
|
198
|
+
3.4. Notices
|
199
|
+
|
200
|
+
You may not remove or alter the substance of any license notices
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
205
|
+
|
206
|
+
3.5. Application of Additional Terms
|
207
|
+
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
217
|
+
jurisdiction.
|
218
|
+
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
220
|
+
---------------------------------------------------
|
221
|
+
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
223
|
+
License with respect to some or all of the Covered Software due to
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
226
|
+
describe the limitations and the code they affect. Such description must
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
231
|
+
|
232
|
+
5. Termination
|
233
|
+
--------------
|
234
|
+
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
237
|
+
compliant, then the rights granted under this License from a particular
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
245
|
+
first time You have received notice of non-compliance with this License
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
247
|
+
Your receipt of the notice.
|
248
|
+
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
254
|
+
2.1 of this License shall terminate.
|
255
|
+
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
258
|
+
have been validly granted by You or Your distributors under this License
|
259
|
+
prior to termination shall survive termination.
|
260
|
+
|
261
|
+
************************************************************************
|
262
|
+
* *
|
263
|
+
* 6. Disclaimer of Warranty *
|
264
|
+
* ------------------------- *
|
265
|
+
* *
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
276
|
+
* authorized under this License except under this disclaimer. *
|
277
|
+
* *
|
278
|
+
************************************************************************
|
279
|
+
|
280
|
+
************************************************************************
|
281
|
+
* *
|
282
|
+
* 7. Limitation of Liability *
|
283
|
+
* -------------------------- *
|
284
|
+
* *
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
289
|
+
* special, incidental, or consequential damages of any character *
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
299
|
+
* limitation may not apply to You. *
|
300
|
+
* *
|
301
|
+
************************************************************************
|
302
|
+
|
303
|
+
8. Litigation
|
304
|
+
-------------
|
305
|
+
|
306
|
+
Any litigation relating to this License may be brought only in the
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
311
|
+
cross-claims or counter-claims.
|
312
|
+
|
313
|
+
9. Miscellaneous
|
314
|
+
----------------
|
315
|
+
|
316
|
+
This License represents the complete agreement concerning the subject
|
317
|
+
matter hereof. If any provision of this License is held to be
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
320
|
+
that the language of a contract shall be construed against the drafter
|
321
|
+
shall not be used to construe this License against a Contributor.
|
322
|
+
|
323
|
+
10. Versions of the License
|
324
|
+
---------------------------
|
325
|
+
|
326
|
+
10.1. New Versions
|
327
|
+
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
330
|
+
publish new versions of this License. Each version will be given a
|
331
|
+
distinguishing version number.
|
332
|
+
|
333
|
+
10.2. Effect of New Versions
|
334
|
+
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
336
|
+
of the License under which You originally received the Covered Software,
|
337
|
+
or under the terms of any subsequent version published by the license
|
338
|
+
steward.
|
339
|
+
|
340
|
+
10.3. Modified Versions
|
341
|
+
|
342
|
+
If you create software not governed by this License, and you want to
|
343
|
+
create a new license for such software, you may create and use a
|
344
|
+
modified version of this License if you rename the license and remove
|
345
|
+
any references to the name of the license steward (except to note that
|
346
|
+
such modified license differs from this License).
|
347
|
+
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
349
|
+
Licenses
|
350
|
+
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
354
|
+
|
355
|
+
Exhibit A - Source Code Form License Notice
|
356
|
+
-------------------------------------------
|
357
|
+
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
360
|
+
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
361
|
+
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
365
|
+
for such a notice.
|
366
|
+
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
368
|
+
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
370
|
+
---------------------------------------------------------
|
371
|
+
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|