xproject-python 0.1__py3-none-any.whl

xproject_python/attribute.py

@@ -0,0 +1,8 @@
+# coding:utf-8
+
+__version__ = "0.1"
+
+# project info
+__project_name__ = "xproject"
+__project_home__ = "https://github.com/bondbox/xproject/"
+__project_desc__ = "Initialize project files"

xproject_python/configure.py

@@ -0,0 +1,162 @@
+# coding:utf-8
+
+from dataclasses import dataclass
+from dataclasses import field
+from errno import ENOENT
+from typing import Dict
+from typing import List
+from typing import Optional
+from typing import Sequence
+
+from xkits_command.actuator import Command
+from xkits_command.actuator import CommandArgument
+from xkits_command.actuator import CommandExecutor
+from xkits_command.parser import ArgParser
+from xkits_config import Settings
+from xkits_config_toml import ConfigTOML
+
+from xproject_python.attribute import __project_home__ as xproject_home
+from xproject_python.attribute import __project_name__ as xproject_name
+from xproject_python.attribute import __version__ as version
+
+DEFAULT_CONFIG_FILE: str = f".{xproject_name}_python"
+
+
+@dataclass
+class AuthorConfig(Settings):
+    name: str
+    email: str
+
+
+@dataclass
+class ModuleConfig(Settings):
+    base: Optional[str] = None
+    package: Optional[List[str]] = None
+    omitted: List[str] = field(default_factory=list)
+    exclude: List[str] = field(default_factory=list)
+    include: Dict[str, str] = field(default_factory=dict)
+    scripts: Dict[str, str] = field(default_factory=dict)
+    templates: Dict[str, bool] = field(default_factory=dict)
+
+
+@dataclass
+class PackageConfig(Settings):  # pylint: disable=too-many-instance-attributes
+    base: Optional[str] = None
+    version: Optional[str] = None
+    requires_python: Optional[str] = None
+    authors: List[str] = field(default_factory=list)
+    keywords: List[str] = field(default_factory=list)
+    requirements: List[str] = field(default_factory=list)
+    modules: Dict[str, ModuleConfig] = field(default_factory=dict)
+    max_complexity: int = 10
+    max_line_length: int = 127
+
+
+@dataclass
+class ProjectConfig(ConfigTOML):
+    name: str = xproject_name
+    home: str = xproject_home
+    description: str = f"Automatically created by [{xproject_name}]({xproject_home})."  # noqa:E501
+    authors: Dict[str, AuthorConfig] = field(default_factory=dict)
+    keywords: List[str] = field(default_factory=list)
+    packages: Dict[str, PackageConfig] = field(default_factory=dict)
+    version: str = "0.1.alpha.1"
+
+
+@CommandArgument("update", help="Update Python project configuration")
+def add_cmd_config_update(_arg: ArgParser):
+    pass
+
+
+@CommandExecutor(add_cmd_config_update)
+def run_cmd_config_update(cmds: Command) -> int:
+    try:
+        ProjectConfig.loadf(cmds.args.file).dumpf(cmds.args.file)
+        cmds.stderr_green(f"Configuration file {cmds.args.file} updated")
+        return 0
+    except FileNotFoundError:
+        cmds.stderr_red(f"Configuration file {cmds.args.file} not found")
+        return ENOENT
+
+
+@CommandArgument("config", help="Manage Python project configuration")
+def add_cmd_config(_arg: ArgParser):
+    _arg.add_argument("--file", dest="file", type=str, nargs=None,
+                      metavar="FILE", default=DEFAULT_CONFIG_FILE,
+                      help="Specify configuration file")
+
+
+@CommandExecutor(add_cmd_config, add_cmd_config_update)
+def run_cmd_config(cmds: Command) -> int:  # pylint: disable=unused-argument
+    return 0
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    cmds = Command()
+    cmds.version = version
+    return cmds.run(root=add_cmd_config, argv=argv, epilog=f"For more, please visit {xproject_home}.")  # noqa:E501
+
+
+if __name__ == "__main__":
+    project_name: str = "xproject"
+    project_home: str = "https://github.com/bondbox/xproject/"
+    project_desc: str = "Initialize project files"
+
+    ProjectConfig(
+        name=project_name,
+        home=project_home,
+        description=project_desc,
+        authors={
+            "zoumingzhe": AuthorConfig(
+                name="Mingzhe Zou",
+                email="zoumingzhe@outlook.com",
+            ),
+        },
+        keywords=[
+            "project",
+        ],
+        packages={
+            f"{project_name}-python": PackageConfig(
+                base=f"{project_name}-python",
+                version=None,
+                requires_python=">=3.8",
+                authors=[
+                    "zoumingzhe",
+                ],
+                keywords=[
+                ],
+                requirements=[
+                    "xkits-command",
+                    "xkits-config-toml>=0.5",
+                    "xkits-file>=0.9",
+                    "prompt-toolkit",
+                ],
+                modules={
+                    f"{project_name}-python": ModuleConfig(
+                        base=f"{project_name}_python",
+                        package=None,
+                        omitted=[
+                            "attribute.py",
+                            "unittest/*",
+                        ],
+                        exclude=[
+                            "unittest",
+                        ],
+                        include={
+                            "templates": "templates",
+                        },
+                        scripts={
+                            f"{project_name}-python": "blueprint:main",
+                        },
+                        templates={
+                            "__init__.py": False,
+                            "attribute.py": True,
+                        },
+                    ),
+                },
+                max_complexity=15,
+                max_line_length=127,
+            ),
+        },
+        version="0.1.alpha.1",
+    ).dumpf(DEFAULT_CONFIG_FILE)

