feat: Initialize App

navariltd · May 19, 2024 · e7d8160 · e7d8160
commit e7d8160
Show file tree

Hide file tree

Showing 16 changed files with 362 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,90 @@
+
+name: CI
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+concurrency:
+  group: develop-nl_piece_rate_pay-${{ github.event.number }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    name: Server
+
+    services:
+      mariadb:
+        image: mariadb:10.6
+        env:
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+
+    steps:
+      - name: Clone
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          check-latest: true
+
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/*requirements.txt', '**/pyproject.toml', '**/setup.py', '**/setup.cfg') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: 'echo "::set-output name=dir::$(yarn cache dir)"'
+
+      - uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      - name: Setup
+        run: |
+          pip install frappe-bench
+          bench init --skip-redis-config-generation --skip-assets --python "$(which python)" ~/frappe-bench
+          mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL character_set_server = 'utf8mb4'"
+          mysql --host 127.0.0.1 --port 3306 -u root -proot -e "SET GLOBAL collation_server = 'utf8mb4_unicode_ci'"
+
+      - name: Install
+        working-directory: /home/runner/frappe-bench
+        run: |
+          bench get-app nl_piece_rate_pay $GITHUB_WORKSPACE
+          bench setup requirements --dev
+          bench new-site --db-root-password root --admin-password admin test_site
+          bench --site test_site install-app nl_piece_rate_pay
+          bench build
+        env:
+          CI: 'Yes'
+
+      - name: Run Tests
+        working-directory: /home/runner/frappe-bench
+        run: |
+          bench --site test_site set-config allow_tests true
+          bench --site test_site run-tests --app nl_piece_rate_pay
+        env:
+          TYPE: server
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+.DS_Store
+*.pyc
+*.egg-info
+*.swp
+tags
+nl_piece_rate_pay/docs/current
+node_modules/
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+## Casua Piece Rate
+
+Casual Payroll System
+
+#### License
+
+AGPL
diff --git a/license.txt b/license.txt
@@ -0,0 +1 @@
+License: AGPL
diff --git a/nl_piece_rate_pay/__init__.py b/nl_piece_rate_pay/__init__.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
diff --git a/nl_piece_rate_pay/casua_piece_rate/__init__.py b/nl_piece_rate_pay/casua_piece_rate/__init__.py
diff --git a/nl_piece_rate_pay/config/__init__.py b/nl_piece_rate_pay/config/__init__.py
diff --git a/nl_piece_rate_pay/config/desktop.py b/nl_piece_rate_pay/config/desktop.py
@@ -0,0 +1,10 @@
+from frappe import _
+
+def get_data():
+	return [
+		{
+			"module_name": "Casua Piece Rate",
+			"type": "module",
+			"label": _("Casua Piece Rate")
+		}
+	]
diff --git a/nl_piece_rate_pay/config/docs.py b/nl_piece_rate_pay/config/docs.py
@@ -0,0 +1,10 @@
+"""
+Configuration for docs
+"""
+
+# source_link = "https://github.com/[org_name]/nl_piece_rate_pay"
+# headline = "App that does everything"
+# sub_heading = "Yes, you got that right the first time, everything"
+
+def get_context(context):
+	context.brand_html = "Casua Piece Rate"
diff --git a/nl_piece_rate_pay/hooks.py b/nl_piece_rate_pay/hooks.py
@@ -0,0 +1,215 @@
+app_name = "nl_piece_rate_pay"
+app_title = "Casua Piece Rate"
+app_publisher = "Navari Ltd"
+app_description = "Casual Payroll System"
+app_email = "[email protected]"
+app_license = "AGPL"
+
+# Includes in <head>
+# ------------------
+
+# include js, css files in header of desk.html
+# app_include_css = "/assets/nl_piece_rate_pay/css/nl_piece_rate_pay.css"
+# app_include_js = "/assets/nl_piece_rate_pay/js/nl_piece_rate_pay.js"
+
+# include js, css files in header of web template
+# web_include_css = "/assets/nl_piece_rate_pay/css/nl_piece_rate_pay.css"
+# web_include_js = "/assets/nl_piece_rate_pay/js/nl_piece_rate_pay.js"
+
+# include custom scss in every website theme (without file extension ".scss")
+# website_theme_scss = "nl_piece_rate_pay/public/scss/website"
+
+# include js, css files in header of web form
+# webform_include_js = {"doctype": "public/js/doctype.js"}
+# webform_include_css = {"doctype": "public/css/doctype.css"}
+
+# include js in page
+# page_js = {"page" : "public/js/file.js"}
+
+# include js in doctype views
+# doctype_js = {"doctype" : "public/js/doctype.js"}
+# doctype_list_js = {"doctype" : "public/js/doctype_list.js"}
+# doctype_tree_js = {"doctype" : "public/js/doctype_tree.js"}
+# doctype_calendar_js = {"doctype" : "public/js/doctype_calendar.js"}
+
+# Home Pages
+# ----------
+
+# application home page (will override Website Settings)
+# home_page = "login"
+
+# website user home page (by Role)
+# role_home_page = {
+# 	"Role": "home_page"
+# }
+
+# Generators
+# ----------
+
+# automatically create page for each record of this doctype
+# website_generators = ["Web Page"]
+
+# Jinja
+# ----------
+
+# add methods and filters to jinja environment
+# jinja = {
+# 	"methods": "nl_piece_rate_pay.utils.jinja_methods",
+# 	"filters": "nl_piece_rate_pay.utils.jinja_filters"
+# }
+
+# Installation
+# ------------
+
+# before_install = "nl_piece_rate_pay.install.before_install"
+# after_install = "nl_piece_rate_pay.install.after_install"
+
+# Uninstallation
+# ------------
+
+# before_uninstall = "nl_piece_rate_pay.uninstall.before_uninstall"
+# after_uninstall = "nl_piece_rate_pay.uninstall.after_uninstall"
+
+# Integration Setup
+# ------------------
+# To set up dependencies/integrations with other apps
+# Name of the app being installed is passed as an argument
+
+# before_app_install = "nl_piece_rate_pay.utils.before_app_install"
+# after_app_install = "nl_piece_rate_pay.utils.after_app_install"
+
+# Integration Cleanup
+# -------------------
+# To clean up dependencies/integrations with other apps
+# Name of the app being uninstalled is passed as an argument
+
+# before_app_uninstall = "nl_piece_rate_pay.utils.before_app_uninstall"
+# after_app_uninstall = "nl_piece_rate_pay.utils.after_app_uninstall"
+
+# Desk Notifications
+# ------------------
+# See frappe.core.notifications.get_notification_config
+
+# notification_config = "nl_piece_rate_pay.notifications.get_notification_config"
+
+# Permissions
+# -----------
+# Permissions evaluated in scripted ways
+
+# permission_query_conditions = {
+# 	"Event": "frappe.desk.doctype.event.event.get_permission_query_conditions",
+# }
+#
+# has_permission = {
+# 	"Event": "frappe.desk.doctype.event.event.has_permission",
+# }
+
+# DocType Class
+# ---------------
+# Override standard doctype classes
+
+# override_doctype_class = {
+# 	"ToDo": "custom_app.overrides.CustomToDo"
+# }
+
+# Document Events
+# ---------------
+# Hook on document methods and events
+
+# doc_events = {
+# 	"*": {
+# 		"on_update": "method",
+# 		"on_cancel": "method",
+# 		"on_trash": "method"
+# 	}
+# }
+
+# Scheduled Tasks
+# ---------------
+
+# scheduler_events = {
+# 	"all": [
+# 		"nl_piece_rate_pay.tasks.all"
+# 	],
+# 	"daily": [
+# 		"nl_piece_rate_pay.tasks.daily"
+# 	],
+# 	"hourly": [
+# 		"nl_piece_rate_pay.tasks.hourly"
+# 	],
+# 	"weekly": [
+# 		"nl_piece_rate_pay.tasks.weekly"
+# 	],
+# 	"monthly": [
+# 		"nl_piece_rate_pay.tasks.monthly"
+# 	],
+# }
+
+# Testing
+# -------
+
+# before_tests = "nl_piece_rate_pay.install.before_tests"
+
+# Overriding Methods
+# ------------------------------
+#
+# override_whitelisted_methods = {
+# 	"frappe.desk.doctype.event.event.get_events": "nl_piece_rate_pay.event.get_events"
+# }
+#
+# each overriding function accepts a `data` argument;
+# generated from the base implementation of the doctype dashboard,
+# along with any modifications made in other Frappe apps
+# override_doctype_dashboards = {
+# 	"Task": "nl_piece_rate_pay.task.get_dashboard_data"
+# }
+
+# exempt linked doctypes from being automatically cancelled
+#
+# auto_cancel_exempted_doctypes = ["Auto Repeat"]
+
+# Ignore links to specified DocTypes when deleting documents
+# -----------------------------------------------------------
+
+# ignore_links_on_delete = ["Communication", "ToDo"]
+
+# Request Events
+# ----------------
+# before_request = ["nl_piece_rate_pay.utils.before_request"]
+# after_request = ["nl_piece_rate_pay.utils.after_request"]
+
+# Job Events
+# ----------
+# before_job = ["nl_piece_rate_pay.utils.before_job"]
+# after_job = ["nl_piece_rate_pay.utils.after_job"]
+
+# User Data Protection
+# --------------------
+
+# user_data_fields = [
+# 	{
+# 		"doctype": "{doctype_1}",
+# 		"filter_by": "{filter_by}",
+# 		"redact_fields": ["{field_1}", "{field_2}"],
+# 		"partial": 1,
+# 	},
+# 	{
+# 		"doctype": "{doctype_2}",
+# 		"filter_by": "{filter_by}",
+# 		"partial": 1,
+# 	},
+# 	{
+# 		"doctype": "{doctype_3}",
+# 		"strict": False,
+# 	},
+# 	{
+# 		"doctype": "{doctype_4}"
+# 	}
+# ]
+
+# Authentication and authorization
+# --------------------------------
+
+# auth_hooks = [
+# 	"nl_piece_rate_pay.auth.validate"
+# ]
diff --git a/nl_piece_rate_pay/modules.txt b/nl_piece_rate_pay/modules.txt
@@ -0,0 +1 @@
+Casua Piece Rate
diff --git a/nl_piece_rate_pay/patches.txt b/nl_piece_rate_pay/patches.txt
diff --git a/nl_piece_rate_pay/public/.gitkeep b/nl_piece_rate_pay/public/.gitkeep
diff --git a/nl_piece_rate_pay/templates/__init__.py b/nl_piece_rate_pay/templates/__init__.py
diff --git a/nl_piece_rate_pay/templates/pages/__init__.py b/nl_piece_rate_pay/templates/pages/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,20 @@
+[project]
+name = "nl_piece_rate_pay"
+authors = [
+    { name = "Navari Ltd", email = "[email protected]"}
+]
+description = "Casual Payroll System"
+requires-python = ">=3.10"
+readme = "README.md"
+dynamic = ["version"]
+dependencies = [
+    # "frappe~=15.0.0" # Installed and managed by bench.
+]
+
+[build-system]
+requires = ["flit_core >=3.4,<4"]
+build-backend = "flit_core.buildapi"
+
+# These dependencies are only installed when developer mode is enabled
+[tool.bench.dev-dependencies]
+# package_name = "~=1.1.0"