thebundle 0.0.1__tar.gz

thebundle-0.0.1/.github/workflows/python-macos.yml

@@ -0,0 +1,28 @@
+name: macOS
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        python-version: [3.10, 3.11, 3.12]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+
+    - name: Run tests
+      run: |
+        pytest tests/

thebundle-0.0.1/.github/workflows/python-ubuntu.yml

@@ -0,0 +1,28 @@
+name: Ubuntu
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.10, 3.11, 3.12]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+
+    - name: Run tests
+      run: |
+        pytest tests/

thebundle-0.0.1/.github/workflows/python-windows.yml

@@ -0,0 +1,28 @@
+name: Windows
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: [3.10, 3.11, 3.12]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+
+    - name: Run tests
+      run: |
+        pytest tests/

thebundle-0.0.1/.gitignore

@@ -0,0 +1,180 @@
+venv 
+wenv
+
+build
+
+# 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/
+__pycache__/
+*.egg-info
+*.egg-info/
+
+tests/ref/failed
+tests/ref/cprofile
+
+logs/
+
+*.prof
+
+tmp/
+.vscode/
+
+src/bundle/_version.py

thebundle-0.0.1/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2023 HorusElohim
+
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+  
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.

thebundle-0.0.1/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: thebundle
+Version: 0.0.1
+Summary: Python TheBundle essential code.
+Requires-Python: >=3.10
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: jsonschema
+Requires-Dist: setuptools_scm
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: radon; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: black; extra == "test"
+Requires-Dist: isort; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Provides-Extra: dev
+Requires-Dist: snakeviz; extra == "dev"
+Provides-Extra: pypi
+Requires-Dist: build; extra == "pypi"
+Requires-Dist: twine; extra == "pypi"

thebundle-0.0.1/README.md

@@ -0,0 +1,40 @@
+
+# BUNDLE: The Next-Generation Python Toolkit
+
+![The Bundle Dream](thebundle.png)
+
+
+## Getting Started
+
+Embark on your BUNDLE journey:
+1. Install BUNDLE: `pip install thebundle`
+2. Explore our extensive documentation for more insights.
+3. Experiment with our test suite to see BUNDLE in action.
+
+
+Welcome to BUNDLE, a comprehensive Python package designed to enhance various aspects of coding, from data handling and entity management to process control and task execution. BUNDLE streamlines complex tasks, offering robust and efficient solutions for both synchronous and asynchronous operations.
+
+### [data](src/bundle/data/README.md)
+The data subpackage provides advanced data handling capabilities, focusing on easy conversions between Python data classes and dictionaries, JSON serialization/deserialization, and JSON schema validations.
+
+### [entity](src/bundle/entity/README.md)
+This subpackage introduces an advanced Entity class, an enhanced data structure that serves as a base for developing more complex classes with additional features like lifecycle timestamps and auto-saving capabilities.
+
+### [tasks](src/bundle/tasks/README.md)
+This subpackage is dedicated to task management and execution. It includes classes for both synchronous and asynchronous task execution, extending these functionalities to a variety of use cases.
+
+### [process](src/bundle/process/README.md)
+The process subpackage offers sophisticated process handling capabilities, ideal for managing and interacting with system processes in both synchronous and asynchronous contexts.
+
+
+### Testing and Tools
+BUNDLE is equipped with a comprehensive testing suite, ensuring reliability and stability across its functionalities. The tests cover all aspects of the package, from data handling to process management.
+
+*tests/tools:* Contains various utility functions and tools to support testing, including assertions, profiling, and more.
+
+## License
+BUNDLE is open-sourced under the APACHE-V2 License.
+
+## Join the BUNDLE Revolution!
+
+Step into the future of Python development with BUNDLE. Redefine what's possible with your code.

thebundle-0.0.1/demo/add_license.py