xproject_python/projector.py

@@ -0,0 +1,367 @@
+# coding:utf-8
+
+from errno import ENOENT
+from json import dumps
+from pathlib import Path
+from sys import version_info
+from typing import Dict
+from typing import Iterator
+from typing import List
+from typing import Optional
+from typing import Sequence
+from typing import Tuple
+from typing import Union
+
+from packaging.specifiers import SpecifierSet
+from xkits_command.actuator import Command
+from xkits_command.actuator import CommandArgument
+from xkits_command.actuator import CommandExecutor
+from xkits_command.parser import ArgParser
+from xkits_file.template import TemplateManagerPath
+from xkits_file.template import Variable
+
+from xproject_python.attribute import __project_home__ as project_home
+from xproject_python.attribute import __version__ as version
+from xproject_python.configure import AuthorConfig
+from xproject_python.configure import DEFAULT_CONFIG_FILE
+from xproject_python.configure import ModuleConfig
+from xproject_python.configure import PackageConfig
+from xproject_python.configure import ProjectConfig
+from xproject_python.utilities import CoverageRC
+from xproject_python.utilities import Flake8
+from xproject_python.utilities import PylintRC
+from xproject_python.utilities import Pyproject
+from xproject_python.utilities import Requirements
+
+TEMPLATES: Path = Path(__file__).parent / "templates"
+
+
+class Module:
+    TEMPLATES_MODULE: Path = TEMPLATES / "module"
+    ATTRIBUTE: str = "attribute.py"
+    DOT: str = "."
+
+    def __init__(self, name: str, config: PackageConfig, variable: Optional[Variable] = None):  # noqa:E501
+        option: ModuleConfig = config.modules[name]
+
+        variables: Variable = variable.duplicate()if isinstance(variable, Variable) else Variable()  # noqa:E501
+        variables.set_default("module_name", module_name := self.normalize(name))  # noqa:E501
+
+        self.__name: str = module_name
+        self.__option: ModuleConfig = option
+        self.__variable: Variable = variables
+
+    @property
+    def name(self) -> str:
+        return self.__name
+
+    @property
+    def base(self) -> str:
+        return self.option.base or self.DOT
+
+    @property
+    def option(self) -> ModuleConfig:
+        return self.__option
+
+    @property
+    def variable(self) -> Variable:
+        return self.__variable
+
+    @property
+    def include(self) -> Iterator[Tuple[str, str]]:
+        for name, path in self.option.include.items():
+            yield name, self.path_join(path)
+
+    @property
+    def exclude(self) -> Iterator[str]:
+        for path in self.option.exclude:
+            yield self.path_join(path)
+
+    @property
+    def package(self) -> Iterator[str]:
+        if self.option.package is not None:
+            for path in self.option.package:
+                yield self.path_join(path)
+        else:
+            yield self.base
+
+    @property
+    def omitted(self) -> Iterator[str]:
+        for path in self.option.omitted:
+            yield self.path_join(path)
+
+    @property
+    def scripts(self) -> Iterator[Tuple[str, str]]:
+        for name, entry in self.option.scripts.items():
+            point: str = (parts := entry.rsplit(":", maxsplit=1)).pop()
+            yield name, ":".join([self.dot_join(*parts), point])
+
+    def prepend(self, *parts: str) -> Tuple[str, ...]:
+        return (base, *parts) if (base := self.base) != self.DOT else parts  # noqa:E501
+
+    def dot_join(self, *parts: str) -> str:
+        return self.DOT.join(self.prepend(*parts))
+
+    def path_join(self, *parts: str) -> str:
+        return Path(*self.prepend(*parts)).as_posix()
+
+    @classmethod
+    def normalize(cls, name: str) -> str:
+        return Requirements.normalize(requirement=name).name.replace("-", "_")
+
+    def dump(self, base: Union[str, Path], writable: bool = False) -> None:
+        root: Path = base if isinstance(base, Path) else Path(base)
+
+        files: List[str] = [
+            name for name, edit in self.option.templates.items()
+            if not (root / name).exists() or edit
+        ]
+
+        templates: TemplateManagerPath = TemplateManagerPath(self.variable)
+        templates.load(base=self.TEMPLATES_MODULE, include=files)
+        templates.dump(base=root, writable=writable)
+
+
+class Package:  # pylint: disable=too-many-instance-attributes
+    TEMPLATES_PACKAGE: Path = TEMPLATES / "package"
+    FILES: List[str] = ["Makefile"]
+
+    def __init__(self, name: str, config: ProjectConfig, variable: Optional[Variable] = None):  # pylint: disable=too-many-locals # noqa:E501
+        option: PackageConfig = config.packages[name]
+
+        variables: Variable = variable.duplicate() if isinstance(variable, Variable) else Variable()  # noqa:E501
+        variables.set_default("package_name", package_name := Requirements.normalize(requirement=name).name)  # noqa:E501
+        variables.set_default("package_version", package_version := option.version or config.version)  # noqa:E501
+
+        authors: List[AuthorConfig] = [config.authors[index] for index in option.authors]  # noqa:E501
+        variables.set_default("authors", dumps(authors, indent=4, default=lambda i: i.__dict__))  # noqa:E501
+
+        coverage: CoverageRC = CoverageRC.load(self.TEMPLATES_PACKAGE / CoverageRC.FILENAME)  # noqa:E501
+        flake8: Flake8 = Flake8.load(self.TEMPLATES_PACKAGE / Flake8.FILENAME)
+        pylint: PylintRC = PylintRC.load(self.TEMPLATES_PACKAGE / PylintRC.FILENAME)  # noqa:E501
+
+        python_version: str = option.requires_python or f"{version_info.major}.{version_info.minor}"  # noqa:E501
+        pyproject: Pyproject = Pyproject.load(self.TEMPLATES_PACKAGE / Pyproject.FILENAME)  # noqa:E501
+        pyproject.project["name"] = package_name
+        pyproject.project["description"] = config.description
+        pyproject.project["requires-python"] = python_version
+        pyproject.project_authors.extend(author.__dict__ for author in authors)
+        pyproject.project_keywords.extend(config.keywords)
+        pyproject.project_keywords.extend(option.keywords)
+        pyproject.project_urls["Homepage"] = config.home
+
+        requirements: Requirements = Requirements()
+        for requirement in option.requirements:
+            requirements.add(requirement)
+
+        self.__name: str = package_name
+        self.__version: str = package_version
+        self.__option: PackageConfig = option
+        self.__variable: Variable = variables
+        self.__coverage: CoverageRC = coverage
+        self.__flake8: Flake8 = flake8
+        self.__pylint: PylintRC = pylint
+        self.__pyproject: Pyproject = pyproject
+        self.__requirements: Requirements = requirements
+
+    def __iter__(self) -> Iterator[Module]:
+        for name in self.option.modules:
+            yield Module(name=name, config=self.option, variable=self.variable)
+
+    @property
+    def name(self) -> str:
+        return self.__name
+
+    @property
+    def version(self) -> str:
+        return self.__version
+
+    @property
+    def base(self) -> str:
+        return self.option.base or "."
+
+    @property
+    def option(self) -> PackageConfig:
+        return self.__option
+
+    @property
+    def variable(self) -> Variable:
+        return self.__variable
+
+    @property
+    def coverage(self) -> CoverageRC:
+        return self.__coverage
+
+    @property
+    def flake8(self) -> Flake8:
+        return self.__flake8
+
+    @property
+    def pylint(self) -> PylintRC:
+        return self.__pylint
+
+    @property
+    def pyproject(self) -> Pyproject:
+        return self.__pyproject
+
+    @property
+    def requirements(self) -> Requirements:
+        return self.__requirements
+
+    def dump(self, base: Union[str, Path], writable: bool = False) -> None:  # pylint: disable=too-many-locals # noqa:E501
+        root: Path = base if isinstance(base, Path) else Path(base)
+        modules: List[Module] = list(iter(self))
+
+        attribute_modules: List[Module] = []
+        coverage_omit: str = ""
+        coverage_source: str = ""
+        flake8_exclude: str = ""
+        flake8_modules: List[str] = []
+        pylint_files: List[str] = []
+
+        for module in sorted(modules, key=lambda m: m.base):
+            for include_name, include_path in module.include:
+                self.pyproject.tool_hatch_build_targets_sdist_force_include[include_name] = include_path  # noqa:E501
+                self.pyproject.tool_hatch_build_targets_wheel_force_include[include_name] = include_path  # noqa:E501
+
+            for exclude in module.exclude:
+                self.pyproject.tool_hatch_build_targets_sdist_exclude.append(exclude)  # noqa:E501
+                self.pyproject.tool_hatch_build_targets_wheel_exclude.append(exclude)  # noqa:E501
+                flake8_exclude += f"\n{exclude}"
+
+            for package in module.package:
+                self.pyproject.tool_hatch_build_targets_sdist_packages.append(package)  # noqa:E501
+                self.pyproject.tool_hatch_build_targets_wheel_packages.append(package)  # noqa:E501
+                coverage_source += f"\n{package.removesuffix('.py')}"
+                flake8_modules.append(package)
+
+            pylint_files.append(f"{module.base}/*.py")
+
+            for omitted in module.omitted:
+                coverage_omit += f"\n{omitted}"
+
+            for script_name, script_entry in module.scripts:
+                self.pyproject.project_scripts[script_name] = script_entry
+
+            if Module.ATTRIBUTE in module.option.templates:
+                attribute_modules.append(module)
+
+        if (attribute_module_number := len(attribute_modules)) > 1:
+            raise ValueError(f"Package {self.name} has more than one attribute module: {', '.join(m.name for m in attribute_modules)}")  # noqa:E501
+        if attribute_module_number < 1:
+            raise ValueError(f"Package {self.name} has no attribute module")
+
+        self.coverage.parser["run"]["omit"] = coverage_omit
+        self.coverage.parser["run"]["source"] = coverage_source
+        self.flake8.parser["flake8"]["exclude"] = flake8_exclude
+        self.flake8.parser["flake8"]["max-complexity"] = str(self.option.max_complexity)  # noqa:E501
+        self.flake8.parser["flake8"]["max-line-length"] = str(self.option.max_line_length)  # noqa:E501
+
+        variables: Variable = self.variable
+        variables.set_default("attribute_module", attribute_modules[0].dot_join(Path(Module.ATTRIBUTE).stem))  # noqa:E501
+        variables.set_default("flake8_modules", " ".join(flake8_modules))
+        variables.set_default("pylint_files", " ".join(pylint_files))
+
+        templates: TemplateManagerPath = TemplateManagerPath(variables)
+        templates.load(base=self.TEMPLATES_PACKAGE, include=self.FILES)
+        templates.dump(base=root, writable=writable)
+
+        self.requirements.dumpf(filepath=root / Requirements.FILENAME, writable=writable)  # noqa:E501
+        self.pyproject.tool_hatch_metadata_hooks_requirements_txt_files.append(Requirements.FILENAME)  # noqa:E501
+        self.pyproject.tool_hatch_version["path"] = attribute_modules[0].path_join(Module.ATTRIBUTE)  # noqa:E501
+        self.pyproject.dump(filepath=root / Pyproject.FILENAME, writable=writable)  # noqa:E501
+
+        self.coverage.dump(filepath=root / CoverageRC.FILENAME, writable=writable)  # noqa:E501
+        self.flake8.dump(filepath=root / Flake8.FILENAME, writable=writable)  # noqa:E501
+        self.pylint.dump(filepath=root / PylintRC.FILENAME, writable=writable)  # noqa:E501
+
+        for module in modules:
+            module.dump(base=root / module.base, writable=writable)
+
+
+class Project:
+    TEMPLATES_PROJECT: Path = TEMPLATES / "project"
+
+    def __init__(self, config: ProjectConfig):
+        project_name: str = Requirements.normalize(requirement=config.name).name  # noqa:E501
+
+        variables: Variable = Variable(
+            project_name=project_name,
+            project_home=config.home,
+            project_description=config.description,
+        )
+
+        self.__name: str = project_name
+        self.__option: ProjectConfig = config
+        self.__variable: Variable = variables
+
+    def __iter__(self) -> Iterator[Package]:
+        for name in self.option.packages:
+            yield Package(name=name, config=self.option, variable=self.variable)  # noqa:E501
+
+    @property
+    def name(self) -> str:
+        return self.__name
+
+    @property
+    def option(self) -> ProjectConfig:
+        return self.__option
+
+    @property
+    def variable(self) -> Variable:
+        return self.__variable
+
+    def dump(self, base: Union[str, Path], writable: bool = False) -> None:
+        root: Path = base if isinstance(base, Path) else Path(base)
+
+        templates: TemplateManagerPath = TemplateManagerPath(self.variable)
+        templates.load(base=self.TEMPLATES_PROJECT, include=None)
+        templates.dump(base=root, writable=writable)
+
+        packages: Dict[str, Package] = {package.name: package for package in iter(self)}  # noqa:E501
+
+        for package in packages.values():
+            dest: Path = root / package.base
+
+            for requirement in package.requirements:
+                if dependence := packages.get(requirement.name):
+                    requirement.specifier = SpecifierSet(f">={dependence.version}")  # noqa:E501
+
+            package.dump(base=dest, writable=writable)
+
+            if dest != root:
+                if not (readme_link := dest / "readme.md").exists():
+                    readme_link.symlink_to("../readme.md")
+
+
+@CommandArgument("generate", help="Create or update Python project files")
+def add_cmd_generate(_arg: ArgParser):
+    _arg.add_opt_on("--change", help="allow changes to existing files")
+    _arg.add_opt("--config", dest="config", type=str, nargs=None,
+                 metavar="FILE", default=DEFAULT_CONFIG_FILE,
+                 help="Specify configuration file")
+    _arg.add_pos("root", type=str, nargs="?", metavar="PATH", default=".",
+                 help="Project root directory")
+
+
+@CommandExecutor(add_cmd_generate)
+def run_cmd_generate(cmds: Command) -> int:
+    try:
+        config: ProjectConfig = ProjectConfig.loadf(cmds.args.config)
+    except FileNotFoundError:
+        cmds.stderr_red(f"Configuration file {cmds.args.config} not found")
+        return ENOENT
+
+    root: Path = Path(cmds.args.root).resolve()
+    cmds.stderr_yellow(f"Generate to root directory: {root}")
+
+    project: Project = Project(config=config)
+    project.dump(base=root, writable=cmds.args.change)
+    cmds.stderr_green(f"Project {project.name} generated")
+    return 0
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    cmds = Command()
+    cmds.version = version
+    return cmds.run(root=add_cmd_generate, argv=argv, epilog=f"For more, please visit {project_home}.")  # noqa:E501

