adding builder-tool

Author: AntoineBuirey

.github/workflows/OnRelease.yml

@@ -0,0 +1,32 @@
+name: On Release
+on:
+  release:
+    types: [published]
+
+
+jobs:
+  build-builder-tool:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: setup Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12 
+    
+    - name: Update pip
+      run: python -m pip install --upgrade pip
+    
+    - name: Install dependencies
+      run: cd builder-tool && pip install -r requirements.txt
+
+    - name: Build
+      run: cd builder-tool && python pack.py --dist-dir dist -pv ${{ github.event.release.tag_name }} --debug
+
+    - name: Publish
+      uses: AButler/upload-release-assets@v3.0
+      with:
+        files: "builder-tool/dist/*"
+        repo-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -8,6 +8,7 @@
 # temporary files
 *.cache
 *.tmp
+temp/
 
 # compiled files
 *py[cod]

builder-tool/dist/build_tool-0.0.0-py3-none-any.whl

@@ -0,0 +1,23 @@
+from src.main import BaseBuilder, Logger, PYTHON, NULL_TARGET #this file use the module to build itself
+import os
+import shutil
+
+
+class Builder(BaseBuilder):
+    def Setup(self):
+        Logger.debug('Copying sources')
+        shutil.copytree('src', self.tempDir + '/src', ignore=shutil.ignore_patterns('*.pyc', '*.pyo', '__pycache__'))
+        Logger.debug('Copying pyproject.toml')
+        self.CopyAndReplaceByPackageVersion('pyproject.toml', self.tempDir + '/pyproject.toml')
+        Logger.debug('Copying requirements.txt')
+        shutil.copy('requirements.txt', self.tempDir + '/requirements.txt')
+        Logger.debug('Copying readme.md')
+        self.CopyAndReplaceByPackageVersion('readme.md', self.tempDir + '/readme.md')
+        
+    def Build(self):
+        command = f'{PYTHON} -m build --outdir {self.distDir} {self.tempDir} > {NULL_TARGET}'
+        Logger.debug('Executing command: ' + command)
+        os.system(command)
+        
+
+BaseBuilder.execute()

builder-tool/dist/build_tool-0.0.0.tar.gz

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "build-tool"
+version = "{version}"
+authors = [
+  { name="Antoine Buirey", email="antoine.buirey@gmail.com" }
+]
+description = "A simple build tool for projects"
+readme = "readme.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]

builder-tool/pack.py

@@ -0,0 +1,3 @@
+# Builder Tool, for building, testing, publishing, and deploying projects easily.
+
+Current version : {version}

builder-tool/pyproject.toml

@@ -0,0 +1 @@
+gamu_logger @ https://github.com/GamuNetwork/logger/releases/download/2.0.0-alpha.4/gamu_logger-2.0.0a4-py3-none-any.whl

builder-tool/readme.md

