readme-weaver 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- readme_weaver/__init__.py +0 -0
- readme_weaver/include_content_reader.py +66 -0
- readme_weaver/include_metadata.py +31 -0
- readme_weaver/include_metadata_extractor.py +100 -0
- readme_weaver/main.py +91 -0
- readme_weaver/readme_weaver.py +90 -0
- readme_weaver-0.1.0.dist-info/METADATA +454 -0
- readme_weaver-0.1.0.dist-info/RECORD +11 -0
- readme_weaver-0.1.0.dist-info/WHEEL +4 -0
- readme_weaver-0.1.0.dist-info/entry_points.txt +2 -0
- readme_weaver-0.1.0.dist-info/licenses/LICENSE +201 -0
|
File without changes
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Content reader for include directives.
|
|
3
|
+
|
|
4
|
+
Given a list of ``IncludeMetadata`` objects produced by the extractor, this
|
|
5
|
+
reader resolves the include paths, reads the referenced files, and prepares the
|
|
6
|
+
replacement text. Each include block will receive a warning comment to
|
|
7
|
+
discourage manual edits to the generated region.
|
|
8
|
+
|
|
9
|
+
Relative paths are resolved relative to a base directory, which can be
|
|
10
|
+
specified via the ``base_dir`` argument or the ``README_WEAVER_BASE``
|
|
11
|
+
environment variable. Absolute paths are used as‑is.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
import os
|
|
15
|
+
from pathlib import Path
|
|
16
|
+
from typing import List, Protocol
|
|
17
|
+
|
|
18
|
+
from .include_metadata import IncludeMetadata
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class IncludeContentReaderInterface(Protocol):
|
|
22
|
+
"""Interface for reading include content and updating metadata objects."""
|
|
23
|
+
|
|
24
|
+
def read(self, includes: List[IncludeMetadata]) -> List[IncludeMetadata]: ...
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class IncludeContentReader:
|
|
28
|
+
"""
|
|
29
|
+
Read the contents of each include directive and prepare the text to be
|
|
30
|
+
inserted into the README.
|
|
31
|
+
|
|
32
|
+
For each ``IncludeMetadata`` instance returned by the extractor, this
|
|
33
|
+
reader resolves the file path, reads the file, and prefixes the
|
|
34
|
+
content with an auto‑generated notice. If an include is marked
|
|
35
|
+
``required`` and the file does not exist, a ``FileNotFoundError`` is
|
|
36
|
+
raised. Otherwise, the content is set to an empty string.
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
def __init__(self, base_dir: str | None = None) -> None:
|
|
40
|
+
# Determine base directory for relative include paths. If provided
|
|
41
|
+
# explicitly, use that; otherwise use README_WEAVER_BASE environment
|
|
42
|
+
# variable or default to current working directory.
|
|
43
|
+
self._base_dir = Path(base_dir or os.environ.get("README_WEAVER_BASE", ".")).resolve()
|
|
44
|
+
|
|
45
|
+
def read(self, includes: List[IncludeMetadata]) -> List[IncludeMetadata]:
|
|
46
|
+
processed: List[IncludeMetadata] = []
|
|
47
|
+
for inc in includes:
|
|
48
|
+
if inc.extraction_type != "include":
|
|
49
|
+
raise ValueError(f"Unsupported extraction type {inc.extraction_type}.")
|
|
50
|
+
inc_path = Path(inc.path)
|
|
51
|
+
full_path = inc_path if inc_path.is_absolute() else (self._base_dir / inc_path)
|
|
52
|
+
if not full_path.exists():
|
|
53
|
+
if inc.required:
|
|
54
|
+
raise FileNotFoundError(
|
|
55
|
+
f"Include file {inc.path} not found (resolved to {full_path})."
|
|
56
|
+
)
|
|
57
|
+
inc.content = ""
|
|
58
|
+
processed.append(inc)
|
|
59
|
+
continue
|
|
60
|
+
text = full_path.read_text(encoding="utf-8")
|
|
61
|
+
# Prepend auto‑generated notice if there is any content
|
|
62
|
+
if text:
|
|
63
|
+
text = "<!-- content below is auto-generated; do not edit -->\n" + text
|
|
64
|
+
inc.content = text
|
|
65
|
+
processed.append(inc)
|
|
66
|
+
return processed
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
from dataclasses import dataclass
|
|
2
|
+
from typing import Literal
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
@dataclass
|
|
6
|
+
class IncludeMetadata:
|
|
7
|
+
"""
|
|
8
|
+
Metadata describing a block in a README that should be replaced by the
|
|
9
|
+
contents of an external markdown file.
|
|
10
|
+
|
|
11
|
+
- ``readme_start`` and ``readme_end`` refer to the zero‑based line numbers
|
|
12
|
+
of the opening and closing include markers in the README.
|
|
13
|
+
- ``path`` is the relative or absolute path of the file whose contents
|
|
14
|
+
should be injected between the markers.
|
|
15
|
+
- ``required`` determines whether a missing file should raise a
|
|
16
|
+
``FileNotFoundError`` (True) or silently produce an empty block (False).
|
|
17
|
+
- ``content`` is the text that will be inserted into the README; it
|
|
18
|
+
is populated by the content reader.
|
|
19
|
+
|
|
20
|
+
The ``extraction_type`` and ``extraction_part`` attributes are kept for
|
|
21
|
+
possible future extensions and compatibility, but default to ``"include"``
|
|
22
|
+
and ``None`` respectively.
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
readme_start: int
|
|
26
|
+
readme_end: int
|
|
27
|
+
path: str
|
|
28
|
+
extraction_type: Literal["include"] = "include"
|
|
29
|
+
extraction_part: str | None = None
|
|
30
|
+
required: bool = True
|
|
31
|
+
content: str = ""
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Extractor for include directives in README files.
|
|
3
|
+
|
|
4
|
+
This module provides an extractor that scans a list of markdown lines for
|
|
5
|
+
comment‑based include directives of the form:
|
|
6
|
+
|
|
7
|
+
<!-- md:include start path="partials/foo.md" required=false -->
|
|
8
|
+
... existing content ...
|
|
9
|
+
<!-- md:include end -->
|
|
10
|
+
|
|
11
|
+
When such a start tag is encountered, the extractor parses the ``path`` and
|
|
12
|
+
optional ``required`` attributes. Once a corresponding end tag is found, an
|
|
13
|
+
``IncludeMetadata`` instance is created to describe the region of the README to
|
|
14
|
+
be replaced and the file to be included.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
import re
|
|
18
|
+
from typing import Protocol
|
|
19
|
+
|
|
20
|
+
from .include_metadata import IncludeMetadata
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class IncludeMetadataExtractorInterface(Protocol):
|
|
24
|
+
"""Interface for extracting include metadata from a README."""
|
|
25
|
+
|
|
26
|
+
def extract(self, readme_content: list[str]) -> list[IncludeMetadata]: ...
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
class IncludeMetadataExtractor:
|
|
30
|
+
"""
|
|
31
|
+
Extractor for ``IncludeMetadata`` objects from a markdown README.
|
|
32
|
+
|
|
33
|
+
It looks for comment directives with a ``start`` and ``end`` marker to
|
|
34
|
+
delineate the region of the README to replace. The directive must specify
|
|
35
|
+
a ``path`` attribute pointing to the file to include. A ``required``
|
|
36
|
+
attribute may be provided to control behavior when the file is missing; if
|
|
37
|
+
omitted it defaults to ``True``.
|
|
38
|
+
"""
|
|
39
|
+
|
|
40
|
+
def __init__(self) -> None:
|
|
41
|
+
# Regular expressions to identify include directives. The start tag
|
|
42
|
+
# captures its attribute string for later parsing; the end tag is
|
|
43
|
+
# simply matched.
|
|
44
|
+
self._include_start_regex = re.compile(
|
|
45
|
+
r"<!--\s*md:include\s+start\s+([^>]*)-->", re.IGNORECASE
|
|
46
|
+
)
|
|
47
|
+
self._include_end_regex = re.compile(r"<!--\s*md:include\s+end\s*-->", re.IGNORECASE)
|
|
48
|
+
|
|
49
|
+
def extract(self, readme_content: list[str]) -> list[IncludeMetadata]:
|
|
50
|
+
includes: list[IncludeMetadata] = []
|
|
51
|
+
current: dict | None = None
|
|
52
|
+
|
|
53
|
+
for row, line in enumerate(readme_content):
|
|
54
|
+
start_match = self._include_start_regex.search(line)
|
|
55
|
+
end_match = self._include_end_regex.search(line)
|
|
56
|
+
|
|
57
|
+
if start_match:
|
|
58
|
+
# Parse attributes from the start tag
|
|
59
|
+
attrs_str = start_match.group(1) or ""
|
|
60
|
+
attrs = self._parse_attrs(attrs_str)
|
|
61
|
+
path = attrs.get("path")
|
|
62
|
+
if not path:
|
|
63
|
+
raise ValueError(
|
|
64
|
+
'Include directive must specify a path, e.g. path="foo.md"'
|
|
65
|
+
)
|
|
66
|
+
required_str = str(attrs.get("required", "true")).strip().lower()
|
|
67
|
+
required = required_str not in ("false", "0", "no")
|
|
68
|
+
current = {
|
|
69
|
+
"start": row,
|
|
70
|
+
"path": path,
|
|
71
|
+
"required": required,
|
|
72
|
+
}
|
|
73
|
+
elif end_match and current:
|
|
74
|
+
# Create metadata for the block
|
|
75
|
+
includes.append(
|
|
76
|
+
IncludeMetadata(
|
|
77
|
+
readme_start=current["start"],
|
|
78
|
+
readme_end=row,
|
|
79
|
+
path=current["path"],
|
|
80
|
+
required=current.get("required", True),
|
|
81
|
+
content="",
|
|
82
|
+
)
|
|
83
|
+
)
|
|
84
|
+
current = None
|
|
85
|
+
|
|
86
|
+
return includes
|
|
87
|
+
|
|
88
|
+
@staticmethod
|
|
89
|
+
def _parse_attrs(attr_str: str) -> dict:
|
|
90
|
+
"""
|
|
91
|
+
Parse key=value pairs from an include start tag attribute string.
|
|
92
|
+
Values may be quoted with single or double quotes or left unquoted.
|
|
93
|
+
Returns a mapping of attribute names to values.
|
|
94
|
+
"""
|
|
95
|
+
attrs: dict = {}
|
|
96
|
+
for match in re.finditer(r"(\w+)=('([^']*)'|\"([^\"]*)\"|([^\s]+))", attr_str):
|
|
97
|
+
key = match.group(1)
|
|
98
|
+
value = match.group(3) or match.group(4) or match.group(5)
|
|
99
|
+
attrs[key] = value
|
|
100
|
+
return attrs
|
readme_weaver/main.py
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import glob
|
|
2
|
+
import os
|
|
3
|
+
import sys
|
|
4
|
+
|
|
5
|
+
import typer
|
|
6
|
+
from loguru import logger
|
|
7
|
+
|
|
8
|
+
from readme_weaver.include_content_reader import IncludeContentReader
|
|
9
|
+
from readme_weaver.include_metadata_extractor import IncludeMetadataExtractor
|
|
10
|
+
from readme_weaver.readme_weaver import ReadmeWeaver
|
|
11
|
+
|
|
12
|
+
"""
|
|
13
|
+
CLI entry point for the ReadmeWeaver tool.
|
|
14
|
+
|
|
15
|
+
This module configures logging based on an environment variable or a command line
|
|
16
|
+
option and exposes a ``run`` command that processes markdown files in the current
|
|
17
|
+
repository. Use the ``--log-level`` option or set the ``LOG_LEVEL`` environment
|
|
18
|
+
variable to control the verbosity of the output. If neither is provided, the
|
|
19
|
+
default level is INFO.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# Remove any default handlers so logging can be configured in the ``run`` command.
|
|
23
|
+
logger.remove()
|
|
24
|
+
|
|
25
|
+
app = typer.Typer(rich_markup_mode=None)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
@app.command(help="Embed partial markdown from external files into README files.")
|
|
29
|
+
def run(
|
|
30
|
+
all_files: bool = typer.Option(
|
|
31
|
+
False, "--all-files", help="Process all markdown files in the repository."
|
|
32
|
+
),
|
|
33
|
+
changed_files: list[str] = typer.Argument(
|
|
34
|
+
None, help="List of changed files to process. Use with pre‑commit."
|
|
35
|
+
),
|
|
36
|
+
base_dir: str = typer.Option(
|
|
37
|
+
None,
|
|
38
|
+
"--base-dir",
|
|
39
|
+
"-b",
|
|
40
|
+
help=(
|
|
41
|
+
"Base directory for resolving relative include paths. "
|
|
42
|
+
"Defaults to the README_WEAVER_BASE environment variable or the current working directory."
|
|
43
|
+
),
|
|
44
|
+
),
|
|
45
|
+
log_level: str = typer.Option(
|
|
46
|
+
None,
|
|
47
|
+
"--log-level",
|
|
48
|
+
"-l",
|
|
49
|
+
help=(
|
|
50
|
+
"Set the logging level (e.g. DEBUG, INFO, WARNING, ERROR). "
|
|
51
|
+
"If not provided, defaults to the value of the LOG_LEVEL environment variable or INFO."
|
|
52
|
+
),
|
|
53
|
+
),
|
|
54
|
+
):
|
|
55
|
+
"""
|
|
56
|
+
Entry point for the CLI. Scans all markdown files in the repository for
|
|
57
|
+
include directives and updates them in place. When used as a pre‑commit
|
|
58
|
+
hook, only changed files are processed unless ``--all-files`` is passed.
|
|
59
|
+
|
|
60
|
+
The optional ``--base-dir`` overrides the ``README_WEAVER_BASE``
|
|
61
|
+
environment variable and determines how relative include paths are
|
|
62
|
+
resolved.
|
|
63
|
+
"""
|
|
64
|
+
env_level = os.environ.get("LOG_LEVEL")
|
|
65
|
+
effective_level = (log_level or env_level or "INFO").upper()
|
|
66
|
+
logger.remove()
|
|
67
|
+
logger.add(sys.stderr, level=effective_level)
|
|
68
|
+
|
|
69
|
+
readme_paths = glob.glob("**/*.md", recursive=True)
|
|
70
|
+
|
|
71
|
+
if not readme_paths:
|
|
72
|
+
logger.info("No markdown files found in the current repository.")
|
|
73
|
+
raise typer.Exit(0)
|
|
74
|
+
|
|
75
|
+
include_metadata_extractor = IncludeMetadataExtractor()
|
|
76
|
+
include_content_reader = IncludeContentReader(base_dir=base_dir)
|
|
77
|
+
files = changed_files if not all_files else None
|
|
78
|
+
|
|
79
|
+
weaver = ReadmeWeaver(
|
|
80
|
+
readme_paths=readme_paths,
|
|
81
|
+
changed_files=files,
|
|
82
|
+
include_metadata_extractor=include_metadata_extractor,
|
|
83
|
+
include_content_reader=include_content_reader,
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
weaver()
|
|
87
|
+
logger.info("Finished successfully.")
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
if __name__ == "__main__":
|
|
91
|
+
app()
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
from loguru import logger
|
|
2
|
+
|
|
3
|
+
from readme_weaver.include_content_reader import IncludeContentReaderInterface
|
|
4
|
+
from readme_weaver.include_metadata import IncludeMetadata
|
|
5
|
+
from readme_weaver.include_metadata_extractor import IncludeMetadataExtractorInterface
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class ReadmeWeaver:
|
|
9
|
+
def __init__(
|
|
10
|
+
self,
|
|
11
|
+
readme_paths: list[str],
|
|
12
|
+
changed_files: list[str] | None,
|
|
13
|
+
include_metadata_extractor: IncludeMetadataExtractorInterface,
|
|
14
|
+
include_content_reader: IncludeContentReaderInterface,
|
|
15
|
+
) -> None:
|
|
16
|
+
self._readme_paths = readme_paths
|
|
17
|
+
self._changed_files = changed_files
|
|
18
|
+
self._include_metadata_extractor = include_metadata_extractor
|
|
19
|
+
self._include_content_reader = include_content_reader
|
|
20
|
+
|
|
21
|
+
def __call__(self) -> None:
|
|
22
|
+
for readme_path in self._readme_paths:
|
|
23
|
+
self._process_readme(readme_path=readme_path)
|
|
24
|
+
|
|
25
|
+
def _process_readme(self, readme_path: str) -> None:
|
|
26
|
+
readme_content = self._read_readme(readme_path)
|
|
27
|
+
if not readme_content:
|
|
28
|
+
logger.info(f"Empty markdown file {readme_path}. Skipping.")
|
|
29
|
+
return
|
|
30
|
+
|
|
31
|
+
includes = self._extract_includes(
|
|
32
|
+
readme_content=readme_content, readme_path=readme_path
|
|
33
|
+
)
|
|
34
|
+
|
|
35
|
+
if not includes:
|
|
36
|
+
return
|
|
37
|
+
|
|
38
|
+
if self._changed_files:
|
|
39
|
+
if readme_path not in self._changed_files:
|
|
40
|
+
includes = [inc for inc in includes if inc.path in self._changed_files]
|
|
41
|
+
|
|
42
|
+
include_contents = self._include_content_reader.read(includes=includes)
|
|
43
|
+
|
|
44
|
+
self._update_readme(
|
|
45
|
+
include_contents=include_contents,
|
|
46
|
+
readme_content=readme_content,
|
|
47
|
+
readme_path=readme_path,
|
|
48
|
+
)
|
|
49
|
+
|
|
50
|
+
def _read_readme(self, readme_path: str) -> list[str]:
|
|
51
|
+
if not readme_path.endswith(".md"):
|
|
52
|
+
raise ValueError("README path must end with .md")
|
|
53
|
+
|
|
54
|
+
with open(readme_path, encoding="utf-8") as readme_file:
|
|
55
|
+
return readme_file.readlines()
|
|
56
|
+
|
|
57
|
+
def _extract_includes(
|
|
58
|
+
self, readme_content: list[str], readme_path: str
|
|
59
|
+
) -> list[IncludeMetadata] | None:
|
|
60
|
+
includes = self._include_metadata_extractor.extract(readme_content=readme_content)
|
|
61
|
+
if not includes:
|
|
62
|
+
logger.debug(
|
|
63
|
+
f"No include directives found in README at path {readme_path}. Skipping."
|
|
64
|
+
)
|
|
65
|
+
return None
|
|
66
|
+
logger.info(
|
|
67
|
+
f"""Found include paths in {readme_path}:
|
|
68
|
+
{set(inc.path for inc in includes)}"""
|
|
69
|
+
)
|
|
70
|
+
return includes
|
|
71
|
+
|
|
72
|
+
def _update_readme(
|
|
73
|
+
self,
|
|
74
|
+
include_contents: list[IncludeMetadata],
|
|
75
|
+
readme_content: list[str],
|
|
76
|
+
readme_path: str,
|
|
77
|
+
) -> None:
|
|
78
|
+
updated_readme = []
|
|
79
|
+
readme_content_cursor = 0
|
|
80
|
+
|
|
81
|
+
for include in sorted(include_contents, key=lambda x: x.readme_start):
|
|
82
|
+
updated_readme += readme_content[readme_content_cursor : include.readme_start + 1]
|
|
83
|
+
updated_readme += include.content + "\n"
|
|
84
|
+
|
|
85
|
+
readme_content_cursor = include.readme_end
|
|
86
|
+
|
|
87
|
+
updated_readme += readme_content[readme_content_cursor:]
|
|
88
|
+
|
|
89
|
+
with open(readme_path, "w", encoding="utf-8") as readme_file:
|
|
90
|
+
readme_file.writelines(updated_readme)
|
|
@@ -0,0 +1,454 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: readme-weaver
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Embed raw markdown partials into README files
|
|
5
|
+
Project-URL: Home, https://github.com/devops-roast/readme-weaver
|
|
6
|
+
Author-email: Oleksandr Ponomarov <ponomarov.aleksandr@gmail.com>
|
|
7
|
+
License: Apache License
|
|
8
|
+
Version 2.0, January 2004
|
|
9
|
+
http://www.apache.org/licenses/
|
|
10
|
+
|
|
11
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
12
|
+
|
|
13
|
+
1. Definitions.
|
|
14
|
+
|
|
15
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
16
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
17
|
+
|
|
18
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
19
|
+
the copyright owner that is granting the License.
|
|
20
|
+
|
|
21
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
22
|
+
other entities that control, are controlled by, or are under common
|
|
23
|
+
control with that entity. For the purposes of this definition,
|
|
24
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
25
|
+
direction or management of such entity, whether by contract or
|
|
26
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
27
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
28
|
+
|
|
29
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
30
|
+
exercising permissions granted by this License.
|
|
31
|
+
|
|
32
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
33
|
+
including but not limited to software source code, documentation
|
|
34
|
+
source, and configuration files.
|
|
35
|
+
|
|
36
|
+
"Object" form shall mean any form resulting from mechanical
|
|
37
|
+
transformation or translation of a Source form, including but
|
|
38
|
+
not limited to compiled object code, generated documentation,
|
|
39
|
+
and conversions to other media types.
|
|
40
|
+
|
|
41
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
42
|
+
Object form, made available under the License, as indicated by a
|
|
43
|
+
copyright notice that is included in or attached to the work
|
|
44
|
+
(an example is provided in the Appendix below).
|
|
45
|
+
|
|
46
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
47
|
+
form, that is based on (or derived from) the Work and for which the
|
|
48
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
49
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
50
|
+
of this License, Derivative Works shall not include works that remain
|
|
51
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
52
|
+
the Work and Derivative Works thereof.
|
|
53
|
+
|
|
54
|
+
"Contribution" shall mean any work of authorship, including
|
|
55
|
+
the original version of the Work and any modifications or additions
|
|
56
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
57
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
58
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
59
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
60
|
+
means any form of electronic, verbal, or written communication sent
|
|
61
|
+
to the Licensor or its representatives, including but not limited to
|
|
62
|
+
communication on electronic mailing lists, source code control systems,
|
|
63
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
64
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
65
|
+
excluding communication that is conspicuously marked or otherwise
|
|
66
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
67
|
+
|
|
68
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
69
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
70
|
+
subsequently incorporated within the Work.
|
|
71
|
+
|
|
72
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
73
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
74
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
75
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
76
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
77
|
+
Work and such Derivative Works in Source or Object form.
|
|
78
|
+
|
|
79
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
80
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
81
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
82
|
+
(except as stated in this section) patent license to make, have made,
|
|
83
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
84
|
+
where such license applies only to those patent claims licensable
|
|
85
|
+
by such Contributor that are necessarily infringed by their
|
|
86
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
87
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
88
|
+
institute patent litigation against any entity (including a
|
|
89
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
90
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
91
|
+
or contributory patent infringement, then any patent licenses
|
|
92
|
+
granted to You under this License for that Work shall terminate
|
|
93
|
+
as of the date such litigation is filed.
|
|
94
|
+
|
|
95
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
96
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
97
|
+
modifications, and in Source or Object form, provided that You
|
|
98
|
+
meet the following conditions:
|
|
99
|
+
|
|
100
|
+
(a) You must give any other recipients of the Work or
|
|
101
|
+
Derivative Works a copy of this License; and
|
|
102
|
+
|
|
103
|
+
(b) You must cause any modified files to carry prominent notices
|
|
104
|
+
stating that You changed the files; and
|
|
105
|
+
|
|
106
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
107
|
+
that You distribute, all copyright, patent, trademark, and
|
|
108
|
+
attribution notices from the Source form of the Work,
|
|
109
|
+
excluding those notices that do not pertain to any part of
|
|
110
|
+
the Derivative Works; and
|
|
111
|
+
|
|
112
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
113
|
+
distribution, then any Derivative Works that You distribute must
|
|
114
|
+
include a readable copy of the attribution notices contained
|
|
115
|
+
within such NOTICE file, excluding those notices that do not
|
|
116
|
+
pertain to any part of the Derivative Works, in at least one
|
|
117
|
+
of the following places: within a NOTICE text file distributed
|
|
118
|
+
as part of the Derivative Works; within the Source form or
|
|
119
|
+
documentation, if provided along with the Derivative Works; or,
|
|
120
|
+
within a display generated by the Derivative Works, if and
|
|
121
|
+
wherever such third-party notices normally appear. The contents
|
|
122
|
+
of the NOTICE file are for informational purposes only and
|
|
123
|
+
do not modify the License. You may add Your own attribution
|
|
124
|
+
notices within Derivative Works that You distribute, alongside
|
|
125
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
126
|
+
that such additional attribution notices cannot be construed
|
|
127
|
+
as modifying the License.
|
|
128
|
+
|
|
129
|
+
You may add Your own copyright statement to Your modifications and
|
|
130
|
+
may provide additional or different license terms and conditions
|
|
131
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
132
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
133
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
134
|
+
the conditions stated in this License.
|
|
135
|
+
|
|
136
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
137
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
138
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
139
|
+
this License, without any additional terms or conditions.
|
|
140
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
141
|
+
the terms of any separate license agreement you may have executed
|
|
142
|
+
with Licensor regarding such Contributions.
|
|
143
|
+
|
|
144
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
145
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
146
|
+
except as required for reasonable and customary use in describing the
|
|
147
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
148
|
+
|
|
149
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
150
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
151
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
152
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
153
|
+
implied, including, without limitation, any warranties or conditions
|
|
154
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
155
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
156
|
+
appropriateness of using or redistributing the Work and assume any
|
|
157
|
+
risks associated with Your exercise of permissions under this License.
|
|
158
|
+
|
|
159
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
160
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
161
|
+
unless required by applicable law (such as deliberate and grossly
|
|
162
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
163
|
+
liable to You for damages, including any direct, indirect, special,
|
|
164
|
+
incidental, or consequential damages of any character arising as a
|
|
165
|
+
result of this License or out of the use or inability to use the
|
|
166
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
167
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
168
|
+
other commercial damages or losses), even if such Contributor
|
|
169
|
+
has been advised of the possibility of such damages.
|
|
170
|
+
|
|
171
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
172
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
173
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
174
|
+
or other liability obligations and/or rights consistent with this
|
|
175
|
+
License. However, in accepting such obligations, You may act only
|
|
176
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
177
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
178
|
+
defend, and hold each Contributor harmless for any liability
|
|
179
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
180
|
+
of your accepting any such warranty or additional liability.
|
|
181
|
+
|
|
182
|
+
END OF TERMS AND CONDITIONS
|
|
183
|
+
|
|
184
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
185
|
+
|
|
186
|
+
To apply the Apache License to your work, attach the following
|
|
187
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
188
|
+
replaced with your own identifying information. (Don't include
|
|
189
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
190
|
+
comment syntax for the file format. We also recommend that a
|
|
191
|
+
file or class name and description of purpose be included on the
|
|
192
|
+
same "printed page" as the copyright notice for easier
|
|
193
|
+
identification within third-party archives.
|
|
194
|
+
|
|
195
|
+
Copyright [yyyy] [name of copyright owner]
|
|
196
|
+
|
|
197
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
198
|
+
you may not use this file except in compliance with the License.
|
|
199
|
+
You may obtain a copy of the License at
|
|
200
|
+
|
|
201
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
202
|
+
|
|
203
|
+
Unless required by applicable law or agreed to in writing, software
|
|
204
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
205
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
206
|
+
See the License for the specific language governing permissions and
|
|
207
|
+
limitations under the License.
|
|
208
|
+
License-File: LICENSE
|
|
209
|
+
Requires-Python: >=3.13
|
|
210
|
+
Requires-Dist: loguru>=0.7.3
|
|
211
|
+
Requires-Dist: typer-slim>=0.16.1
|
|
212
|
+
Provides-Extra: all
|
|
213
|
+
Requires-Dist: pytest>=8.4.1; extra == 'all'
|
|
214
|
+
Requires-Dist: ruff>=0.12.11; extra == 'all'
|
|
215
|
+
Description-Content-Type: text/markdown
|
|
216
|
+
|
|
217
|
+
<div align="center">
|
|
218
|
+
|
|
219
|
+
<img src="assets/front.png" alt="Image" />
|
|
220
|
+
|
|
221
|
+
## **Readme Weaver**
|
|
222
|
+
|
|
223
|
+
Seamlessly embed shared markdown into your **README** files! 🚀
|
|
224
|
+
|
|
225
|
+
[Description](#-description) • [How It Works](#-how-it-works) • [Setup - GitHub Action](#-setupgithub-action) • [Setup - Pre-Commit Hook](#-setupprecommit-hook) • [Examples](#-examples) • [Contributing](#-contributing) • [Development](#️-development)
|
|
226
|
+
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
## 📚 Description
|
|
230
|
+
|
|
231
|
+
**Readme Weaver** is a tool to keep your project documentation in sync with
|
|
232
|
+
shared markdown snippets. It scans your markdown files for "include"
|
|
233
|
+
directives, then replaces those blocks with the latest content from external
|
|
234
|
+
files. This is ideal for organisations that maintain common sections such as
|
|
235
|
+
sponsorship, contribution guidelines, or security policies across many
|
|
236
|
+
repositories.
|
|
237
|
+
|
|
238
|
+
By automating the inclusion of shared markdown, Readme Weaver helps you keep
|
|
239
|
+
your docs DRY and up‑to‑date without manual copying.
|
|
240
|
+
|
|
241
|
+
### ✨ Key Features
|
|
242
|
+
|
|
243
|
+
- **Embed shared markdown:** insert external markdown files into your README
|
|
244
|
+
between clearly marked start and end tags.
|
|
245
|
+
- **Easy integration:** use as a GitHub Action, a pre‑commit hook, or run it
|
|
246
|
+
manually with `uv` or `pip`.
|
|
247
|
+
- **Idempotent updates:** only the region between the include tags is replaced,
|
|
248
|
+
preserving your surrounding content.
|
|
249
|
+
|
|
250
|
+
## 🔍 How It Works
|
|
251
|
+
|
|
252
|
+
Readme Weaver looks for specially formatted comment blocks in your markdown files:
|
|
253
|
+
|
|
254
|
+
```markdown
|
|
255
|
+
<!-- md:include start path="partials/sponsorship.md" required=true -->
|
|
256
|
+
|
|
257
|
+
…something…
|
|
258
|
+
|
|
259
|
+
<!-- md:include end -->
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
- The `path` attribute is required and specifies the location of the file to
|
|
263
|
+
embed. Paths can be absolute or relative to the base directory (defaults to the
|
|
264
|
+
working directory or to `README_WEAVER_BASE` if set).
|
|
265
|
+
- The optional `required` attribute (default `true`) controls behaviour when
|
|
266
|
+
the file is missing:
|
|
267
|
+
- `required=true` (or omitted): raises an error if the file is not found.
|
|
268
|
+
- `required=false`: leaves the block empty if the file is missing.
|
|
269
|
+
- Everything between the start and end markers is replaced with the contents of
|
|
270
|
+
the referenced file on each run.
|
|
271
|
+
|
|
272
|
+
> [!TIP]
|
|
273
|
+
> By default, relative paths are resolved from the current working directory.
|
|
274
|
+
> To embed files from a different location (for example, another repository),
|
|
275
|
+
> set the `README_WEAVER_BASE` environment variable or pass `--base-dir` on the
|
|
276
|
+
> command line:
|
|
277
|
+
>
|
|
278
|
+
> ```bash
|
|
279
|
+
> README_WEAVER_BASE=../my-org/.github uv run readme-weaver run --all-files
|
|
280
|
+
> ```
|
|
281
|
+
|
|
282
|
+
## 🔧 Setup – GitHub Action
|
|
283
|
+
|
|
284
|
+
Add Readme Weaver as a step in your GitHub Actions workflow to automatically
|
|
285
|
+
weave partials on each pull request. Here’s a sample workflow:
|
|
286
|
+
|
|
287
|
+
```yaml
|
|
288
|
+
name: readme weaver
|
|
289
|
+
|
|
290
|
+
on:
|
|
291
|
+
push:
|
|
292
|
+
branches:
|
|
293
|
+
- main
|
|
294
|
+
|
|
295
|
+
permissions:
|
|
296
|
+
contents: write
|
|
297
|
+
|
|
298
|
+
jobs:
|
|
299
|
+
weave-readme:
|
|
300
|
+
runs-on: ubuntu-latest
|
|
301
|
+
steps:
|
|
302
|
+
- uses: actions/checkout@v5
|
|
303
|
+
|
|
304
|
+
- name: checkout partials
|
|
305
|
+
uses: actions/checkout@v5
|
|
306
|
+
with:
|
|
307
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
|
308
|
+
repository: devops-roast/.github
|
|
309
|
+
path: partials
|
|
310
|
+
ref: main
|
|
311
|
+
|
|
312
|
+
- name: run readme weaver
|
|
313
|
+
uses: devops-roast/readme-weaver@v1
|
|
314
|
+
env:
|
|
315
|
+
LOG_LEVEL: DEBUG
|
|
316
|
+
# base directory for include files (if needed)
|
|
317
|
+
README_WEAVER_BASE: ./partials/.github/common-markdown-files
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
## 🔧 Setup – Pre‑Commit Hook
|
|
321
|
+
|
|
322
|
+
Readme Weaver can run as a pre‑commit hook to ensure your includes are always
|
|
323
|
+
up‑to‑date before committing. To install via PyPI:
|
|
324
|
+
|
|
325
|
+
```bash
|
|
326
|
+
pip install readme-weaver==v1.0.0
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
Then add this to your `.pre-commit-config.yaml`:
|
|
330
|
+
|
|
331
|
+
```yaml
|
|
332
|
+
- repo: local
|
|
333
|
+
hooks:
|
|
334
|
+
- id: readme-weaver
|
|
335
|
+
name: readme-weaver
|
|
336
|
+
entry: readme-weaver run
|
|
337
|
+
language: system
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
If you prefer to reference the repository directly:
|
|
341
|
+
|
|
342
|
+
```yaml
|
|
343
|
+
- repo: https://github.com/devops-roast/readme-weaver
|
|
344
|
+
rev: v1.0.0
|
|
345
|
+
hooks:
|
|
346
|
+
- id: readme-weaver
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
> [!NOTE]
|
|
350
|
+
> The `--all-files` option is not needed in pre‑commit; by default only changed
|
|
351
|
+
> files are processed.
|
|
352
|
+
|
|
353
|
+
## 🔧 Options
|
|
354
|
+
|
|
355
|
+
| Option | Description |
|
|
356
|
+
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
357
|
+
| `--all-files` | Process all markdown files in the repository rather than only changed files (useful outside pre‑commit). |
|
|
358
|
+
| `--base-dir`/`-b` | Override the base directory for resolving relative include paths. Defaults to `README_WEAVER_BASE` or the current directory. |
|
|
359
|
+
| `--log-level`/`-l` | Set the logging level (`DEBUG`, `INFO`, `WARNING`, or `ERROR`). Overrides the `LOG_LEVEL` environment variable. |
|
|
360
|
+
| `--help` | Show the command line help. |
|
|
361
|
+
|
|
362
|
+
## 💡 Examples
|
|
363
|
+
|
|
364
|
+
Suppose you keep shared markdown files in a `partials` directory and want to
|
|
365
|
+
embed a common sponsorship section into every `README.md`.
|
|
366
|
+
|
|
367
|
+
**partials/sponsorship.md**:
|
|
368
|
+
|
|
369
|
+
```markdown
|
|
370
|
+
## Sponsor our work
|
|
371
|
+
|
|
372
|
+
Your support helps us build great software! ✨ Visit [our sponsoring page](https://example.com) to become a sponsor.
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
**README.md**:
|
|
376
|
+
|
|
377
|
+
```markdown
|
|
378
|
+
# My Project
|
|
379
|
+
|
|
380
|
+
Welcome to my project.
|
|
381
|
+
|
|
382
|
+
<!-- md:include start path="partials/sponsorship.md" required=true -->
|
|
383
|
+
<!-- placeholder content will be replaced -->
|
|
384
|
+
<!-- md:include end -->
|
|
385
|
+
|
|
386
|
+
## Usage
|
|
387
|
+
|
|
388
|
+
More docs here…
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
When you run Readme Weaver (manually, as a pre‑commit hook, or via GitHub
|
|
392
|
+
Actions), the section between the include tags is replaced:
|
|
393
|
+
|
|
394
|
+
```markdown
|
|
395
|
+
# My Project
|
|
396
|
+
|
|
397
|
+
Welcome to my project.
|
|
398
|
+
|
|
399
|
+
<!-- md:include start path="partials/sponsorship.md" required=true -->
|
|
400
|
+
<!-- content below is auto-generated; do not edit -->
|
|
401
|
+
|
|
402
|
+
## Sponsor our work
|
|
403
|
+
|
|
404
|
+
Your support helps us build great software! ✨ Visit [our sponsoring page](https://example.com) to become a sponsor.
|
|
405
|
+
|
|
406
|
+
<!-- md:include end -->
|
|
407
|
+
|
|
408
|
+
## Usage
|
|
409
|
+
|
|
410
|
+
More docs here…
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
If `partials/sponsorship.md` changes, rerunning the tool automatically updates
|
|
414
|
+
all READMEs that include it.
|
|
415
|
+
|
|
416
|
+
### Optional Includes
|
|
417
|
+
|
|
418
|
+
If you mark an include as non‑required (`required=false`) and the file is
|
|
419
|
+
missing, the block is simply left empty:
|
|
420
|
+
|
|
421
|
+
```markdown
|
|
422
|
+
<!-- md:include start path="partials/missing.md" required=false -->
|
|
423
|
+
<!-- md:include end -->
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
After running the tool, the section is removed without error.
|
|
427
|
+
|
|
428
|
+
## 🤝 Contributing
|
|
429
|
+
|
|
430
|
+
Contributions are welcome! To suggest an enhancement, report a bug, or submit a pull request:
|
|
431
|
+
|
|
432
|
+
- [Open a feature request](https://github.com/devops-roast/readme-weaver/issues/new?labels=enhancement&template=feature.yml) for new functionality.
|
|
433
|
+
- [Open a bug report](https://github.com/devops-roast/readme-weaver/issues/new?template=bug.yml) if something isn’t working as expected.
|
|
434
|
+
- Fork the repository, create a feature branch, make your changes and tests,
|
|
435
|
+
then open a pull request. Please ensure all tests pass and follow the existing
|
|
436
|
+
code style.
|
|
437
|
+
|
|
438
|
+
See the [Contributing Guide](https://github.com/devops-roast/readme-weaver?tab=contributing-ov-file) for detailed guidelines.
|
|
439
|
+
|
|
440
|
+
## 🛠️ Development
|
|
441
|
+
|
|
442
|
+
1. Fork this project
|
|
443
|
+
1. Install [mise](https://mise.jdx.dev/installing-mise.html).
|
|
444
|
+
1. Install the dependencies by using the following command:
|
|
445
|
+
```bash
|
|
446
|
+
mise trust
|
|
447
|
+
mise install
|
|
448
|
+
uv pip install --system . -r pyproject.toml --all-extras
|
|
449
|
+
```
|
|
450
|
+
1. Make changes to the codebase and run the tests to make sure everything works as expected. ✅
|
|
451
|
+
```bash
|
|
452
|
+
pytest -q
|
|
453
|
+
```
|
|
454
|
+
1. Commit your changes, push them to the repository 🚀, and open a new pull request.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
readme_weaver/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
+
readme_weaver/include_content_reader.py,sha256=e4_q1B1q0KQu_30_lRAMN8HXwF427q1lbzCXqMTG2Y0,2791
|
|
3
|
+
readme_weaver/include_metadata.py,sha256=Z3QQjQnjNAGcy9TsEZu4zBOOZ4_GoPhfpmDf3ync-AA,1142
|
|
4
|
+
readme_weaver/include_metadata_extractor.py,sha256=8sWwGxCZbCkrlBA2QG7EVxF_j16GlwUzscNOa25Fzx8,3868
|
|
5
|
+
readme_weaver/main.py,sha256=bHNpMXOZnbMnW7Q-V-68713QwFbiRyYv0YWJCl6HjYc,3014
|
|
6
|
+
readme_weaver/readme_weaver.py,sha256=A4hBwS0Mo5Xjopn9dOzilVI7RyIyOuxhkyMybtSQpb0,3240
|
|
7
|
+
readme_weaver-0.1.0.dist-info/METADATA,sha256=KVnjxVRprHIu0ns_QFgwdqvtiYZ9R-TTfZJ-MjcHsKw,21149
|
|
8
|
+
readme_weaver-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
9
|
+
readme_weaver-0.1.0.dist-info/entry_points.txt,sha256=kn8PmOOIiDnzFQTYEO7L2eWUYnK1ds9of8pSWRGV4Ic,57
|
|
10
|
+
readme_weaver-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
11
|
+
readme_weaver-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|