pyportion 0.0.1__tar.gz

pyportion-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Portion
+
+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.

pyportion-0.0.1/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: pyportion
+Version: 0.0.1
+Summary: Python CLI to manage your projects
+Home-page: https://github.com/murtadapy/
+Author: Murtada Altarouti
+Author-email: murtada.altarouti@gmail.com
+License: MIT
+Project-URL: Bug Tracker, https://github.com/pyportion/pyportion/issues
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# PyPortion
+
+PyPortion CLI helps you kickstart new projects and manage existing ones with ease. It streamlines project setup, enforces a clean and scalable structure, and lets you focus on delivering high-quality applications
+
+## Features
+* 🚀 Quick start – Scaffold new projects in seconds
+* 🛠️ Project management – Easily maintain and organize existing projects
+* 📦 Scalable structure – Enforces a clean, maintainable architecture
+* 🔄 Consistency – Keeps your project structure up to standard
+
+
+## Get started
+
+### Install pyportion
+```bash
+pip install pyportion
+```

pyportion-0.0.1/README.md

@@ -0,0 +1,17 @@
+# PyPortion
+
+PyPortion CLI helps you kickstart new projects and manage existing ones with ease. It streamlines project setup, enforces a clean and scalable structure, and lets you focus on delivering high-quality applications
+
+## Features
+* 🚀 Quick start – Scaffold new projects in seconds
+* 🛠️ Project management – Easily maintain and organize existing projects
+* 📦 Scalable structure – Enforces a clean, maintainable architecture
+* 🔄 Consistency – Keeps your project structure up to standard
+
+
+## Get started
+
+### Install pyportion
+```bash
+pip install pyportion
+```

pyportion-0.0.1/portion/__main__.py

@@ -0,0 +1,4 @@
+from portion.portion import Portion
+
+if __name__ == "__main__":
+    Portion().run()

pyportion-0.0.1/portion/base/__init__.py

@@ -0,0 +1,6 @@
+from .command import CommandBase
+
+
+__all__ = [
+    "CommandBase",
+]

pyportion-0.0.1/portion/base/command.py

@@ -0,0 +1,13 @@
+from abc import ABC
+from abc import abstractmethod
+
+from portion.core import Logger
+
+
+class CommandBase(ABC):
+    def __init__(self, logger: Logger, **kwargs: dict) -> None:
+        self.logger = logger
+
+    @abstractmethod
+    def execute(self) -> None:
+        raise NotImplementedError()

pyportion-0.0.1/portion/commands/__init__.py

@@ -0,0 +1,14 @@
+from typing import Dict
+
+from portion.base import CommandBase
+from .add import AddCommand
+from .new import NewCommand
+from .template import TemplateCommand
+
+
+def get_commands() -> Dict[str, type[CommandBase]]:
+    return {
+        "new": NewCommand,
+        "add": AddCommand,
+        "template": TemplateCommand,
+    }

pyportion-0.0.1/portion/commands/add.py

@@ -0,0 +1,11 @@
+from portion.base import CommandBase
+from portion.core.logger import Logger
+
+
+class AddCommand(CommandBase):
+    def __init__(self, logger: Logger) -> None:
+        super().__init__(logger=logger)
+
+    def execute(self) -> None:
+        self.logger.pulse("Executing add command")
+        self.logger.info("Done")

pyportion-0.0.1/portion/commands/new.py

@@ -0,0 +1,31 @@
+import os
+
+from portion.base import CommandBase
+from portion.core.logger import Logger
+
+
+class NewCommand(CommandBase):
+    def __init__(self,
+                 name: str,
+                 template: str,
+                 logger: Logger) -> None:
+        super().__init__(logger=logger)
+        self.name = name
+        self.template = template
+
+    def is_project_exist(self) -> bool:
+        return os.path.exists(self.name)
+
+    def create_project(self) -> None:
+        os.mkdir(self.name)
+
+    def execute(self) -> None:
+        self.logger.pulse("Executing create command")
+        if self.is_project_exist():
+            self.logger.error("The project is already exist")
+            return None
+
+        self.create_project()
+        self.logger.pulse("Created the project folder")
+
+        self.logger.info(f"{self.name} project has been created successfully")

pyportion-0.0.1/portion/commands/template.py

@@ -0,0 +1,41 @@
+import os
+
+from platformdirs import user_data_dir
+from git import Repo
+
+from portion.base import CommandBase
+from portion.core.logger import Logger
+
+
+class TemplateCommand(CommandBase):
+    def __init__(self,
+                 template_command: str,
+                 logger: Logger,
+                 link: str | None = None) -> None:
+        super().__init__(logger=logger)
+        self.template_command = template_command
+        self.link = link
+
+        self._pyportion_path = os.path.join(user_data_dir(), "pyportion")
+
+    def create_pyportion_dir(self) -> None:
+        if not os.path.exists(self._pyportion_path):
+            os.mkdir(self._pyportion_path)
+
+    def download_command(self) -> None:
+        if not self.link:
+            raise ValueError("The given link is not valid")
+
+        repo_name = self.link.split("/")[-1]
+        repo_path = os.path.join(self._pyportion_path, repo_name)
+        Repo.clone_from(self.link, repo_path)
+
+    def execute(self) -> None:
+        self.logger.pulse("Executing template command")
+
+        self.create_pyportion_dir()
+
+        if self.template_command == "download":
+            self.download_command()
+
+        self.logger.info("Done")

pyportion-0.0.1/portion/core/__init__.py

@@ -0,0 +1,8 @@
+from .logger import Logger
+from .parser import Parser
+
+
+__all__ = [
+    "Logger",
+    "Parser",
+]

pyportion-0.0.1/portion/core/logger.py

