xproject-python 0.1__tar.gz

xproject_python-0.1/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.stestr
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

xproject_python-0.1/LICENSE

@@ -0,0 +1 @@
+../LICENSE

xproject_python-0.1/PKG-INFO

@@ -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/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = [ "hatch-requirements-txt", "hatchling", "xpip-build>=1.4",]
+
+[project]
+classifiers = [ "Programming Language :: Python", "Programming Language :: Python :: 3",]
+description = "Initialize project files"
+dynamic = [ "dependencies", "version",]
+keywords = [ "project",]
+license-files = [ "LICENSE",]
+name = "xproject-python"
+requires-python = ">=3.8"
+[[project.authors]]
+name = "Mingzhe Zou"
+email = "zoumingzhe@outlook.com"
+
+[project.readme]
+content-type = "text/markdown"
+file = "readme.md"
+
+[project.scripts]
+xproject-python-generate = "xproject_python.projector:main"
+xproject-python-config = "xproject_python.configure:main"
+
+[project.urls]
+Homepage = "https://github.com/bondbox/xproject/"
+
+[tool.hatch.version]
+path = "xproject_python/attribute.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = [ "xproject_python/unittest",]
+packages = [ "xproject_python",]
+
+[tool.hatch.build.targets.wheel]
+exclude = [ "xproject_python/unittest",]
+packages = [ "xproject_python",]
+
+[tool.hatch.metadata.hooks.requirements_txt]
+files = [ "requirements.txt",]
+
+[tool.hatch.build.targets.sdist.force-include]
+templates = "xproject_python/templates"
+
+[tool.hatch.build.targets.wheel.force-include]
+templates = "xproject_python/templates"

xproject_python-0.1/readme.md

@@ -0,0 +1 @@
+../readme.md

xproject_python-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/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-0.1/xproject_python/templates/project/readme.md

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

xproject_python-0.1/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