pypas-cli 0.0.2__tar.gz → 0.0.4__tar.gz

{pypas_cli-0.0.2 → pypas_cli-0.0.4}/.gitignore

@@ -2,3 +2,6 @@ dist
 *.egg-info
 *.pyc
 .python-version
+.DS_Store
+.env
+.sandbox

{pypas_cli-0.0.2 → pypas_cli-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pypas-cli
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python Practical Assignments
 Project-URL: homepage, https://pypas.es
 Project-URL: repository, https://github.com/sdelquin/pypas-cli
@@ -33,6 +33,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
+Requires-Dist: prettyconf
+Requires-Dist: pytest
+Requires-Dist: requests
+Requires-Dist: rich
 Requires-Dist: setuptools
 Requires-Dist: typer
 Description-Content-Type: text/markdown

{pypas_cli-0.0.2 → pypas_cli-0.0.4}/pyproject.toml

@@ -4,9 +4,16 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pypas-cli"
-version = "0.0.2"
+version = "0.0.4"
 license = { file = "LICENSE" }
-dependencies = ['setuptools', 'typer']
+dependencies = [
+    'setuptools',
+    'typer',
+    'prettyconf',
+    'requests',
+    'rich',
+    'pytest',
+]
 authors = [
     { email = "sdelquin@gmail.com" },
     { name = "Sergio Delgado Quintero" },

pypas_cli-0.0.4/src/pypas/__init__.py

@@ -0,0 +1,3 @@
+from .lib.console import console  # noqa
+from .lib import utils  # noqa
+from .lib.exercise import Exercise  # noqa

pypas_cli-0.0.4/src/pypas/lib/console.py

@@ -0,0 +1,14 @@
+from rich.console import Console
+from rich.theme import Theme
+
+custom_theme = Theme(
+    {
+        'info': 'cyan',
+        'warning': 'yellow',
+        'danger': 'bold red',
+        'success': 'bold green',
+        'note': 'bold blue',
+    }
+)
+
+console = Console(theme=custom_theme, highlight=False)

pypas_cli-0.0.4/src/pypas/lib/decorators.py

@@ -0,0 +1,15 @@
+import functools
+import os
+
+from .console import console
+
+
+def inside_exercise(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        if not os.path.exists('.pypas.toml'):
+            console.print('Current folder does not seem to be a pypas exercise!', style='danger')
+        else:
+            return func(*args, **kwargs)
+
+    return wrapper

pypas_cli-0.0.4/src/pypas/lib/exercise.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import os
+import zipfile
+from pathlib import Path
+from urllib.parse import urljoin
+
+import tomllib
+from pypas import settings
+
+from . import utils
+from .console import console
+
+
+class Exercise:
+    def __init__(self, exercise_slug: str):
+        self.slug = exercise_slug
+        self.url = urljoin(settings.PYPAS_EXERCISES_URLPATH, exercise_slug + '/')
+
+    @property
+    def zipname(self) -> str:
+        return f'{self.slug}.zip'
+
+    @property
+    def folder(self) -> Path:
+        return Path(self.slug)
+
+    @property
+    def cwd_folder(self) -> str:
+        return f'./{self.folder}'
+
+    @property
+    def config(self) -> dict:
+        if not getattr(self, '_cfg', None) or not self._cfg:  # type: ignore
+            self._cfg = Exercise.load_config()
+        return self._cfg
+
+    def folder_exists(self) -> bool:
+        return self.folder.exists()
+
+    def download(self) -> Path | None:
+        console.print(f'Getting exercise from: [italic]{self.url}')
+        if downloaded_zip := utils.download(self.url, self.zipname, save_temp=True):
+            self.downloaded_zip = downloaded_zip
+        return downloaded_zip
+
+    def unzip(self):
+        console.print('Inflating exercise bundle', end=' ')
+        with zipfile.ZipFile(self.downloaded_zip) as zip_ref:
+            zip_ref.extractall()
+        console.print('✔', style='success')
+        os.remove(self.downloaded_zip)
+
+    def open_docs(self):
+        os.system(f'{utils.get_open_cmd()} docs/README.pdf')
+
+    @classmethod
+    def from_config(cls) -> Exercise | None:
+        try:
+            return cls(Exercise.load_config()['slug'])
+        except KeyError:
+            console.print(
+                f'Config file {settings.EXERCISE_CONFIG_FILE} is corrupt!', style='danger'
+            )
+            return None
+
+    @staticmethod
+    def load_config(filename: str = settings.EXERCISE_CONFIG_FILE):
+        with open(filename, 'rb') as f:
+            return tomllib.load(f)

pypas_cli-0.0.4/src/pypas/lib/utils.py

@@ -0,0 +1,76 @@
+import tempfile
+from pathlib import Path
+from sys import platform
+
+import requests
+from rich.progress import (
+    BarColumn,
+    DownloadColumn,
+    Progress,
+    TextColumn,
+    TimeRemainingColumn,
+    TransferSpeedColumn,
+)
+
+from .console import console
+
+
+class OS:
+    LINUX = 1
+    MACOS = 2
+    WINDOWS = 3
+    OTHER = 4
+
+
+def download(url: str, filename: str, save_temp=False, chunk_size=1024) -> Path | None:
+    # https://gist.github.com/yanqd0/c13ed29e29432e3cf3e7c38467f42f51
+    if save_temp:
+        tmp_file = tempfile.NamedTemporaryFile(delete=False)
+        target_file = tmp_file.name
+    else:
+        target_file = filename
+    try:
+        resp = requests.get(url, stream=True)
+        resp.raise_for_status()
+    except Exception as err:
+        console.print(err, style='danger')
+        return None
+    with open(target_file, 'wb') as file, Progress(
+        TextColumn('[bold blue]{task.fields[filename]}'),
+        BarColumn(),
+        '[progress.percentage]{task.percentage:>3.1f}%',
+        '•',
+        DownloadColumn(),
+        '•',
+        TransferSpeedColumn(),
+        '•',
+        TimeRemainingColumn(),
+    ) as progress:
+        total = int(resp.headers.get('content-length', 0))
+        task_id = progress.add_task('download', filename=filename, total=total)
+        for data in resp.iter_content(chunk_size=chunk_size):
+            size = file.write(data)
+            progress.update(task_id, advance=size)
+    return Path(target_file)
+
+
+def check_os() -> int:
+    if platform.startswith('linux'):
+        return OS.LINUX
+    if platform == 'darwin':
+        return OS.MACOS
+    if platform == 'win32':
+        return OS.WINDOWS
+    return OS.OTHER
+
+
+def get_open_cmd() -> str:
+    match check_os():
+        case OS.LINUX:
+            return 'xdg-open'
+        case OS.MACOS:
+            return 'open'
+        case OS.WINDOWS:
+            return 'start'
+        case _:
+            return ''

pypas_cli-0.0.4/src/pypas/main.py

@@ -0,0 +1,43 @@
+import typer
+from rich import print
+from rich.prompt import Confirm
+
+from pypas import Exercise, console
+from pypas.lib.decorators import inside_exercise
+
+app = typer.Typer(
+    add_completion=False,
+    help='✨ pypas',
+    no_args_is_help=True,
+)
+
+
+@app.command()
+def get(exercise_slug: str):
+    if (exercise := Exercise(exercise_slug)).folder_exists():
+        console.print(f'Folder {exercise.cwd_folder} already exists!', style='warning')
+        console.print(
+            '[italic]If continue, files coming from server will [red]OVERWRITE[/red] your existing files'
+        )
+        if not Confirm.ask('Continue', default=False):
+            return
+    if exercise.download():
+        exercise.unzip()
+        console.print(f'Exercise is available at [note]{exercise.cwd_folder}[/note] [success]✔')
+
+
+@app.command()
+@inside_exercise
+def doc():
+    if exercise := Exercise.from_config():
+        exercise.open_docs()
+
+
+@app.command()
+@inside_exercise
+def update():
+    print('TODO!')
+
+
+if __name__ == '__main__':
+    app()

pypas_cli-0.0.4/src/pypas/settings.py

@@ -0,0 +1,7 @@
+from urllib.parse import urljoin
+
+from prettyconf import config
+
+PYPAS_BASE_URL = config('PYPAS_BASE_URL', default='https://pypas.es/')
+PYPAS_EXERCISES_URLPATH = urljoin(PYPAS_BASE_URL, '/exercises/')
+EXERCISE_CONFIG_FILE = config('EXERCISE_CONFIG_FILE', default='.pypas.toml')

pypas_cli-0.0.2/src/pypas/core.py

@@ -1 +0,0 @@
-# TODO

pypas_cli-0.0.2/src/pypas/main.py

@@ -1,16 +0,0 @@
-import typer
-
-app = typer.Typer(
-    add_completion=False,
-    help='✨ pypas',
-    no_args_is_help=True,
-)
-
-
-@app.command()
-def run():
-    print('Hi there!')
-
-
-if __name__ == '__main__':
-    app()