@@ -0,0 +1,27 @@
+import time
+import logging
+
+
+logging.basicConfig(level=logging.INFO, format="%(message)s")
+
+
+class Logger:
+    def __init__(self, quiet: bool, verbose: bool) -> None:
+        self.quiet = quiet
+        self.verbose = verbose
+        self._start_time = time.monotonic()
+        self._end_time = time.monotonic()
+
+    def pulse(self, message: str) -> None:
+        if not self.quiet and self.verbose:
+            self._end_time = time.monotonic()
+            taken_time = self._end_time - self._start_time
+            logging.info(f"[Time Taken: {taken_time:.2f}s] {message}")
+
+    def error(self, message: str) -> None:
+        if not self.quiet:
+            logging.info("Error: " + message)
+
+    def info(self, message: str) -> None:
+        if not self.quiet:
+            logging.info(message)

pyportion-0.0.1/portion/core/parser.py

@@ -0,0 +1,65 @@
+import argparse
+from argparse import ArgumentParser
+from argparse import _SubParsersAction
+from argparse import Namespace
+
+
+class Parser:
+    def __init__(self) -> None:
+        self.parser = argparse.ArgumentParser(description="Portion")
+
+    def _add_generic_arguments(self,
+                               suparser: argparse.ArgumentParser) -> None:
+        suparser.add_argument("-q",
+                              default=False,
+                              help="Suppress Logging",
+                              action="store_true")
+
+        suparser.add_argument("-v",
+                              default=False,
+                              help="Verbose Logging",
+                              action="store_true")
+
+    def _new_arguments(self, parser: _SubParsersAction) -> ArgumentParser:
+        new: ArgumentParser = parser.add_parser("new",
+                                                help="Create a new project")
+        new.add_argument("name")
+        new.add_argument("-t", "--template", required=True)
+        return new
+
+    def _add_arguments(self, parser: _SubParsersAction) -> ArgumentParser:
+        add = parser.add_parser("add", help="Add a portion")
+        return add
+
+    def _template_arguments(self, parser: _SubParsersAction) -> ArgumentParser:
+        template: ArgumentParser = parser.add_parser("template",
+                                                     help="Manage templates")
+        template_subparser = template.add_subparsers(
+            dest="template_command",
+            help="Allows you to manage templates")
+
+        download_parser = template_subparser.add_parser(
+            "download", help="Download a template")
+
+        download_parser.add_argument("link")
+
+        # list_parser = template_subparser.add_parser(
+        #     "list", help="List all templates")
+
+        # remove_parser = template_subparser.add_parser(
+        #     "remove", help="Remove a template")
+
+        return template
+
+    def parse(self) -> Namespace:
+        subparser = self.parser.add_subparsers(dest="command", required=True)
+        argument_parsers = [
+            self._new_arguments(subparser),
+            self._template_arguments(subparser),
+            # self._add_arguments(subparser),
+        ]
+
+        for argument_parser in argument_parsers:
+            self._add_generic_arguments(argument_parser)
+
+        return self.parser.parse_args()

pyportion-0.0.1/portion/portion.py

@@ -0,0 +1,21 @@
+from portion.core import Parser
+from portion.core import Logger
+from portion.commands import get_commands
+
+
+class Portion:
+    def __init__(self) -> None:
+        parser = Parser()
+        self.args = parser.parse()
+        self.commands = get_commands()
+        self.logger = Logger(self.args.q, self.args.v)
+
+    def _run_command(self) -> None:
+        command = self.commands.get(self.args.command, None)
+        if command:
+            params = command.__init__.__code__.co_varnames[1:]
+            kwargs = {k: v for k, v in vars(self.args).items() if k in params}
+            command(logger=self.logger, **kwargs).execute()
+
+    def run(self) -> None:
+        self._run_command()

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

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: pyportion
+Version: 0.0.1
+Summary: Python CLI to manage your projects
+Home-page: https://github.com/murtadapy/
+Author: Murtada Altarouti
+Author-email: murtada.altarouti@gmail.com
+License: MIT
+Project-URL: Bug Tracker, https://github.com/pyportion/pyportion/issues
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# PyPortion
+
+PyPortion CLI helps you kickstart new projects and manage existing ones with ease. It streamlines project setup, enforces a clean and scalable structure, and lets you focus on delivering high-quality applications
+
+## Features
+* 🚀 Quick start – Scaffold new projects in seconds
+* 🛠️ Project management – Easily maintain and organize existing projects
+* 📦 Scalable structure – Enforces a clean, maintainable architecture
+* 🔄 Consistency – Keeps your project structure up to standard
+
+
+## Get started
+
+### Install pyportion
+```bash
+pip install pyportion
+```

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

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+portion/__init__.py
+portion/__main__.py
+portion/portion.py
+portion/base/__init__.py
+portion/base/command.py
+portion/commands/__init__.py
+portion/commands/add.py
+portion/commands/new.py
+portion/commands/template.py
+portion/core/__init__.py
+portion/core/logger.py
+portion/core/parser.py
+pyportion.egg-info/PKG-INFO
+pyportion.egg-info/SOURCES.txt
+pyportion.egg-info/dependency_links.txt
+pyportion.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+portion

pyportion-0.0.1/setup.cfg

@@ -0,0 +1,21 @@
+[metadata]
+name = pyportion
+version = 0.0.1
+author = Murtada Altarouti
+author_email = murtada.altarouti@gmail.com
+url = https://github.com/murtadapy/
+description = Python CLI to manage your projects
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT
+project_urls = 
+	Bug Tracker = https://github.com/pyportion/pyportion/issues
+python_requires = >= 3.8
+install_requires = 
+	gitpython==3.1.45
+	platformdirs==4.4.0
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyportion-0.0.1/setup.py

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