quickpub 0.0.1__tar.gz

quickpub-0.0.1/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: quickpub
+Version: 0.0.1
+Summary: A python package to quickly configure and publish a new package
+Author-email: danielnachumdev <danielnachumdev@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 danielnachumdev
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/danielnachumdev/quickpub
+Project-URL: Bug Tracker, https://github.com/danielnachumdev/quickpub/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10.13
+Description-Content-Type: text/markdown
+
+# quickpub

quickpub-0.0.1/README.md

@@ -0,0 +1 @@
+# quickpub

quickpub-0.0.1/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quickpub"
+version = "0.0.1"
+authors = [
+    { name = "danielnachumdev", email = "danielnachumdev@gmail.com" },
+]
+dependencies = ['twine', 'danielutils']
+keywords = []
+license = { "file" = "LISENCE" }
+description = "A python package to quickly configure and publish a new package"
+readme = "README.md"
+requires-python = ">=3.10.13"
+classifiers = [
+	"Development Status :: 3 - Alpha",
+	"Intended Audience :: Developers",
+	"Programming Language :: Python :: 3",
+	"Operating System :: Microsoft :: Windows"
+]
+
+[tool.setuptools]
+packages = ["quickpub"]
+
+[project.urls]
+"Homepage" = "https://github.com/danielnachumdev/quickpub"
+"Bug Tracker" = "https://github.com/danielnachumdev/quickpub/issues"

quickpub-0.0.1/quickpub/__init__.py

@@ -0,0 +1,2 @@
+from .__main__ import publish
+from .structures import *

quickpub-0.0.1/quickpub/__main__.py

@@ -0,0 +1,67 @@
+from typing import Optional, Union
+from danielutils import get_python_version
+from .publish import build, upload, commit, metrics
+from .structures import Version, Config
+from .files import create_toml, create_setup
+from .classifiers import *
+
+
+def publish(
+        *,
+        name: str,
+        version: Optional[Union[Version, str]] = None,
+        author: str,
+        author_email: str,
+        description: str,
+        homepage: str,
+
+        min_python: Optional[Union[Version, str]] = None,
+
+        keywords: Optional[list[str]] = None,
+        dependencies: Optional[list[str]] = None,
+        config: Optional[Config] = None
+) -> None:
+    if version is None:
+        version: Version = None  # type: ignore
+    else:
+        version: Version = version if isinstance(version, Version) else Version.from_str(version)  # type: ignore
+
+    if min_python is None:
+        min_python = Version(*get_python_version())
+    if keywords is None:
+        keywords = []
+
+    if dependencies is None:
+        dependencies = []
+
+    create_setup()
+    create_toml(
+        name=name,
+        version=version,
+        author=author,
+        author_email=author_email,
+        description=description,
+        homepage=homepage,
+        keywords=keywords,
+        dependencies=dependencies,
+        classifiers=[
+            DevelopmentStatusClassifier.Alpha,
+            IntendedAudienceClassifier.Developers,
+            ProgrammingLanguageClassifier.Python3,
+            OperatingSystemClassifier.MicrosoftWindows
+        ],
+        min_python=min_python
+    )
+
+    build()
+    upload(
+        name=name,
+        version=version
+    )
+    commit(
+        version=version
+    )
+    metrics()
+
+# if __name__ == '__main__':
+#     publish()

quickpub-0.0.1/quickpub/classifiers.py

@@ -0,0 +1,72 @@
+from abc import ABC, abstractmethod
+from enum import Enum
+
+
+class Classifier(Enum):
+    def _str(self) -> str:
+        return str(self.value)
+
+    @staticmethod
+    def _split_name(name: str) -> str:
+        words = []
+        current_word = ''
+
+        for char in name:
+            # Check if the character is uppercase
+            if char.isupper():
+                # If current_word is not empty, add it to words list
+                if current_word:
+                    words.append(current_word)
+                # Start a new word with the uppercase character
+                current_word = char
+            else:
+                # Add lowercase character to current_word
+                current_word += char
+
+        # Add the last word to the list
+        if current_word:
+            words.append(current_word)
+
+        return " ".join(words[:-1])
+
+    def __str__(self) -> str:
+        name = Classifier._split_name(self.__class__.__qualname__)
+        value = self._str()
+        return f"{name} :: {value}"
+
+
+class DevelopmentStatusClassifier(Classifier):
+    # https://pypi.org/classifiers/
+    Planning = 1
+    PreAlpha = 2
+    Alpha = 3
+    Beta = 4
+    Production = 5
+    Stable = 5
+    Mature = 6
+    Inactive = 7
+
+    def _str(self) -> str:
+        return f"{self.value} - {self.name}"
+
+
+class IntendedAudienceClassifier(Classifier):
+    CustomerService = "CustomerService"
+    Developers = "Developers"
+
+
+class ProgrammingLanguageClassifier(Classifier):
+    Python3 = "Python :: 3"
+
+
+class OperatingSystemClassifier(Classifier):
+    MicrosoftWindows = "Microsoft :: Windows"
+
+
+__all__ = [
+    "Classifier",
+    "DevelopmentStatusClassifier",
+    "IntendedAudienceClassifier",
+    "ProgrammingLanguageClassifier",
+    "OperatingSystemClassifier"
+]