@@ -0,0 +1,155 @@
+import argparse
+from gamuLogger import Logger, LEVELS
+
+import os, sys, shutil
+
+from tempfile import mkdtemp
+
+class BaseBuilder:
+    def __init__(self):
+        if self.__class__ == BaseBuilder:
+            raise Exception('BaseBuilder is an abstract class and cannot be instantiated')
+        
+        self.argumentParser = argparse.ArgumentParser(description='Builder tool')
+        
+        loggerOptions = self.argumentParser.add_argument_group('Logger options')
+        loggerOptions.add_argument('--debug', action='store_true', help='Enable debug messages')
+        
+        buildersOptions = self.argumentParser.add_argument_group('Builder options')
+        buildersOptions.add_argument('--no-tests', action='store_true', help='Do not run tests')
+        buildersOptions.add_argument('--no-docs', action='store_true', help='Do not generate documentation')
+        buildersOptions.add_argument('--no-build', action='store_true', help='Do not build the package')
+        buildersOptions.add_argument('--publish', action='store_true', help='Publish the package')
+        buildersOptions.add_argument('--no-clean', action='store_true', help='Do not clean temporary files')
+        buildersOptions.add_argument('--temp-dir', help='Temporary directory', type=str, default=mkdtemp())
+        buildersOptions.add_argument('--dist-dir', help='Distribution directory', type=str, default='dist')
+        buildersOptions.add_argument('-pv', '--package-version', help='Package version', type=str, default='0.0.0')
+        
+        self.argumentParser.add_argument('--version', '-v', action='version', version='%(prog)s 1.0')
+        
+        self.args = self.argumentParser.parse_args()
+        
+        if self.args.debug:
+            Logger.setLevel('stdout', LEVELS.DEBUG)
+        
+        
+        Logger.debug('Using temporary directory: ' + os.path.abspath(self.args.temp_dir))
+        Logger.debug('Using distribution directory: ' + os.path.abspath(self.args.dist_dir))
+        
+        if os.path.exists(self.args.temp_dir):
+            Logger.debug('Removing temp directory for cleaning')
+            shutil.rmtree(self.args.temp_dir)
+        
+        Logger.debug('Creating temp directory')
+        os.makedirs(self.args.temp_dir)
+        
+    @property
+    def tempDir(self):
+        return os.path.abspath(self.args.temp_dir)
+    
+    @property
+    def packageVersion(self):
+        return self.args.package_version
+    
+    @property
+    def distDir(self):
+        return os.path.abspath(self.args.dist_dir)
+    
+    def CopyAndReplaceByPackageVersion(self, src, dst, versionString = "{version}"):
+        with open(src, 'r') as file:
+            content = file.read()
+        content = content.replace(versionString, self.packageVersion)
+        with open(dst, 'w') as file:
+            file.write(content)
+        
+        
+    
+    # These methods should be overriden by the child class
+    def Setup(self):
+        """Copy required file to the temporary directory and replace the version string by the package version, install dependencies, etc."""
+        Logger.warning('no setup configured')
+    
+    def Tests(self):
+        """Run the tests for the package"""
+        Logger.debug('no tests configured')
+        
+    def Docs(self):
+        """Generate the documentation for the package"""
+        Logger.debug('no docs configured')
+        
+    def Build(self):
+        """Build the package"""
+        Logger.warning('no build configured')
+        
+    def Publish(self):
+        """Publish the package"""
+        Logger.error('no publish configured')
+        
+        
+    def __clean(self):
+        shutil.rmtree(self.args.temp_dir)
+        
+    
+    def __run(self):
+        """
+        Order of execution:
+        - Setup
+        - Build
+        - Tests
+        - Docs
+        - Publish
+        - Clean
+        
+        If any of this steps fails, the process should stop, and the clean method should be called
+        """
+        
+        Logger.info('Running setup')
+        self.Setup()
+        Logger.debug('Setup finished')
+        
+        if not self.args.no_build:
+            Logger.info('Building package')
+            self.Build()
+        
+        if self.args.no_tests:
+            Logger.warning('Skipping tests')
+        else:
+            Logger.info('Running tests')
+            self.Tests()
+        
+        if not self.args.no_docs:
+            Logger.info('Generating documentation')
+            self.Docs()
+        
+        if self.args.publish:
+            Logger.info('Publishing package')
+            self.Publish()
+        else:
+            Logger.info('Package not published')
+        
+        if self.args.no_clean:
+            Logger.warning('Skipping cleaning')
+        else:
+            Logger.info('Cleaning temporary files')
+            self.__clean()
+            Logger.debug('Temporary files cleaned')
+            
+        Logger.info('Process finished')
+
+
+    @staticmethod
+    def execute():
+        subClasses = BaseBuilder.__subclasses__()
+        if len(subClasses) == 0:
+            Logger.critical('No builders found')
+            sys.exit(1)
+        elif len(subClasses) > 1:
+            Logger.critical('Multiple builders found')
+            sys.exit(1)
+        subClasses[0]().__run()
+        
+        
+# some useful constants
+        
+PYTHON = sys.executable
+NULL_TARGET = '/dev/null' if os.name == 'posix' else 'nul'