xproject_python/templates/module/attribute.py

@@ -0,0 +1,8 @@
+# coding:utf-8
+
+__version__ = "{package_version}"
+
+# project info
+__project_name__ = "{project_name}"
+__project_home__ = "{project_home}"
+__project_desc__ = "{project_description}"

xproject_python/templates/package/.coveragerc

@@ -0,0 +1,12 @@
+[run]
+omit =
+source =
+
+[report]
+exclude_lines =
+    pragma: no cover
+    raise NotImplementedError
+    if __name__ == .__main__.:
+    def __repr__
+    pass
+fail_under = 100

xproject_python/templates/package/.flake8

@@ -0,0 +1,9 @@
+[flake8]
+count = True
+exclude =
+filename = *.py
+max-complexity =
+max-line-length =
+show-source = True
+statistics = True
+exit-zero = False

xproject_python/templates/package/.pylintrc

@@ -0,0 +1,7 @@
+[MASTER]
+disable =
+    C0103,   # invalid-name
+    C0114,   # missing-module-docstring
+    C0115,   # missing-class-docstring
+    C0116,   # missing-function-docstring
+    C0301,   # line-too-long

xproject_python/templates/package/Makefile

@@ -0,0 +1,59 @@
+MAKEFLAGS += --always-make
+
+VERSION ?= $(shell python3 -c "from {attribute_module} import __version__; print(__version__)")
+
+all: build test
+
+
+release: all
+	if [ -n "${{VERSION}}" ]; then \
+		git tag -a v${{VERSION}} -m "release v${{VERSION}}"; \
+		git push origin --tags; \
+	fi
+
+version:
+	@echo ${{VERSION}}
+
+
+upload:
+	python3 -m pip install --upgrade xpip-upload
+	xpip-upload --config-file .pypirc dist/*
+
+
+build-prepare:
+	python3 -m pip install --upgrade xpip-build
+build-clean:
+	find . -type d -name "__pycache__" -exec rm -rf {{}} +
+	rm -rf build dist *.egg-info
+build: build-prepare build-clean
+	python3 -m build --sdist --wheel
+
+
+install-requirements:
+	python3 -m pip install --upgrade -r requirements.txt
+install: install-requirements
+	python3 -m pip install --force-reinstall --no-deps dist/*.whl
+uninstall:
+	python3 -m pip uninstall -y {package_name}
+reinstall: uninstall install
+
+
+test-prepare: install-requirements
+	python3 -m pip install --upgrade mock flake8 pylint pytest pytest-cov
+flake8:
+	flake8 {flake8_modules}
+pylint:
+	pylint $(shell git ls-files {pylint_files})
+pytest:
+	pytest --cov --cov-config=.coveragerc --cov-report=term-missing --cov-report=xml --cov-report=html
+pytest-clean:
+	rm -rf .pytest_cache
+test: test-prepare flake8 pylint pytest
+test-clean: pytest-clean
+
+
+clean-cover:
+	rm -rf cover .coverage coverage.xml htmlcov
+clean-tox:
+	rm -rf .stestr .tox
+clean: build-clean test-clean clean-cover clean-tox

xproject_python/templates/package/hatch_build.py

@@ -0,0 +1,9 @@
+# flake8: noqa: E402
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+
+class CustomMetadataHook(MetadataHookInterface):  # pylint: disable=R0903
+
+    def update(self, metadata: dict) -> None:
+        pass

xproject_python/templates/package/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = [
+    "hatch-requirements-txt",
+    "hatchling",
+    "xpip-build>=1.4",
+]
+
+[project]
+authors = []
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+]
+description = ""
+dynamic = [
+    "dependencies",
+    "version",
+]
+keywords = []
+license-files = [ "LICENSE",]
+name = ""
+requires-python = ""
+
+[project.readme]
+content-type = "text/markdown"
+file = "readme.md"
+
+[project.scripts]
+
+[project.urls]
+
+[tool.hatch.version]
+
+[tool.hatch.build.targets.sdist]
+exclude = []
+packages = []
+
+[tool.hatch.build.targets.wheel]
+exclude = []
+packages = []
+
+[tool.hatch.metadata.hooks.requirements_txt]
+files = []
+
+[tool.hatch.build.targets.sdist.force-include]
+
+[tool.hatch.build.targets.wheel.force-include]

xproject_python/templates/project/readme.md

@@ -0,0 +1,3 @@
+# {project_name}
+
+> {project_description}

xproject_python/utilities.py

@@ -0,0 +1,216 @@
+# coding:utf-8
+
+from configparser import ConfigParser
+from pathlib import Path
+from typing import Any
+from typing import Dict
+from typing import Iterator
+from typing import List
+from typing import Optional
+from typing import Type
+from typing import TypeVar
+from typing import Union
+
+from packaging.requirements import Requirement
+from toml import dump
+from toml import load
+
+
+CFGT = TypeVar("CFGT", bound="Configuration")
+
+
+class Configuration:
+
+    def __init__(self, parser: Optional[ConfigParser] = None):
+        self.__parser: ConfigParser = parser or ConfigParser()
+
+    @property
+    def parser(self) -> ConfigParser:
+        return self.__parser
+
+    def dump(self, filepath: Union[str, Path], writable: bool = False):
+        if isinstance(filepath, str):
+            filepath = Path(filepath)  # pragma: no cover
+
+        if not filepath.exists() or writable:
+            with filepath.open("w", encoding="utf-8") as whdl:
+                self.parser.write(whdl)
+
+    @classmethod
+    def load(cls: Type[CFGT], filepath: Union[str, Path]) -> CFGT:
+        (parser := ConfigParser()).read(filepath)
+        return cls(parser=parser)
+
+
+class CoverageRC(Configuration):
+    FILENAME: str = ".coveragerc"
+
+
+class Flake8(Configuration):
+    FILENAME: str = ".flake8"
+
+
+class PylintRC(Configuration):
+    FILENAME: str = ".pylintrc"
+
+
+class Pyproject:  # pylint: disable=too-many-public-methods
+    FILENAME: str = "pyproject.toml"
+
+    def __init__(self, coder: Dict[str, Any]):
+        self.__coder: Dict[str, Any] = coder
+
+    @property
+    def coder(self) -> Dict[str, Any]:
+        return self.__coder
+
+    @property
+    def project(self) -> Dict[str, Any]:
+        return self.coder["project"]
+
+    @property
+    def project_authors(self) -> List[Dict[str, str]]:
+        return self.project["authors"]
+
+    @property
+    def project_keywords(self) -> List[str]:
+        return self.project["keywords"]
+
+    @property
+    def project_scripts(self) -> Dict[str, Any]:
+        return self.project["scripts"]
+
+    @property
+    def project_urls(self) -> Dict[str, str]:
+        return self.project["urls"]
+
+    @property
+    def tool(self) -> Dict[str, Any]:
+        return self.coder["tool"]
+
+    @property
+    def tool_hatch(self) -> Dict[str, Any]:
+        return self.tool["hatch"]
+
+    @property
+    def tool_hatch_build(self) -> Dict[str, Any]:
+        return self.tool_hatch["build"]
+
+    @property
+    def tool_hatch_build_targets(self) -> Dict[str, Any]:
+        return self.tool_hatch_build["targets"]
+
+    @property
+    def tool_hatch_build_targets_sdist(self) -> Dict[str, Any]:
+        return self.tool_hatch_build_targets["sdist"]
+
+    @property
+    def tool_hatch_build_targets_sdist_force_include(self) -> Dict[str, Any]:
+        return self.tool_hatch_build_targets_sdist["force-include"]
+
+    @property
+    def tool_hatch_build_targets_sdist_exclude(self) -> List[str]:
+        return self.tool_hatch_build_targets_sdist["exclude"]
+
+    @property
+    def tool_hatch_build_targets_sdist_packages(self) -> List[str]:
+        return self.tool_hatch_build_targets_sdist["packages"]
+
+    @property
+    def tool_hatch_build_targets_wheel(self) -> Dict[str, Any]:
+        return self.tool_hatch_build_targets["wheel"]
+
+    @property
+    def tool_hatch_build_targets_wheel_force_include(self) -> Dict[str, Any]:
+        return self.tool_hatch_build_targets_wheel["force-include"]
+
+    @property
+    def tool_hatch_build_targets_wheel_exclude(self) -> List[str]:
+        return self.tool_hatch_build_targets_wheel["exclude"]
+
+    @property
+    def tool_hatch_build_targets_wheel_packages(self) -> List[str]:
+        return self.tool_hatch_build_targets_wheel["packages"]
+
+    @property
+    def tool_hatch_metadata(self) -> Dict[str, Any]:
+        return self.tool_hatch["metadata"]
+
+    @property
+    def tool_hatch_metadata_hooks(self) -> Dict[str, Any]:
+        return self.tool_hatch_metadata["hooks"]
+
+    @property
+    def tool_hatch_metadata_hooks_requirements_txt(self) -> Dict[str, Any]:
+        return self.tool_hatch_metadata_hooks["requirements_txt"]
+
+    @property
+    def tool_hatch_metadata_hooks_requirements_txt_files(self) -> List[str]:
+        return self.tool_hatch_metadata_hooks_requirements_txt["files"]
+
+    @property
+    def tool_hatch_version(self) -> List[str]:
+        return self.tool_hatch["version"]
+
+    def dump(self, filepath: Union[str, Path], writable: bool = False):
+        if isinstance(filepath, str):
+            filepath = Path(filepath)  # pragma: no cover
+
+        if not filepath.exists() or writable:
+            with filepath.open("w", encoding="utf-8") as whdl:
+                dump(self.coder, whdl)
+
+    @classmethod
+    def load(cls, filepath: Union[str, Path]) -> "Pyproject":
+        if isinstance(filepath, str):
+            filepath = Path(filepath)  # pragma: no cover
+
+        with filepath.open("r", encoding="utf-8") as rhdl:
+            return cls(coder=load(rhdl))
+
+
+class Requirements:
+    """Requirements
+
+    Reference:
+        - [PEP 508](https://peps.python.org/pep-0508/)
+            Dependency specification for Python Software Packages
+    """
+    FILENAME: str = "requirements.txt"
+
+    def __init__(self, *requirements: Union[str, Requirement]):
+        self.__requirements: List[Requirement] = [self.normalize(requirement) for requirement in requirements]  # noqa:E501
+
+    def __iter__(self) -> Iterator[Requirement]:
+        yield from self.__requirements
+
+    def add(self, requirement: Union[str, Requirement]) -> None:
+        self.__requirements.append(self.normalize(requirement))
+
+    def dumps(self) -> str:
+        return "\n".join(str(requirement) for requirement in self.__requirements)  # noqa:E501
+
+    def dumpf(self, filepath: Union[str, Path], writable: bool = False) -> None:  # noqa:E501
+        if isinstance(filepath, str):
+            filepath = Path(filepath)  # pragma: no cover
+
+        if not filepath.exists() or writable:
+            with filepath.open("w", encoding="utf-8") as whdl:
+                whdl.write(self.dumps())
+                whdl.write("\n")
+
+    @classmethod
+    def normalize(cls, requirement: Union[str, Requirement]) -> Requirement:  # noqa:E501
+        """Normalized Names with PEP 503
+
+        Reference:
+            - https://peps.python.org/pep-0426/#name
+            - https://peps.python.org/pep-0503/#normalized-names
+        """
+        from re import sub  # pylint: disable=import-outside-toplevel
+
+        if not isinstance(requirement, Requirement):
+            requirement = Requirement(requirement)
+
+        requirement.name = sub(r"[-_.]+", "-", requirement.name).lower()
+        return requirement

xproject_python-0.1.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: xproject-python
+Version: 0.1
+Summary: Initialize project files
+Project-URL: Homepage, https://github.com/bondbox/xproject/
+Author-email: Mingzhe Zou <zoumingzhe@outlook.com>
+License-File: LICENSE
+Keywords: project
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: xkits-command>=0.6
+Requires-Dist: xkits-config-toml>=0.7
+Requires-Dist: xkits-file>=0.10
+Description-Content-Type: text/markdown
+
+# xproject
+
+> Initialize project files

xproject_python-0.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+xproject_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xproject_python/attribute.py,sha256=oRA_N6VH3likW_L9EmrW6NRMHIq91csfhOpJRXWpQm0,186
+xproject_python/configure.py,sha256=5MB5F-uiP0iDpvV6nmYIBWQgdu_h8tOt6gGPHOwGQCs,5376
+xproject_python/projector.py,sha256=SmOjjzvjUqIQZp6K9O7gQQkFzoU864PlPD-40oraZis,14643
+xproject_python/utilities.py,sha256=AHCJIOqDQ5R8eimhDs-zXvzjrTRVs_YoCK37UUrjViQ,6649
+xproject_python/templates/module/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xproject_python/templates/module/attribute.py,sha256=7dhF1l7pV9x5uQVZUE4-yxGRa5xbktybg3NEp1W75s8,181
+xproject_python/templates/package/.coveragerc,sha256=IywRebZYYu_hhx84NMb61-PwbODbl_sQAzIsbMQAbso,173
+xproject_python/templates/package/.flake8,sha256=88RBDY1kVe7Zp49xNdRnZ9zO-UlTq8-_oj91r92BAvs,138
+xproject_python/templates/package/.pylintrc,sha256=2g6-1ka_eOEiEIyo71JetDtijVv1tOiFaiCBgeu3CuY,197
+xproject_python/templates/package/Makefile,sha256=vwdOrGKPRkGwux9lep73Y-R4-V7KbPHuJfXUT6CW_xs,1437
+xproject_python/templates/package/hatch_build.py,sha256=Y1JZyIq_Kel6O2bLUgNLhHYGzp55AuvkLEa60pfjYI0,228
+xproject_python/templates/package/pyproject.toml,sha256=sE0KwjM6eCvGfaaBtQufW00wlDhoPY5ThZ4qfbzoQM8,798
+xproject_python/templates/project/readme.md,sha256=WM6Vxsbw4V8OL-HcYIsyVf9Q-6m_YEt0n5LHgXyJRPM,42
+xproject_python-0.1.dist-info/METADATA,sha256=mFfR429wpyhydQBKaW9H1sRNz0REnqWW-rhRJEOPuFM,540
+xproject_python-0.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+xproject_python-0.1.dist-info/entry_points.txt,sha256=Xo8CIP0Za9cxneK7BvtZ3fdZkpNlEikctcUscCVdQ-0,132
+xproject_python-0.1.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+xproject_python-0.1.dist-info/RECORD,,

xproject_python-0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

xproject_python-0.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+xproject-python-config = xproject_python.configure:main
+xproject-python-generate = xproject_python.projector:main

xproject_python-0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, 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 or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+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 give any other recipients of the Program a copy of this License
+along with the Program.
+
+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 Program or any portion
+of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+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 Program, 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 Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) 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; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, 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 executable.  However, as a
+special exception, the source code 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.
+
+If distribution of executable or 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 counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program 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.
+
+  5. 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 Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program 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 to
+this License.
+
+  7. 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 Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program 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 Program.
+
+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.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program 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.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the 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 Program
+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 Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, 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
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.