appcraft 0.3.0__tar.gz

appcraft-0.3.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md LICENSE
+include appcraft/templates/*
+global-exclude *.py
+global-exclude __pycache__/*.pyc

appcraft-0.3.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.2
+Name: appcraft
+Version: 0.3.0
+Summary: Um framework que cria estruturas de projeto personalizadas.
+Home-page: https://github.com/duxtec/appcraft
+Author-email: Dux Tecnologia <contato@tpereira.com.br>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Requires-Dist: prompt_toolkit
+Requires-Dist: toml
+Dynamic: home-page

appcraft-0.3.0/README.md

@@ -0,0 +1,79 @@
+# Appcraft
+
+**Appcraft** is a framework designed to simplify the development and management of applications. It provides a structured approach to creating projects, running scripts, and testing your code.
+
+## Installation
+
+To get started with **Appcraft**, follow the installation instructions specific to your environment. Ensure you have Python installed, and then install Appcraft using pip:
+
+```bash
+pip install appcraft
+```
+
+## Create a New Project
+
+To create a new project, use the following command:
+
+```bash
+appcraft init <templates>
+```
+
+Replace `<templates>` with the name of the template you wish to use.
+
+## Available Templates
+
+To show the list of available templates, run:
+
+```bash
+appcraft list-templates
+```
+
+## Testing and Documentation
+
+**Appcraft** comes with built-in support for:
+
+- **Pytest**: For running tests and ensuring your code is reliable.
+- **Sphinx**: For generating documentation, making it easy to document your project.
+
+## Running Applications
+
+To execute the apps within your project, use:
+
+```bash
+python run
+```
+
+## Running Project Scripts
+
+To execute helper scripts in your project, use:
+
+```bash
+python run_tools
+```
+
+Make sure that your scripts are located in the `scripts` folder and your apps are in the `app` folder.
+
+### App and Scripts Structures
+
+To be recognized by **Appcraft**, apps and scripts must inherit from the `App` class and use the `@App.runner` decorator. Here's an example:
+
+```python
+from infrastructure.framework.appcraft.core.app_runner import AppRunner
+
+class MyApp(AppRunner):
+
+    @AppRunner.runner
+    def runner1(self):
+        # Code for runner1
+        pass
+
+    def non_runner1(self):
+        # This method does not show in the runner.
+        pass
+```
+
+## Conclusion
+
+**Appcraft** provides a streamlined approach to application development, allowing you to focus on building features while managing your projects efficiently. Happy coding!
+
+--- 

appcraft-0.3.0/appcraft/templates/base/files/Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[requires]
+python_version = "3.12"
+
+[packages]
+toml = "==0.10.2"
+prompt-toolkit = "*"
+
+[dev-packages]
+sphinx = "==8.0.2"
+flake8 = "==6.1.0"
+black = "*"
+isort = "*"

appcraft-0.3.0/appcraft/templates/base/files/README.md

@@ -0,0 +1,79 @@
+# Appcraft
+
+**Appcraft** is a framework designed to simplify the development and management of applications. It provides a structured approach to creating projects, running scripts, and testing your code.
+
+## Installation
+
+To get started with **Appcraft**, follow the installation instructions specific to your environment. Ensure you have Python installed, and then install Appcraft using pip:
+
+```bash
+pip install appcraft
+```
+
+## Create a New Project
+
+To create a new project, use the following command:
+
+```bash
+appcraft init <templates>
+```
+
+Replace `<templates>` with the name of the template you wish to use.
+
+## Available Templates
+
+To show the list of available templates, run:
+
+```bash
+appcraft list-templates
+```
+
+## Testing and Documentation
+
+**Appcraft** comes with built-in support for:
+
+- **Pytest**: For running tests and ensuring your code is reliable.
+- **Sphinx**: For generating documentation, making it easy to document your project.
+
+## Running Applications
+
+To execute the apps within your project, use:
+
+```bash
+python run
+```
+
+## Running Project Scripts
+
+To execute helper scripts in your project, use:
+
+```bash
+python run_tools
+```
+
+Make sure that your scripts are located in the `scripts` folder and your apps are in the `app` folder.
+
+### App and Scripts Structures
+
+To be recognized by **Appcraft**, apps and scripts must inherit from the `App` class and use the `@App.runner` decorator. Here's an example:
+
+```python
+from infrastructure.framework.appcraft.core.app_runner import AppRunner
+
+class MyApp(AppRunner):
+
+    @AppRunner.runner
+    def runner1(self):
+        # Code for runner1
+        pass
+
+    def non_runner1(self):
+        # This method does not show in the runner.
+        pass
+```
+
+## Conclusion
+
+**Appcraft** provides a streamlined approach to application development, allowing you to focus on building features while managing your projects efficiently. Happy coding!
+
+--- 

appcraft-0.3.0/appcraft/templates/base/files/config/app.toml

@@ -0,0 +1,11 @@
+# Configuration for the Appcraft application
+name = "Appcraft"
+version = "1.0.0"
+environment = "development" # production or development
+debug_mode = true
+log_level = "info" # debug, info, warning, error or critical
+lang = "en" # see supported langs
+lang_preference = "config" # config or system
+supported_langs = ["en", "pt_BR"]
+
+# Use 'lang_preference' to decide if language should be set from config or system

appcraft-0.3.0/appcraft/templates/base/files/config/theme.json

@@ -0,0 +1,4 @@
+{
+    "color1": "#FF00FF",
+    "color2": "#FF6600"
+}

appcraft-0.3.0/appcraft/templates/base/files/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

appcraft-0.3.0/appcraft/templates/base/files/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

appcraft-0.3.0/appcraft/templates/base/files/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. Appcraft documentation master file, created by
+   sphinx-quickstart on Wed Aug 14 18:43:41 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Appcraft Documentation
+==========================
+
+Welcome to the Appcraft documentation! This is where you can find the
+automatically generated documentation for the project's modules and classes.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

appcraft-0.3.0/appcraft/templates/base/files/docs/source/modules.rst

@@ -0,0 +1,27 @@
+App Modules
+===========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: App Modules:
+
+   docs/app
+
+
+Services Modules
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Services Modules:
+
+   docs/services
+
+Core Modules
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Core Modules:
+
+   docs/core

appcraft-0.3.0/appcraft/templates/base/files/infrastructure/framework/appcraft/templates/templates.json

@@ -0,0 +1,3 @@
+{
+    "installed_templates": []
+}

appcraft-0.3.0/appcraft/templates/base/files/run

@@ -0,0 +1,4 @@
+import os
+from infrastructure.framework.appcraft.core.initializer import Initializer
+
+runner = Initializer(app_folder=os.path.join("runners", "main")).main()

appcraft-0.3.0/appcraft/templates/base/files/run_tools

@@ -0,0 +1,4 @@
+import os
+from infrastructure.framework.appcraft.core.initializer import Initializer
+
+runner = Initializer(os.path.join("runners", "tools")).main()

appcraft-0.3.0/appcraft/templates/ci_cd/files/Pipfile

@@ -0,0 +1,9 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[requires]
+python_version = "3.12"
+
+[packages]

appcraft-0.3.0/appcraft/templates/ci_cd/files/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

appcraft-0.3.0/appcraft/templates/ci_cd/files/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

appcraft-0.3.0/appcraft/templates/ci_cd/files/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. Appcraft documentation master file, created by
+   sphinx-quickstart on Wed Aug 14 18:43:41 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Appcraft Documentation
+==========================
+
+Welcome to the Appcraft documentation! This is where you can find the
+automatically generated documentation for the project's modules and classes.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

appcraft-0.3.0/appcraft/templates/ci_cd/files/docs/source/modules.rst

@@ -0,0 +1,27 @@
+App Modules
+===========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: App Modules:
+
+   docs/app
+
+
+Services Modules
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Services Modules:
+
+   docs/services
+
+Core Modules
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Core Modules:
+
+   docs/core

appcraft-0.3.0/appcraft/templates/data_analysis/files/Pipfile

@@ -0,0 +1,17 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[requires]
+python_version = "3.12"
+
+[packages]
+pandas = "==2.2.3"
+numpy = "==2.1.1"
+matplotlib = "==3.9.2"
+seaborn = "==0.13.2"
+scikit-learn = "==1.5.2"
+
+[dev-packages]
+jupyter = "==1.1.1"

appcraft-0.3.0/appcraft/templates/data_analysis/files/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

appcraft-0.3.0/appcraft/templates/data_analysis/files/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

appcraft-0.3.0/appcraft/templates/data_analysis/files/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. Appcraft documentation master file, created by
+   sphinx-quickstart on Wed Aug 14 18:43:41 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Appcraft Documentation
+==========================
+
+Welcome to the Appcraft documentation! This is where you can find the
+automatically generated documentation for the project's modules and classes.
+
+.. toctree::
+   :maxdepth: 10
+   :caption: Contents:
+
+   modules

appcraft-0.3.0/appcraft/templates/data_analysis/files/docs/source/modules.rst

@@ -0,0 +1,27 @@
+App Modules
+===========
+
+.. toctree::
+   :maxdepth: 10
+   :caption: App Modules:
+
+   docs/app
+
+
+Services Modules
+================
+
+.. toctree::
+   :maxdepth: 10
+   :caption: Services Modules:
+
+   docs/services
+
+Core Modules
+============
+
+.. toctree::
+   :maxdepth: 10
+   :caption: Core Modules:
+
+   docs/core

appcraft-0.3.0/appcraft/templates/data_visualization/files/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

appcraft-0.3.0/appcraft/templates/data_visualization/files/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

appcraft-0.3.0/appcraft/templates/data_visualization/files/docs/source/index.rst

@@ -0,0 +1,16 @@
+.. Appcraft documentation master file, created by
+   sphinx-quickstart on Wed Aug 14 18:43:41 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Appcraft Documentation
+==========================
+
+Welcome to the Appcraft documentation! This is where you can find the
+automatically generated documentation for the project's modules and classes.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules

appcraft-0.3.0/appcraft/templates/data_visualization/files/docs/source/modules.rst

@@ -0,0 +1,27 @@
+App Modules
+===========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: App Modules:
+
+   docs/app
+
+
+Services Modules
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Services Modules:
+
+   docs/services
+
+Core Modules
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Core Modules:
+
+   docs/core