@@ -0,0 +1,69 @@
+import asyncio
+import os
+import bundle
+
+LOGGER = bundle.logging.getLogger(__name__)
+
+LICENSE_TEXT = """# Copyright 2023 HorusElohim
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""
+
+EXCLUDED_FILE = ["_version.py"]
+
+
+@bundle.data.dataclass
+class FindPythonFilesTask(bundle.tasks.AsyncTask):
+    async def exec(self):
+        tasks = []
+        for root, _, files in os.walk(self.path):
+            for file in files:
+                if file.endswith(".py") and file not in EXCLUDED_FILE:
+                    file_path = os.path.join(root, file)
+                    task = AddLicenseTask(name="AddLicenseTask", path=file_path)
+                    tasks.append(task())
+        await asyncio.gather(*tasks)
+
+
+@bundle.data.dataclass
+class AddLicenseTask(bundle.tasks.AsyncTask):
+    async def exec(self):
+        with open(self.path, "r+", encoding="utf-8") as f:
+            content = f.read()
+            if "Copyright 2023 HorusElohim" not in content:
+                LOGGER.warn("missing LICENSE for %s", self.path)
+                f.seek(0, 0)
+                f.write(LICENSE_TEXT + "\n\n" + content)
+                LOGGER.info("LICENSE added %s", self.path)
+
+
+async def apply_license_to_files(path):
+    find_task = FindPythonFilesTask(name="FindPythonFilesTask", path=path)
+    await find_task()
+
+
+if __name__ == "__main__":
+    import click
+
+    @click.command()
+    @click.option("--path", default=bundle.__path__[0], help="Path to apply the license.")
+    def main(path):
+        """Simple script that applies a license comment to Python files in a given path."""
+        asyncio.run(apply_license_to_files(path))
+
+    main()

thebundle-0.0.1/demo/black.py

@@ -0,0 +1,23 @@
+import click
+import bundle
+import subprocess
+
+LOGGER = bundle.logging.getLogger(__name__)
+
+
+def apply_black_to_file(path: bundle.typing.Union[bundle.Path, str]):
+    LOGGER.info("applying black to '%s' ...", path)
+    p = bundle.process.Process(command=f"black {path}")
+    p(shell=True, text=True)
+    LOGGER.info("black applied to  '%s' ✅", path)
+
+
+@click.command()
+@click.option("--path", default=bundle.__path__[0], help="Path to format with Black.")
+def main(path):
+    """Simple script that applies Black formatter to a given path."""
+    apply_black_to_file(path)
+
+
+if __name__ == "__main__":
+    main()

thebundle-0.0.1/demo/clean_pycache.py

@@ -0,0 +1,30 @@
+import click
+import bundle
+import shutil
+import os
+
+LOGGER = bundle.logging.getLogger(__name__)
+
+
+@bundle.data.dataclass
+class CleanPyCache(bundle.tasks.Task):
+    def exec(self) -> None:
+        if not self.path.is_dir():
+            raise ValueError(f"The path {self.path} is not a valid directory.")
+
+        for root, dirs, files in os.walk(self.path):
+            if "__pycache__" in dirs:
+                pycache_path = bundle.Path(root) / "__pycache__"
+                LOGGER.info(f"Removing {pycache_path}")
+                shutil.rmtree(pycache_path)
+
+
+@click.command()
+@click.option("--path", default=bundle.__path__[0], help="Path to format with Black.")
+def main(path):
+    """Simple script that clean all the __pycache__ to a given path."""
+    CleanPyCache(path=bundle.Path(path))()
+
+
+if __name__ == "__main__":
+    main()

thebundle-0.0.1/demo/record.py

@@ -0,0 +1,76 @@
+import bundle
+import signal
+
+
+BIN_PATH = bundle.Path(r"C:\FFmpeg\ffmpeg-6.0-essentials_build\bin\ffmpeg.exe")
+
+
+@bundle.data.dataclass
+class FFmpegRecord(bundle.process.Process):
+    bin_path: bundle.Path = bundle.data.field(default_factory=lambda: BIN_PATH)
+    format: str = "gdigrab"
+    framerate: float = 60
+    width: int = 2560
+    height: int = 1440
+    input: str = "desktop"
+    codec: str = "libx264"
+    preset: str = "medium"
+    pix_fmt: str = "yuv420p"
+    output_file: str = "output.mp4"
+    audio_codec: str = "aac"
+    audio_bitrate: str = "192k"
+    audio_channels: int = 2
+    audio_sample_rate: int = 44100
+    video_bitrate: str = "6000k"
+    crf: int = 18  # Lower CRF value means better quality
+    tune: str = "zerolatency"
+    filters: str = ""
+    profile: str = ""
+    level: str = ""
+    maxrate: str = ""
+    bufsize: str = ""
+    overwrite: bool = True
+    duration: str = ""
+    auto_save: bool = True
+
+    def __post_init__(self):
+        super().__post_init__()
+        self.command = (
+            f"{self.bin_path} "
+            f"-f {self.format} "
+            f"-framerate {self.framerate} "
+            f"-video_size {self.width}x{self.height} "
+            f"-i {self.input} "
+            f"-c:v {self.codec} "
+            f"-b:v {self.video_bitrate} "
+            f"-crf {self.crf} "
+            f"-preset {self.preset} "
+            f"-pix_fmt {self.pix_fmt} "
+            f"{f'-tune {self.tune} ' if self.tune else ''}"
+            f"{f'-vf {self.filters} ' if self.filters else ''}"
+            f"{f'-profile:v {self.profile} ' if self.profile else ''}"
+            f"{f'-level {self.level} ' if self.level else ''}"
+            f"{f'-maxrate {self.maxrate} ' if self.maxrate else ''}"
+            f"{f'-bufsize {self.bufsize} ' if self.bufsize else ''}"
+            f"-c:a {self.audio_codec} "
+            f"-b:a {self.audio_bitrate} "
+            f"-ac {self.audio_channels} "
+            f"-ar {self.audio_sample_rate} "
+            f"{'-y ' if self.overwrite else ''}"
+            f"{f'-t {self.duration} ' if self.duration else ''}"
+            f"{self.output_file}"
+        )
+
+
+if __name__ == "__main__":
+
+    def signal_handler(sig, frame):
+        print("Stopping recording...")
+        ffrecord.terminate()
+
+    signal.signal(signal.SIGINT, signal_handler)
+
+    print("Starting recording. Press Ctrl+C to stop.")
+    name = f"Recording_{bundle.datetime.now().strftime('%Y.%m.%d.%H.%M.%S')}"
+    ffrecord = FFmpegRecord(name=name)
+    ffrecord()

thebundle-0.0.1/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools", "wheel", "setuptools_scm", "build"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "thebundle"
+dynamic = ["version"]
+description = "Python TheBundle essential code."
+requires-python = ">=3.10"
+dependencies = ["requests", "jsonschema", "setuptools_scm"]
+
+[tool.setuptools_scm]
+version_file = "src/bundle/_version.py"
+
+[project.optional-dependencies]
+test = ["pytest", "coverage", "radon", "flake8", "black", "isort", "mypy"]
+dev = ["snakeviz"]
+pypi = ["build", "twine"]
+
+
+[tool.pytest.ini_options]
+addopts = ["--doctest-modules", "--capture=no"]
+testpaths = ["tests"]
+log_cli = true
+log_cli_level = "DEBUG"
+
+[tool.black]
+line-length = 128
+target-version = ['py310']
+include = '\.pyi?$'
+
+[tool.flake8]
+max-line-length = 128

thebundle-0.0.1/setup.cfg

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

thebundle-0.0.1/src/bundle/__init__.py

@@ -0,0 +1,38 @@
+# Copyright 2023 HorusElohim
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+
+import time
+from datetime import datetime
+import logging
+import typing
+from pathlib import Path
+
+from ._version import version, version_tuple
+from .logs import setup_logging, LOGGING_LEVEL, LogEmoji
+
+LOGGER = setup_logging(log_level=LOGGING_LEVEL, to_json=True)
+
+from . import data
+from . import entity
+from . import tasks
+from . import process
+from . import tests
+
+LOGGER.debug("bundle loaded")

thebundle-0.0.1/src/bundle/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)