quickpub-0.0.1/quickpub/files.py

@@ -0,0 +1,60 @@
+from typing import Optional
+
+from .classifiers import Classifier
+from .structures import Version
+
+
+def create_toml(
+        *,
+        name: str,
+        version: Version,
+        author: str,
+        author_email: str,
+        description: str,
+        homepage: str,
+        keywords: list[str],
+        min_python: Version,
+        dependencies: list[str],
+        classifiers: list[Classifier]
+) -> None:
+    classifiers_string = ",\n\t".join([f"\"{str(c)}\"" for c in classifiers])
+    if len(classifiers_string) > 0:
+        classifiers_string = f"\n\t{classifiers_string}\n"
+    s = f"""[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{name}"
+version = "{version}"
+authors = [
+    {{ name = "{author}", email = "{author_email}" }},
+]
+dependencies = {dependencies}
+keywords = {keywords}
+license = {{ "file" = "LISENCE" }}
+description = "{description}"
+readme = "README.md"
+requires-python = ">={min_python}"
+classifiers = [{classifiers_string}]
+
+[tool.setuptools]
+packages = ["{name}"]
+
+[project.urls]
+"Homepage" = "{homepage}"
+"Bug Tracker" = "{homepage}/issues"
+"""
+    with open("pyproject.toml", "w", encoding="utf8") as f:
+        f.write(s)
+
+
+def create_setup() -> None:
+    with open("./setup.py", "w", encoding="utf8") as f:
+        f.write("from setuptools import setup\n\nsetup()\n")
+
+
+__all__ = [
+    "create_setup",
+    "create_toml"
+]

quickpub-0.0.1/quickpub/publish.py

