validating 0.0.0__tar.gz

validating-0.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,38 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12.7"
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+      - name: Install yaml
+        run: python -m pip install pyyaml
+      - name: Install build
+        run: python -m pip install build
+      - name: Install twine
+        run: python -m pip install twine
+      - name: Install cfgtools
+        run: python -m pip install cfgtools
+      - name: Install re-extensions
+        run: python -m pip install re-extensions
+      - name: Build package
+        run: python install.py
+      - name: Publish package
+        run: twine upload dist/* --username __token__ --password ${{ secrets.PYPI_API_TOKEN }}

validating-0.0.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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/
+.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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/

validating-0.0.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Chitaoji
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

validating-0.0.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: validating
+Version: 0.0.0
+Summary: For test
+Project-URL: Documentation, https://github.com/Chitaoji/validating/blob/main/README.md
+Project-URL: Repository, https://github.com/Chitaoji/validating/
+Author-email: Chitaoji <2360742040@qq.com>
+Maintainer-email: Chitaoji <2360742040@qq.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: config
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# validating
+A template repository for building python packages.
+
+## Installation
+```sh
+$ pip install validating
+```
+
+## Requirements
+```txt
+
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validating/
+
+### PyPI project
+* https://pypi.org/project/validating/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.0.0
+* Initial release.

validating-0.0.0/README.md

@@ -0,0 +1,26 @@
+# validating
+A template repository for building python packages.
+
+## Installation
+```sh
+$ pip install validating
+```
+
+## Requirements
+```txt
+
+```
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validating/
+
+### PyPI project
+* https://pypi.org/project/validating/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+## History
+### v0.0.0
+* Initial release.

validating-0.0.0/install.py

@@ -0,0 +1,107 @@
+"""Install the package."""
+
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+import os
+import re
+from pathlib import Path
+from typing import Final
+
+import cfgtools as cfg
+from re_extensions import rsplit, word_wrap
+
+here = Path(__file__).parent
+
+# Load the package's meta-data from pyproject.toml.
+f = cfg.read_toml(here / "pyproject.toml")
+project = f["project"].asdict()
+NAME: Final[str] = project["name"]
+SUMMARY: Final[str] = project["description"]
+HOMEPAGE: Final[str] = project["urls"]["Repository"]
+REQUIRES: Final[list[str]] = project["dependencies"]
+SOURCE = "src"
+LICENSE = (here / project["license-files"][0]).read_text().partition("\n")[0]
+VERSION = project["version"]
+
+# Import the README and use it as the long-description.
+readme_path = here / project["readme"]
+if readme_path.exists():
+    long_description = "\n" + readme_path.read_text(encoding="utf-8")
+else:
+    long_description = SUMMARY
+
+
+def _readme2doc(
+    readme: str,
+    name: str = NAME,
+    requires: list[str] = REQUIRES,
+    homepage: str = HOMEPAGE,
+    pkg_license: str = LICENSE,
+) -> tuple[str, str]:
+    doc, rd = "", ""
+    for i, s in enumerate(rsplit("\n## ", readme)):
+        head = re.search(" .*\n", s).group()[1:-1]
+        if i == 0:
+            s = re.sub("^\n# .*", f"\n# {name}", s)
+        elif head == "Requirements":
+            s = re.sub(
+                "```txt.*```",
+                "```txt\n" + "\n".join(requires) + "\n```",
+                s,
+                flags=re.DOTALL,
+            )
+        elif head == "Installation":
+            s = re.sub(
+                "```sh.*```", f"```sh\n$ pip install {name}\n```", s, flags=re.DOTALL
+            )
+        elif head == "See Also":
+            pypipage = f"https://pypi.org/project/{name}/"
+            s = re.sub(
+                "### PyPI project\n.*",
+                f"### PyPI project\n* {pypipage}",
+                re.sub(
+                    "### Github repository\n.*",
+                    f"### Github repository\n* {homepage}",
+                    s,
+                ),
+            )
+        elif head == "License":
+            s = f"\n## License\nThis project falls under the {pkg_license}.\n"
+
+        rd += s
+        if head not in {"Installation", "Requirements", "History"}:
+            doc += s
+    doc = re.sub("<!--html-->.*<!--/html-->", "", doc, flags=re.DOTALL)
+    return word_wrap(doc, maximum=88) + "\n\n", rd
+
+
+def _quote(readme: str) -> str:
+    if "'''" in readme and '"""' in readme:
+        raise ReadmeFormatError("Both \"\"\" and ''' are found in the README")
+    if '"""' in readme:
+        return f"'''{readme}'''"
+    else:
+        return f'"""{readme}"""'
+
+
+def _version(version: str = VERSION) -> str:
+    return f'"""Version file."""\n\n__version__ = "{version}"\n'
+
+
+class ReadmeFormatError(Exception):
+    """Raised when the README has a wrong format."""
+
+
+if __name__ == "__main__":
+    # Import the __init__.py and change the module docstring.
+    init_path = here / SOURCE / NAME / "__init__.py"
+    version_path = here / SOURCE / NAME / "_version.py"
+    module_file = init_path.read_text(encoding="utf-8")
+    new_doc, long_description = _readme2doc(long_description)
+    module_file = re.sub(
+        "^\"\"\".*\"\"\"|^'''.*'''|^", _quote(new_doc), module_file, flags=re.DOTALL
+    )
+    init_path.write_text(module_file, encoding="utf-8")
+    readme_path.write_text(long_description.strip(), encoding="utf-8")
+    version_path.write_text(_version())
+    os.system(f"cd {here} && python -m build")

validating-0.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "validating"
+version = "0.0.0"
+dependencies = []
+requires-python = ">=3.12"
+authors = [
+  {name = "Chitaoji", email = "2360742040@qq.com"},
+]
+maintainers = [
+  {name = "Chitaoji", email = "2360742040@qq.com"}
+]
+description = "For test"
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+keywords = ["config"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12"
+]
+
+[project.urls]
+Documentation = "https://github.com/Chitaoji/validating/blob/main/README.md"
+Repository = "https://github.com/Chitaoji/validating/"
+
+[project.scripts]
+cfg = "template.__main__:run"

validating-0.0.0/src/validating/__init__.py

@@ -0,0 +1,22 @@
+"""
+# validating
+A template repository for building python packages.
+
+## See Also
+### Github repository
+* https://github.com/Chitaoji/validating/
+
+### PyPI project
+* https://pypi.org/project/validating/
+
+## License
+This project falls under the BSD 3-Clause License.
+
+"""
+
+from . import core
+from ._version import __version__
+from .core import *
+
+__all__: list[str] = []
+__all__.extend(core.__all__)

validating-0.0.0/src/validating/__main__.py

@@ -0,0 +1,14 @@
+"""
+Contains the cli api of template.
+
+NOTE: this module is private. All functions and objects are available in the main
+`template` namespace - use that instead.
+
+"""
+
+import click
+
+
+@click.command(context_settings={"help_option_names": ["-h", "--help"]})
+def run() -> None:
+    """Read and display a config file."""

validating-0.0.0/src/validating/_typing.py

@@ -0,0 +1,10 @@
+"""
+Contains typing classes.
+
+NOTE: this module is not intended to be imported at runtime.
+
+"""
+
+import loggings
+
+loggings.warning("this module is not intended to be imported at runtime")

validating-0.0.0/src/validating/_version.py

@@ -0,0 +1,3 @@
+"""Version file."""
+
+__version__ = "0.0.0"

validating-0.0.0/src/validating/core.py

@@ -0,0 +1,9 @@
+"""
+Contains the core of template: ... , etc.
+
+NOTE: this module is private. All functions and objects are available in the main
+`template` namespace - use that instead.
+
+"""
+
+__all__ = []