@@ -0,0 +1,195 @@
+from danielutils import cm, info, error
+
+from .structures import Version
+
+
+def prev_main():
+    import re
+    from danielutils import cmrt, cm, read_file, get_files, directory_exists, create_directory  # type:ignore
+
+    NAME = "danielutils"
+
+    VERSION_PATTERN = r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
+    SETUP = "./setup.py"
+    TOML = "./pyproject.toml"
+    README = "./README.md"
+    DIST = "./dist"
+    REPORTS = "./reports"
+
+    def get_latest(ver: str = '0.0.0') -> str:
+        """returns the latest version currently in the DIST fuller
+
+        Args:
+            version (str, optional): the version to compare against. Defaults to '0.0.0'.
+
+        Returns:
+            str: the biggest version number
+        """
+        if not directory_exists(DIST):
+            return ver
+        DIST_PATTERN = NAME + r"-(\d+)\.(\d+)\.(\d+)\.tar\.gz"
+        best = ver
+        for filename in get_files(DIST):
+            a1, b1, c1 = best.split(".")
+            match = re.match(DIST_PATTERN, filename)
+            if match:
+                a2, b2, c2 = match.groups()
+                other_version = f"{a2}.{b2}.{c2}"
+                if int(a2) > int(a1):
+                    best = other_version
+                elif int(a2) == int(a1):
+                    if int(b2) > int(b1):
+                        best = other_version
+                    elif int(b2) == int(b1):
+                        if int(c2) > int(c1):
+                            best = other_version
+        return best
+
+    def main(ver: str):
+        """main function, create a new release and update the files and call terminal to upload the release
+
+        Args:
+            version (str): the new version
+        """
+
+        latest = get_latest(ver)
+        if latest != ver:
+            print(f"{ver} is not the latest version, found {latest}, cancelling...")
+            exit()
+        print("Creating new distribution...")
+        ret, stdout, stderr = cm("python", "setup.py", "sdist")
+        if ret != 0:
+            print(stderr)
+            exit()
+        print("Created dist successfully")
+        ret, stdout, stderr = cm("wt.exe",
+                                 "twine", "upload", "--config-file", ".pypirc", f"dist/{NAME}-{ver}.tar.gz")
+
+    def pytest() -> bool:
+        """run pytest
+
+        Returns:
+            bool: success status
+        """
+
+        def has_fails(pytest_out: str) -> bool:
+            RE = r'=+ (?:(?P<FAIL>\d+ failed), )?(?P<PASS>\d+ passed) in [\d\.]+s =+'
+            if not re.match(RE, pytest_out):
+                print("Failed to match pytest output")
+                return True
+
+            res = re.findall(RE, pytest_out)[0]
+            failed = int(res[0].split()[0]) if res[0] != "" else 0
+            return failed > 0
+
+        COMMAND = "pytest"
+        if input("Do you want to generate a report as well? <y|n>: ") == "y":
+            COMMAND += " --html=pytest_report.html"
+        COMMAND += f" > {REPORTS}/pytest.txt"
+        print("running pytest")
+        code, stdout, stderr = cm(COMMAND)
+        if code != 0:
+            err = stderr.decode()
+            if err != "":
+                print(err)
+                return False
+        with open(f"{REPORTS}/pytest.txt", "r", encoding="utf8") as f:
+            summary = f.readlines()[-1]
+        if has_fails(summary):
+            print(summary)
+            return False
+        return True
+
+    def pylint(config_file_path: str = "./.pylintrc") -> None:
+        """run pylint
+        """
+        print("running pylint...")
+        for i, line in cmrt("pylint", "--rcfile", config_file_path,
+                            f"./{NAME}", ">", f"{REPORTS}/pylint.txt"):
+            print(line.decode(), end="")
+
+    def git(ver: str) -> None:
+        """will add recent changes and automatically commit to git after the publication
+        """
+
+    def mypy(config_file_path: str = "mypy.ini") -> None:
+        """run mypy
+        """
+        print("running mypy")
+        with open(f"{REPORTS}/mypy.txt", "w", encoding="utf8") as f:
+            for i, line in cmrt("mypy", "--config-file", config_file_path,
+                                f"./{NAME}"):
+                f.write(line.decode())
+                print(line.decode(), end="")
+
+    if __name__ == "__main__":
+        if not directory_exists(REPORTS):
+            create_directory(REPORTS)
+        has_passed_tests = pytest()
+        if True:
+            print("Passed all tests!")
+            pylint()
+            mypy()
+            version = input(
+                f"Please supply a new version number (LATEST = {get_latest()}): ")
+            if re.match(VERSION_PATTERN, version):
+                main(version)
+                git(version)
+                print("DONE")
+            else:
+                print("invalid version. example 1.0.5.20")
+
+
+def build(
+        *,
+        verbose: bool = True
+) -> None:
+    if verbose:
+        info("Creating new distribution...")
+    ret, stdout, stderr = cm("python", "setup.py", "sdist")
+    if ret != 0:
+        error(stderr.decode(encoding="utf8"))
+        exit(1)
+
+
+def upload(
+        *,
+        name: str,
+        version: Version,
+        verbose: bool = True
+) -> None:
+    if verbose:
+        info("Uploading")
+    ret, stdout, stderr = cm("wt.exe", "twine", "upload", "--config-file", ".pypirc", f"dist/{name}-{version}.tar.gz")
+    if ret != 0:
+        error(stderr.decode(encoding="utf8"))
+        exit(1)
+
+
+def commit(
+        *,
+        version: Version,
+        verbose: bool = True
+) -> None:
+    if verbose:
+        info("Git")
+        info("\tStaging")
+    cm("git add .")
+    if verbose:
+        info("\tCommitting")
+    cm(f"git commit -m \"updated to version {version}\"")
+    if verbose:
+        info("\tPushing")
+    cm("git push")
+
+
+def metrics():
+    pass
+
+
+__all__ = [
+    "build",
+    "upload",
+    "commit",
+    "metrics"
+]

quickpub-0.0.1/quickpub/structures.py

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Version:
+    @staticmethod
+    def from_str(version_str: str) -> "Version":
+        return Version(*list(map(int, version_str.split("."))))
+
+    major: int = 0
+    minor: int = 0
+    patch: int = 0
+
+    def __str__(self) -> str:
+        return f"{self.major}.{self.minor}.{self.patch}"
+
+
+@dataclass
+class Config:
+    pylint: bool = False
+    mypy: bool = False
+
+
+
+__all__ = [
+    "Version",
+    "Config",
+]

quickpub-0.0.1/quickpub.egg-info/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.1
+Name: quickpub
+Version: 0.0.1
+Summary: A python package to quickly configure and publish a new package
+Author-email: danielnachumdev <danielnachumdev@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 danielnachumdev
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/danielnachumdev/quickpub
+Project-URL: Bug Tracker, https://github.com/danielnachumdev/quickpub/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10.13
+Description-Content-Type: text/markdown
+
+# quickpub

quickpub-0.0.1/quickpub.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+setup.py
+quickpub/__init__.py
+quickpub/__main__.py
+quickpub/classifiers.py
+quickpub/files.py
+quickpub/publish.py
+quickpub/structures.py
+quickpub.egg-info/PKG-INFO
+quickpub.egg-info/SOURCES.txt
+quickpub.egg-info/dependency_links.txt
+quickpub.egg-info/requires.txt
+quickpub.egg-info/top_level.txt

quickpub-0.0.1/quickpub.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

quickpub-0.0.1/quickpub.egg-info/requires.txt

@@ -0,0 +1,2 @@
+twine
+danielutils

quickpub-0.0.1/quickpub.egg-info/top_level.txt

@@ -0,0 +1 @@
+quickpub

quickpub-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

quickpub-0.0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()