ሞጁል ይገንቡ

በCelerp ውስጥ ያለ እያንዳንዱ ባህሪ ሞጁል ነው። የተካተቱት የእቃ ክምችት፣ የሂሳብ አያያዝና የማምረቻ ሞጁሎችም እርስዎ የሚገነቡት ሞጁል የሚጠቀምበትን የመጫኛ ስርዓት ይጠቀማሉ። ሞጁል በአቃፊ ውስጥ ያለ የPython ጥቅል ነው። Celerp ሞጁሉን ያገኘዋል፣ የውሂብ መዋቅር ለውጦቹን ያስኬዳል፣ የAPI እና UI መንገዶቹን ያስመዘግባል እና ባህሪዎቹን ወደ መተግበሪያው ያክላል። Celerpን በተለየ ቅርንጫፍ መቅዳትም ሆነ የግንባታ ደረጃ ማከናወን አያስፈልግም።

ይህ ገጽ ሞጁል ለመገንባት፣ ለመፈተሽ፣ ለመጫንና በዝርዝር ለማስገባት የሚያስፈልጉትን ሁሉ ይሸፍናል። Python 3.10 ወይም ከዚያ በላይ እና ስለ FastAPI እና SQLAlchemy ተግባራዊ እውቀት ያስፈልጋል።

ኮድ አይጻፉም? በChatGPT ወይም Claude ሞጁል ይፍጠሩ።

ከአብነቱ ይጀምሩ

celerp-module-template የተባለውን የኮድ ማከማቻ ይቅዱ። የፍለጋ አቅራቢ፣ የፋይል ሰቀላ፣ ሁለት የውሂብ መዋቅር ለውጦች እና ሙሉ የፈተና ስብስብ ያለው የመሣሪያ ጥገና ሞጁል (acme-maintenance) እንዲሁም የmanifest መርማሪ lint.py (በሞጁሉን ይፈትሹ ክፍል የተገለጸው) ይዟል። ስሙን እና ይዘቱን ለራስዎ ሞጁል ይቀይሩ ወይም ከታች ባለው አጭር ምሳሌ ይጀምሩ።

የሞጁል አወቃቀር

ሞጁል __init__.py ፋይሉ ውስጥ PLUGIN_MANIFEST የሚያብራራ አቃፊ ሲሆን በውስጡ ኮዱን የያዘ የPython ጥቅል አለ። የአቃፊው ስም ሞጁሉን ለማንቃት የሚጠቀሙበት ስም ነው፤ በmanifest ውስጥ ካለው name ጋር መዛመድ አለበት።

acme-notes/                       the module; hyphens are fine here
  __init__.py                     PLUGIN_MANIFEST and nothing else
  acme_notes/                     inner package; imported as acme_notes
    __init__.py
    models.py                     tables, on Celerp's shared Base
    routes.py                     API routes; defines setup_api_routes(app)
    ui_routes.py                  UI pages; defines setup_ui_routes(app)
    migrations/
      __init__.py
      acme_notes_001_create_note.py
  locales/
    en.json                       translation strings

Celerp በሁለት ሂደቶች ይሠራል። API (FastAPI) setup_api_routes(app)ን ይጠራል። UI (FastHTML) setup_ui_routes(app)ን ይጠራል፤ ገጾቹም በapi_request አማካኝነት እንደ የገባው ተጠቃሚ APIን ይጠቀማሉ ( የሞጁል APIን ይመልከቱ)። እያንዳንዱ የሞጁል አቃፊ ወደ የPython ፍለጋ መንገድ ስለሚጨመር ውስጣዊው ጥቅል በራሱ ስም ሊጫን ይችላል።

የተሟላ ምሳሌ

ይህ ሞጁል በጎን ምናሌው የኦፕሬሽን ክፍል ስር የማስታወሻ ገጽ ይጨምራል፤ ማስታወሻዎችንም ለእያንዳንዱ ኩባንያ ለይቶ ያስቀምጣል። ሰነዶችን ማየት የሚችል ሁሉ ማስታወሻዎችን ያነባል፤ ሰነዶችን ማስተካከል የሚችል ደግሞ ያክላል። ሁሉም ፋይሎች ሙሉ በሙሉ ቀርበዋል። ከላይ ወዳለው መዋቅር ይቅዱና በበልማት ጊዜ ማስኬድ መመሪያ መሠረት ያስኬዱ።

acme-notes/__init__.py

PLUGIN_MANIFEST = {
    "name": "acme-notes",
    "version": "0.1.0",
    "display_name": "Notes",
    "description": "Short notes for the whole company.",
    "author": "Acme",
    "license": "MIT",
    "min_celerp_version": "2.0.0",
    "api_routes": "acme_notes.routes",
    "ui_routes": "acme_notes.ui_routes",
    "slots": {
        "nav": [{
            "key": "notes",
            "label": "Notes",
            "label_key": "acme_notes.nav",
            "href": "/notes",
            "group": "Operations",
            "order": 60,
            "permission": "view_documents",
        }],
    },
    "table_prefix": "acme_",
    "migrations": "acme_notes.migrations",
    "company_backup": {"acme_note": "include"},
    "locales": {"en": {"file": "locales/en.json", "rtl": False}},
}

acme-notes/acme_notes/__init__.py እና acme-notes/acme_notes/migrations/__init__.py ባዶ ፋይሎች ናቸው።

acme_notes/models.py

import uuid
from datetime import datetime, timezone

import sqlalchemy as sa
from sqlalchemy.orm import Mapped, mapped_column

from celerp.models.base import Base


class Note(Base):
    __tablename__ = "acme_note"

    id: Mapped[uuid.UUID] = mapped_column(sa.Uuid(as_uuid=True), primary_key=True,
                                          default=uuid.uuid4)
    company_id: Mapped[uuid.UUID] = mapped_column(
        sa.ForeignKey("companies.id"), nullable=False, index=True)
    body: Mapped[str] = mapped_column(sa.Text(), nullable=False)
    created_at: Mapped[datetime] = mapped_column(
        sa.DateTime(timezone=True), nullable=False,
        default=lambda: datetime.now(timezone.utc))

acme_notes/migrations/acme_notes_001_create_note.py

import sqlalchemy as sa
from alembic import op


def upgrade() -> None:
    # Runs on every start, so it checks before it creates.
    if "acme_note" in sa.inspect(op.get_bind()).get_table_names():
        return
    op.create_table(
        "acme_note",
        sa.Column("id", sa.Uuid(as_uuid=True), primary_key=True),
        sa.Column("company_id", sa.Uuid(as_uuid=True),
                  sa.ForeignKey("companies.id"), nullable=False, index=True),
        sa.Column("body", sa.Text(), nullable=False),
        sa.Column("created_at", sa.DateTime(timezone=True), nullable=False),
    )

acme_notes/routes.py

እያንዳንዱ የውሂብ ጥያቄ በአሁኑ ኩባንያ መሠረት መጣራት አለበት። Celerp ብዙ ኩባንያዎችን በአንድ የውሂብ ጎታ ውስጥ ያስተዳድራል፤ ይህን ማጣሪያ መርሳት የአንዱን ኩባንያ ውሂብ ለሌላው ሊያሳይ ይችላል።

from fastapi import APIRouter, Depends
from pydantic import BaseModel, ConfigDict, Field
from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncSession

from celerp.db import get_session
from celerp.services.auth import get_current_company_id, get_current_user
from celerp.services.permissions import require_permission

from acme_notes.models import Note

# Reading needs view_documents; adding a note also needs edit_documents.
router = APIRouter(prefix="/api/acme-notes", tags=["acme-notes"],
                   dependencies=[Depends(get_current_user),
                                 require_permission("view_documents")])


class NoteIn(BaseModel):
    model_config = ConfigDict(str_strip_whitespace=True)  # a note of only spaces is refused
    body: str = Field(min_length=1, max_length=2000)


@router.get("")
async def list_notes(company_id=Depends(get_current_company_id),
                     session: AsyncSession = Depends(get_session)) -> dict:
    rows = (await session.execute(
        select(Note).where(Note.company_id == company_id)
        .order_by(Note.created_at.desc()))).scalars().all()
    return {"items": [{"id": str(n.id), "body": n.body,
                       "created_at": n.created_at.isoformat()} for n in rows]}


@router.post("", status_code=201, dependencies=[require_permission("edit_documents")])
async def add_note(payload: NoteIn, company_id=Depends(get_current_company_id),
                   session: AsyncSession = Depends(get_session)) -> dict:
    note = Note(company_id=company_id, body=payload.body)
    session.add(note)
    await session.commit()
    return {"id": str(note.id)}


def setup_api_routes(app) -> None:
    app.include_router(router)

acme_notes/ui_routes.py

API ማግኘት ሲያቅት ገጹ ገለልተኛ መልዕክት ያሳያል። የተጠቃሚው ሚና ማስታወሻዎችን ለማየት ፈቃድ ከሌለው ያሳውቃል፤ ማስቀመጥ ሲከለከልም ግልጽ ስህተት ያሳያል። የተፈጠረ ሐሰተኛ ውሂብ አያሳይም። የመጨመሪያ ቅጽ የedit_documents ፈቃድ ላላቸው ሚናዎች ብቻ ይታያል። ገጹ ከ/companies/me አሁኑን ሚና እና የኩባንያ ቅንብሮችን ያነባል፣ ከAPI ጋር ተመሳሳይ መርማሪ ይጠቀማል። በመግባት በኋላ የተቀየረ ሚናም ወዲያውኑ ይተገበራል። መረጃው ካልተነበበ ቅጹ ተደብቆ ይቆያል። API ፈቃድ የሌላቸውን ሰዎች ማስታወሻ ይከለክላል።

from fasthtml.common import Button, Div, Form, Input, Li, P, Ul, to_xml
from starlette.requests import Request
from starlette.responses import HTMLResponse, RedirectResponse

from celerp.modules.api import api_request
from celerp.services.permissions import role_has_permission
from ui.components.shell import base_shell, page_header
from ui.i18n import t

API = "/api/acme-notes"


async def _call(request: Request, method: str, path: str = API, *, json=None) -> tuple[int, dict]:
    """Call the API as the signed-in user. Status 0: it could not be reached."""
    try:
        r = await api_request(request, method, path, json=json)
        return r.status_code, r.json()
    except Exception:  # unreachable, or a reply that is not JSON
        return 0, {}


async def _can_add(request: Request) -> bool:
    """Whether the signed-in user may add notes, by their current role and the company's settings."""
    status, company = await _call(request, "GET", "/companies/me")
    if status != 200:
        return False
    return role_has_permission(company.get("settings") or {}, company.get("current_role") or "",
                               "edit_documents")


def _notes(status: int, payload: dict, message: str = "") -> Div:
    if status == 403:
        body = P(t("acme_notes.forbidden"))
    elif status != 200:
        body = P(t("acme_notes.load_error"))
    elif not payload.get("items"):
        body = P(t("acme_notes.empty"))
    else:
        body = Ul(*[Li(n["body"]) for n in payload["items"]], cls="list-disc")
    return Div(P(message) if message else "", body, id="acme-notes")


def setup_ui_routes(app) -> None:
    @app.get("/notes")
    async def notes_page(request: Request):
        status, payload = await _call(request, "GET")
        if status == 401:
            return RedirectResponse("/login", status_code=302)
        form = Form(
            Input(name="body", placeholder=t("acme_notes.placeholder"), cls="form-input"),
            Button(t("acme_notes.add"), type="submit", cls="btn btn--primary"),
            hx_post="/notes/add", hx_target="#acme-notes", hx_swap="outerHTML",
        ) if await _can_add(request) else ""
        return await base_shell(
            page_header(t("acme_notes.title")), form, _notes(status, payload),
            title=t("acme_notes.title") + " - Celerp", nav_active="notes", request=request,
        )

    @app.post("/notes/add")
    async def notes_add(request: Request):
        form = await request.form()
        status, _ = await _call(request, "POST", json={"body": str(form.get("body", ""))})
        message = "" if status == 201 else t("acme_notes.save_error")
        return HTMLResponse(to_xml(_notes(*await _call(request, "GET"), message)))

locales/en.json

{
  "acme_notes.nav": "Notes",
  "acme_notes.title": "Notes",
  "acme_notes.placeholder": "Write a note",
  "acme_notes.add": "Add",
  "acme_notes.empty": "No notes yet.",
  "acme_notes.forbidden": "Your role cannot view notes.",
  "acme_notes.load_error": "Notes could not be loaded. Try again in a moment.",
  "acme_notes.save_error": "The note was not saved. It may be empty, or your role may not allow adding notes."
}

የmanifest ማጣቀሻ

PLUGIN_MANIFEST ቀላል ቀጥተኛ እሴት መሆን አለበት፤ ሕብረቁምፊዎች፣ ቁጥሮች፣ እውነት/ሐሰት እሴቶች፣ ዝርዝሮችና መዝገበ ቃላት ብቻ፣ ተለዋዋጮች፣ የተግባር ጥሪዎች ወይም f-string ሳይኖሩ። ሞጁልን መፈተሽና ማስኬድ የተለያዩ እርምጃዎች ናቸው። በሞጁሎች ገጽ ያለው ሞጁል አስገባ፣ lint.py እና Celerp ሲጀምር የሚያደርገው ፍተሻ PLUGIN_MANIFESTን እና የሞጁሉን ፋይሎች እንደ ጽሑፍ ያነባሉ፤ ኮዱን አያስኬዱም። ማንቃት ግን ኮዱን ያስኬዳል፤ Celerp የመዋቅር ለውጦቹን ያስኬዳል፣ Python ኮዱንም በራሱ ሂደት ውስጥ ይጫናል፤ ሞጁሉም Celerp የሚችለውን ሁሉ ማድረግ ይችላል። ይህ በእያንዳንዱ ጅማሬ በሚጫኑ ሞጁሎች ሁሉ (ለማንኛውም ኩባንያ የነቁ ወይም በENABLED_MODULES የተዘረዘሩ) ይከናወናል፤ በእጅ ወደ ሞጁሎች አቃፊ የተቀዱትንም ይጨምራል። ከCelerp 2.5.4 ጀምሮ ከማስገባት በኋላ ያለው PLUGIN_MANIFEST በፋይሉ ካለው ቀጥተኛ እሴት ጋር በትክክል መዛመድ አለበት፤ ካልተዛመደ ሞጁሉ አይጫንም። Celerp የሚያነባቸው ቁልፎች እነዚህ ናቸው። ሌሎች ይታለፋሉ፣ የተሳሳተ ቁልፍም ውጤት የለውም። lint.py ያልታወቁ ቁልፎችን ያሳውቃል።

ቁልፍግዴታዓይነትተግባሩ
nameአዎstringየሞጁሉ መለያ። ከአቃፊ ስም ጋር ማዛመድ አለበት። ፊደላት፣ ቁጥሮች፣ - እና _ ብቻ ይፈቀዳሉ፤ በፊደል ወይም በቁጥር መጀመር አለበት፣ ቢበዛ 64 ቁምፊዎች። በcelerp- የሚጀምሩ ስሞች ለMarketplace ሞጁሎች ተመድበዋል፤ ሰቀላው ይከለክላቸዋል። ለራስዎ ሞጁል ይህን celerp- ቅድመ ቅጥያ የሌለውን ስም ይምረጡ።
versionአዎstringበሞጁሎች ገጽ ይታያል። major.minor.patchን ይጠቀሙ።
display_nameNostringበሞጁሎች ገጽ የሚታየው ስም። ከሌለ label፣ ከዚያ name ይጠቀማል።
labelNostringdisplay_name ከሌለ እንደ ማሳያ ስም ይጠቀማል።
descriptionNostringበሞጁሎች ገጽ የሚታይ አንድ ወይም ሁለት ዐረፍተ ነገሮች።
authorNostringበሞጁሎች ገጽ ይታያል።
licenseNostringእንደ MIT ያለ የSPDX መለያ።
min_celerp_versionNostringሞጁሉ የሚደግፈው በጣም የቆየ የCelerp ስሪት። ስሪቶችና ጥገኛ ሞጁሎችን ይመልከቱ።
depends_onNoየጽሑፍ ሕብረቁምፊዎች ዝርዝርቀድመው መንቃትና መጫን ያለባቸው ሞጁሎች ስሞች።
api_routesNoበነጥብ የተለየ የሞጁል መንገድsetup_api_routes(app) የሚገልጽ ሞጁል።
ui_routesNoበነጥብ የተለየ የሞጁል መንገድsetup_ui_routes(app) የሚገልጽ ሞጁል።
slotsNodictሞጁሉ የሚያስፋፋቸው የCelerp ክፍሎች። ማስገቢያ ቦታዎችን ይመልከቱ።
table_prefixሞጁሉ ሰንጠረዦች ሲኖሩትstringበሞጁሉ የተያዙ የሁሉም ሰንጠረዦች ስም መጀመሪያ። ቢያንስ 3 ቁምፊዎች እና በ_ መጨረስ አለበት። የCelerp ውስጣዊ ሰንጠረዦችን መሸፈን የለበትም፤ label_፣ marketplace_ እና bank_ ተይዘዋል። ከሌላ የተጫነ ሞጁል ቅድመ ቅጥያ ጋርም መደራረብ የለበትም፣ አንዱ የሌላው መጀመሪያ ቢሆንም። ከCelerp 2.5.4 ጀምሮ ቁልፉ በሚኖርበት ሁሉ ደንቡ ይሠራል፣ migrations ቢኖርም ባይኖርም፤ None ይከለከላል። የቆዩ ስሪቶች migrations ሲኖር ብቻ ያረጋግጣሉ። ሰንጠረዥ ከሌለ ቁልፉን ይተዉ።
migrationsNoበነጥብ የተለየ የጥቅል መንገድበPostgreSQL ላይ ሲጀምር የሚሠሩ የውሂብ መዋቅር ለውጥ ፋይሎች አቃፊ። table_prefix ያስፈልጋል።
company_backupሞጁሉ ሰንጠረዦች ሲኖሩትdictእያንዳንዱን የሰንጠረዥ ስም ከ"include" ወይም "exclude" ጋር ያዛምዱ። ሰንጠረዦች፣ የመዋቅር ለውጦች እና ምትኬዎችን ይመልከቱ።
localesNodictየትርጉም ፋይሎች። ትርጉሞችን ይመልከቱ።

ሞጁል ለመጫን name እና version ብቻ ግዴታ ናቸው። lint.py ደግሞ display_name እና licenseን ይጠይቃል፣ በዝርዝር ለማስገባትም ያስፈልጋሉ። በቆዩ ምሳሌዎች ያሉ icon፣ min_role፣ requires እና soft_depends አይነበቡም። Celerp ለሞጁሎች የPython ጥቅሎችን አይጭንም፤ ሞጁል በCelerp ጭነት ውስጥ አስቀድሞ ያለውን ብቻ ማስመጣት ይችላል።

ማስገቢያ ቦታዎች

slots የማስገቢያ ቦታ ስምን ሞጁሉ በዚያ ከሚጨምረው ጋር ያዛምዳል። ዝርዝር የሚቀበል ቦታ አንድ dictionary መቀበልም ይችላል። ከinventory_in_production በስተቀር ማንኛውም ሞጁል ማንኛውንም ቦታ ሊጠቀም ይችላል፤ ይህ ቦታ ለCelerp ውስጣዊ ሞጁሎች ብቻ ነው። Celerp የማያውቀው የቦታ ስም ስህተት ነው፤ ኮድ ከመስራቱ በፊት ያለው ፍተሻ manifestን ይከለክላል እና ሞጁሉ አይጫንም። ከታች በሰንጠረዥ ያሉትን ስሞች ብቻ ይጠቀሙ፤ lint.py ሌሎችን ያሳውቃል።

የማስገቢያ ቦታ ግቤት permission ሊኖረው ይችላል፣ ይህም ከየፈቃዶች ዝርዝር የሚወሰድ ቁልፍ ነው። ከCelerp 2.5.4 ጀምሮ ጫኚው በሁሉም ቦታዎች ውስጥ ያሉ ግቤቶችን ይፈትሻል፤ ከሚከተሉት ደንቦች አንዱን የሚጥስ ሞጁል አይጫንም። እያንዳንዱ ግቤት dictionary መሆን አለበት፤ permission እና write_permission ከዝርዝሩ ቁልፎች መሆን አለባቸው፤ requires_connector ካለ ሕብረቁምፊ መሆን አለበት፣ ያልታወቀ የአገናኝ መለያ ግቤቱን ይደብቃል፤ Celerp የሚያገናኘው መድረሻ (nav ውስጥ href እና settings_href፣ bulk_action ውስጥ form_action፣ item_action ውስጥ href_template) በአንድ / የሚጀምር ውስጣዊ መንገድ ሆኖ የተገላቢጦሽ ሰረዝ ወይም የመቆጣጠሪያ ቁምፊ ሊኖረው አይገባም፤ handler ወይም render በሞጁሉ ፋይሎች ውስጥ ያለ ተግባር መጠቆም አለበት፣ በሰንጠረዡ የተጠቀሰበትም ቦታ በትክክል async def መሆን አለበት። ተጣርተው የሚታዩ ግቤቶች ፈቃድ ከሌላቸው ሚናዎች እና ሞጁሉን ካጠፉ ኩባንያዎች ይደበቃሉ። ቁልፍን መደበቅ የፈቃድ ጥበቃ አይደለም፤ የሚጠራው መንገድም ፈቃዱን መፈተሽ አለበት።

ማስገቢያ ቦታቁልፎችተግባሩ
navkey፣ label፣ label_key፣ href፣ order (መደበኛ 99፣ ዝቅተኛ ቀድሞ ይደረደራል)፣ group፣ permission፣ settings_hrefበጎን ምናሌ ውስጥ የሚጨመር ግቤት፣ group ካለ በዚያ ስር ይሆናል። label_key ይተረጎማል፤ label የሚጠቀመው label_key ከሌለ ነው። key ገጹ እንደ nav_active የሚያስተላልፈው እሴት ነው፣ ግቤቱንም ያበራል። settings_href በቡድን ርዕስ ላይ የቅንብር አገናኝ ያክላል። በፈቃድ ይጣራል።
search_providerhandler፣ result_key፣ permission፤ ሦስቱም ግዴታ ናቸውወደ አጠቃላይ ፍለጋ ውጤቶችን ይጨምራል። handler በ"package.module:function" ቅርጸት async def search(session, company_id, role, q, limit=5)ን ይጠቁማል፣ እሱም {result_key: [rows]} ይመልሳል። result_key የ"items" ወይም "entries" እሴት ነው። እያንዳንዱ ረድፍ {"id", "label", "href", "subtitle"} ነው፤ subtitle አማራጭ ነው፣ href ውስጣዊ መንገድ ነው። ሲሳካ ካልሆነ ባዶ ዝርዝር ከመመለስ ይልቅ ስህተት ያስነሱ። በእያንዳንዱ ሞጁል አንድ ብቻ ይፈቀዳል፤ ተጨማሪ ቁልፍ ካለ ሞጁሉ አይጫንም። በሞጁሉ ፋይሎች ውስጥ ያለ handler ተግባር async def ካልሆነም መጫኑን ያስቆማል። በፈቃድ ይጣራል።
bulk_actionform_action (ግዴታ)፣ label ወይም label_key፣ permission፣ requires_connector፣ action_typeበእቃ ዝርዝር ውስጥ ለተመረጡ እቃዎች የሚታይ ቁልፍ። ወደ form_action የሚሄድ POST የተመረጡትን እቃዎች መለያ በተደጋጋሚ selected መስክ ይልካል። በመደበኛነት ጥያቄው በዚያው ገጽ ይከናወናል፣ የHTML ምላሽም bulk-action-result መለያ ያለውን ክፍል ይተካል። በaction_type: "navigate" ግን POST ወደ አዲስ ትር ይላካል። requires_connector አገናኙ ሲዘጋጅ ብቻ ያሳየዋል። በፈቃድ ይጣራል።
item_actionhref_template፣ label ወይም label_key፣ permissionበእቃ ዝርዝር ገጽ ላይ አገናኝ። {entity_id} በhref_template ውስጥ በእቃው መለያ ይተካል። ከCelerp 2.5.4 ጀምሮ href_template በአንድ / የሚጀምር ውስጣዊ መንገድ መሆን አለበት፣ ተገላቢጦሽ ሰረዝና የመቆጣጠሪያ ቁምፊ ሊኖረው አይችልም፣ ቅንፎችም በ{entity_id} ዙሪያ ብቻ ይፈቀዳሉ። ደንቡን የሚጥስ ሞጁል አይጫንም። ከ2.5.4 ጀምሮ በፈቃድ ይጣራል፤ የቆዩ ስሪቶች ለሁሉም ያሳዩታል። በሁለቱም ሁኔታዎች የመድረሻ ገጹ ፈቃድን መፈተሽ አለበት።
doc_detail_actions, doc_detail_badgesrender, permissionበሰነድ ዝርዝር ገጽ ላይ የሚጨመሩ ቁልፎች ወይም ምልክቶች። render በ"package.module:function" ቅርጸት ይሆናል፣ ሰነዱን እንደ dictionary ተቀብሎ የFastHTML ክፍል ወይም None ይመልሳል። በስህተት ጊዜ ሙሉ ገጹን ከማስቆም ይልቅ ክፍሉን ይደብቃል። ከCelerp 2.5.4 ጀምሮ እንደ item_action በፈቃድ ይጣራል፤ የቆዩ ስሪቶች ለሁሉም ያሳዩታል። የመድረሻ ገጹ ሁልጊዜ ፈቃድን መፈተሽ አለበት።
category_schemacategory, fieldsኩባንያ የራሱን እሴቶች እስኪያስቀምጥ ድረስ ለእቃ ምድብ የሚጠቀሙ መደበኛ ባህሪ መስኮች።
on_company_createdhandlerኩባንያ ሲፈጠር የሚጠራ async def handler(session, company_id)። ስህተት ከተፈጠረ ይመዘገባል፣ የራሱ የውሂብ ጎታ ለውጦች ይመለሳሉ፣ የኩባንያ ፍጠር ግን ይቀጥላል።
on_modules_readyhandlerሁሉም ሞጁሎች ከተጫኑና ውሂብ ከተዘመነ በኋላ በAPI ጅማሬ አንዴ የሚጠራ async def handler(session)። ስህተቱ ይመዘገባል፣ የራሱ የውሂብ ጎታ ለውጦች ይመለሳሉ፣ ጅማሬው ግን ይቀጥላል።
pricing_actionhref_template (ግዴታ)፣ label ወይም label_key፣ permission፣ requires_connector፣ show_on፣ presentationበእቃው የዋጋ ትር ላይ ለእያንዳንዱ የዋጋ ዝርዝር ረድፍ አገናኝ። href_template በአንድ / የሚጀምር፣ ተገላቢጦሽ ሰረዝና የመቆጣጠሪያ ቁምፊ የሌለው የCelerp ውስጣዊ መንገድ መሆን አለበት። {entity_id}፣ {price_list} (የዋጋ ዝርዝሩ ስም) እና {field_name} (እንደ retail_price ያለ ዋጋውን የያዘ የእቃ መስክ) ሊጠቀም ይችላል። እያንዳንዱ እሴት ለURL ይመሰጠራል፤ ሌላ ተለዋዋጭ፣ ያልተዛመደ ቅንፍ ወይም ያልተዘረዘረ ቁልፍ ሞጁሉን እንዳይጫን ያደርጋል። show_on የረድፍ ባህሪያት ዝርዝር ነው፤ ሁሉም ሲሟሉ ብቻ አገናኙ ይታያል፤ editable ወይም readonly (ለአሁኑ ተጠቃሚ)፣ sell ወይም cost፣ manual ወይም derived (ከሌላ ዝርዝር የተሰላ)። ለሁሉም ረድፎች እንዲታይ ቁልፉን ይተዉ። ሌላ እሴት ወይም ከአንድ ጥንድ ሁለቱን መጠቀም መጫንን ያስቆማል። presentation ካለ "page" ብቻ መሆን አለበት፤ የእርስዎን ገጽ ይከፍታል። requires_connector አገናኙ ሲዘጋጅ ብቻ ያሳያል። Celerp 2.5.4 ወይም ከዚያ በላይ ያስፈልጋል፤ የቆዩ ስሪቶች ይህን ቦታ ስለሚያልፉ min_celerp_versionን "2.5.4" ያድርጉ። በፈቃድ ይጣራል።

የCelerp ውስጣዊ ሞጁሎችም send_to_targets፣ catalog_channel፣ projection_handler፣ doc_finalize_hook፣ on_doc_payment፣ inventory_in_production እና item_lineage_guard ይጠቀማሉ። inventory_in_production ለውስጣዊ ሞጁሎች ብቻ ነው፤ ሌሎች ቢሞሉት Celerp ይከለክላቸዋል። ሌሎቹ ተመሳሳይ የግቤት ደንቦችን ይከተላሉ፤ የprojection_handler ግቤት የክስተት አይነቱን prefix እና መደበኛ handler ተግባር ይገልጻል፤ የdoc_finalize_hook እና on_doc_payment ተግባሮች ግን async def ናቸው። ለእያንዳንዱ የክስተት አይነት አንድ ተቆጣጣሪ ብቻ ነው። ስለዚህ አንድ የprojection ቅድመ ቅጥያ የሌላው መጀመሪያ መሆን የለበትም፤ በራሱ ሞጁል፣ በሌላ ንቁ ሞጁል ወይም ከCelerp sys.፣ mp. እና shop.sync. ጋር። ቅድሚያ ውስጣዊ ሞጁሎች ቦታቸውን ይይዛሉ፣ ከዚያ ሌሎች በስም ቅደም ተከተል ይይዛሉ።

ፈቃዶች

ፈቃዶች የተወሰነ ዝርዝር ናቸው። ሞጁል የራሱን ፈቃድ ማከል አይችልም፣ የCelerpን ተመሳሳይ ቁልፎች ይጠቀማል፤ ስለዚህ የኩባንያው የሚና ቅንብሮች የሞጁሉንም ባህሪያት ይቆጣጠራሉ። የAPI መንገዶችን በrequire_permission("key") ከcelerp.services.permissions ይጠብቁ፣ እንደ ምሳሌው። በhandler ውስጥ ያለው role_has_permission(company_settings, role, "key") ከዚያው ጥቅል እውነት/ሐሰት ይመልሳል። በUI ገጽ ውስጥ roleን እና ቅንብሮችን ከGET /companies/me (የcurrent_role እና settings መስኮች) ይውሰዱ፣ ከመግቢያ cookie አይደለም። ፍተሻው ሲሳካ ብቻ የተጠቃሚ መቆጣጠሪያ ያሳዩ።

ክፍልቁልፎች
ማየትview_dashboards, view_documents, view_contacts, view_inventory, view_inventory_costs, view_payments, view_financial_reports, view_subscriptions
ሰነዶችedit_documents, finalize_documents, fulfill_documents, delete_documents, set_sales_doc_prices, record_payments
ዕውቂያዎችedit_contacts
የዕቃ ክምችትedit_inventory, edit_inventory_amounts, set_inventory_prices, adjust_inventory, revert_items_to_draft, manage_labels, manage_manufacturing
ሂሳብ አያያዝmanage_accounting
ውሂብና መሣሪያዎችimport_export_data, run_backups, use_ai_assistant
አስተዳደርmanage_module_settings, manage_users, manage_company_settings, manage_integrations
ለኩባንያ ባለቤት ብቻmanage_permissions, manage_company_lifecycle, manage_billing

ለሞጁልዎ የቅንብር ገጽ manage_module_settingsን ይጠቀሙ።

ሰንጠረዦች፣ የመዋቅር ለውጦች እና ምትኬዎች

የሞጁሉ ሰንጠረዦች ከcelerp.models.base.Base ይወርሳሉ እና ከCelerp ጋር በአንድ የውሂብ ጎታ ውስጥ ይኖራሉ። ለእያንዳንዱ ሰንጠረዥ company_id አምድ ያክሉ እና ሁሉንም ጥያቄዎች በዚህ ያጣሩ።

የመዋቅር ለውጦች

  • ሲጀምር ሞጁሎች ከመጫናቸው በፊት Celerp በእያንዳንዱ ንቁ ሞጁል migrations አቃፊ ውስጥ ያሉትን ፋይሎች በስም ቅደም ተከተል ያስኬዳል። በ_ የሚጀምሩ ፋይሎችን ይዘላል። መከናወን በሚገባቸው ቅደም ተከተል እንዲደረደሩ ስም ይስጡ፣ ለምሳሌ ከሞጁሉ ስም በኋላ ቁጥር።
  • እያንዳንዱ ፋይል upgrade()ን ይገልጻል፣ opን ከalembic (op.create_table፣ op.add_column ወዘተ) ይጠቀማል። downgrade() ወይም የrevision ሰንሰለት የለም።
  • Celerp ከዚህ በፊት የተሠሩ ፋይሎችን አይመዘግብም። እያንዳንዱ ፋይል በእያንዳንዱ ጅማሬ ይሠራል፤ ስለዚህ እንደ sa.inspect(op.get_bind()) ምሳሌው ከእርምጃው በፊት አስፈላጊነቱን ያረጋግጡ።
  • op.create_table፣ drop_table፣ add_column፣ drop_column፣ alter_column፣ create_index፣ drop_index እና rename_table ከሞጁሉ table_prefix ውጭ ባለ ሰንጠረዥ ላይ ለውጥ አይፈቅዱም። ይህ ስህተቶችን ይይዛል፣ ግን sandbox አይደለም። ከCelerp 2.5.4 ጀምሮ ቅድመ ቅጥያው በmanifest ማጣቀሻ ያሉትን ደንቦች ከጣሰ ምንም የመዋቅር ለውጥ አይከናወንም፣ ሞጁሉም የወደቀ ይሆናል፣ በእጅ ወደ ሞጁል አቃፊ ቢቀዳም።
  • የመዋቅር ለውጥ ከወደቀ ለውጦቹ ይመለሳሉ፣ ሞጁሉ በዚያ ጅማሬ አይጫንም፣ ስህተቱም በሞጁሎች ገጽ ይታያል። የCelerp ቀሪ ክፍሎች መደበኛ ሁኔታ ይጀምራሉ። እያንዳንዱ የSQL ትዕዛዝ የመቆለፊያ ጥበቃን ጨምሮ 30 ሰከንድ ብቻ አለው።
  • የመዋቅር ለውጦች Celerp በሚጠቀምበት PostgreSQL ላይ ይሠራሉ። በሌሎች የውሂብ ጎታዎች ላይ ይዘለላሉ።
  • ሞጁሎች ከተጫኑ በኋላ Celerp ገና የሌሉ የmodel ሰንጠረዦችን ይፈጥራል። ስለዚህ አዲስ ሰንጠረዥ ያለ migration ሊፈጠር ይችላል፣ ነገር ግን ቀድሞ የተለቀቀ ሰንጠረዥ ለመቀየር migration ያስፈልጋል።

የኩባንያ ምትኬዎች

ከCelerp 2.5.4 ጀምሮ ምትኬው company_id አምድ ያለው ግን አያያዙን መወሰን የማይችልበት ሰንጠረዥ ካገኘ የኩባንያ ምትኬ መሥራትን ይከለክላል። የሞጁሉን ቅድመ ቅጥያ ያላቸው ሰንጠረዦች ሁልጊዜ ይፈተሻሉ። ተመሳሳይ ቅድመ ቅጥያ እና company_id አምድ የሌለው ሰንጠረዥ ያለ ማስጠንቀቂያ ይቀራል። ስለዚህ ሞጁሉ ሰንጠረዦች ካሉት፦

  • table_prefix ያዘጋጁ እና ሁሉንም የሰንጠረዥ ስሞች በዚያ ያስጀምሩ። ከCelerp 2.5.4 ጀምሮ ደንብ የሚጥስ ወይም ከሌላ ሞጁል ጋር የሚደራረብ ቅድመ ቅጥያ ምንም ሰንጠረዥ አይይዝም፤ ምትኬውም ይከለከላል።
  • ሁሉንም ሰንጠረዦች በcompany_backup ውስጥ "include" (በምትኬ የሚካተት የኩባንያ ውሂብ) ወይም "exclude" (በራሱ እንደገና የሚፈጠር cache ወዘተ) ብለው ይዘርዝሩ። ያልተዘረዘረ ሰንጠረዥ ስሙን የሚጠቅስ ስህተት አስከትሎ ምትኬውን ያስቆማል።
  • በምትኬ የሚካተት ሰንጠረዥ company_id አምድ እና አንድ የUUID ወይም የጽሑፍ ዋና ቁልፍ፣ ወይም company_idን ተከትሎ አንድ የጽሑፍ አምድ ያለው የተቀናጀ ዋና ቁልፍ ሊኖረው ይገባል። የውጭ ቁልፍ ወደ companies ሰንጠረዥ ወይም ሌላ በምትኬ የተካተተ ሰንጠረዥ ብቻ መጠቆም አለበት።

ውሂብ ማስወገድ

በሞጁሎች ገጽ ላይ የጭነቱ ባለቤት ያለው ሰርዝና ውሂቡን አጽዳ ሞጁሉን ያስወግዳል እና ስማቸው በሞጁሉ table_prefix የሚጀምሩ ሰንጠረዦችን ሁሉ ይሰርዛል። ማንኛውም ኩባንያ ሞጁሉን ካነቃ ወይም የመጨረሻው ኩባንያ ካጠፋው በኋላ Celerp እስኪጀመር እርምጃው ይከለከላል። ከCelerp 2.5.4 ጀምሮ ቅድመ ቅጥያው ደንቦችን ከጣሰ ወይም ከCelerp ሰንጠረዦች ወይም ከሌላ ሞጁል ቅድመ ቅጥያ ጋር ከተጋጨ ምንም ሳይሰረዝ ይከለከላል። table_prefix የሌለው ሞጁል የሚሰረዝ ሰንጠረዥ የለውም። የእርስዎ ሰንጠረዦች ብቻ የሚጠቀሙበትን ቅድመ ቅጥያ ይምረጡ።

ትርጉሞች

locales የቋንቋ ኮድን በሞጁሉ አቃፊ ውስጥ ካለ ፋይል እና ቋንቋው ከቀኝ ወደ ግራ ይጻፋ እንደሆነ ጋር ያዛምዳል፦

"locales": {
    "en": {"file": "locales/en.json", "rtl": False},
    "th": {"file": "locales/th.json", "rtl": False},
}

እያንዳንዱ ፋይል ቁልፍና ጽሑፍ ያያዘ አንድ ጠፍጣፋ የJSON ነገር ነው። በUI ኮድ ውስጥ t("key") ከui.i18n ጽሑፉን በተጠቃሚው ቋንቋ ይመልሳል፤ ካልነበረ በእንግሊዝኛ፣ ያም ካልነበረ ቁልፉን ራሱ ይመልሳል። የምናሌ ግቤት label_key እንዲሁ ይተረጎማል። Celerp ቁልፉን አስቀድሞ ካወቀ የCelerp ጽሑፍ ቅድሚያ አለው፤ ስለዚህ ሁሉንም ቁልፎች በሞጁልዎ ስም ያስጀምሩ። የተበላሸ ግቤት ይመዘገባልና ይታለፋል፣ ሞጁሉ ግን ይጫናል።

በልማት ጊዜ ማስኬድ

እውነተኛ ውሂብ ያለበትን ሳይሆን ማቆምና ማስጀመር የሚችሉትን፣ ለብቻው ኩባንያ ያለውን የCelerp ጭነት ይጠቀሙ። Celerp የሞጁል ኮድን ሲጀምር አንዴ ያነባል፤ ስለዚህ ለእያንዳንዱ ለውጥ እንደገና ማስጀመር ያስፈልጋል።

በትዕዛዝ መስመር ጭነት

  1. Celerpን ይጫኑ እና ለልማት የውሂብ አቃፊ ይምረጡ፦
    pip install celerp
    export CELERP_DATA_DIR="$HOME/celerp-dev"
    export CELERP_CONFIG="$HOME/celerp-dev/config.toml"
  2. ሞጁሉን በውሂብ አቃፊ ውስጥ ባለው modules አቃፊ ያስገቡ፦
    mkdir -p "$CELERP_DATA_DIR/modules"
    cp -r acme-notes "$CELERP_DATA_DIR/modules/"
  3. celerp init --embeddedን ያስኬዱ። የተለየ የውሂብ ጎታ ያዘጋጃል እና Celerpን ያስጀምራል። የታተመውን አገናኝ ይክፈቱ፣ የባለቤት መለያ እና ኩባንያ ይፍጠሩ፣ ከዚያ በጎን ምናሌ ውስጥ ሞጁሎችን ይክፈቱ። ሞጁልዎ እዚያ ይታያል፤ ያንቁት።

    በmacOS ላይ በቅድሚያ pip install celerp-postgresን ያስኬዱ (macOS 26 ወይም ከዚያ በላይ)። ወይም ያለ PostgreSQL ይጠቀሙ፤ ባዶ የውሂብ ጎታ ይፍጠሩና celerp init --db-url postgresql://user:password@localhost/celerp_devን በcelerp init --embedded ፋንታ ያስኬዱ።

  4. Celerpን በCtrl+C ያቁሙና celerp startን ያስኬዱ። የሞጁሉ ግቤት አሁን በጎን ምናሌ ይታያል።

ከዚያ በኋላ በ$CELERP_DATA_DIR/modules/acme-notes ያሉትን ፋይሎች ያርትዑና እንደገና ያስጀምሩ። Celerpን በሚያስጀምሩበት እያንዳንዱ shell ውስጥ CELERP_DATA_DIR እና CELERP_CONFIG ይወሰኑ። ያለእነሱ Celerp በማሽኑ ላይ የተጫነ ሌላ Celerp ቅንብርና የውሂብ ጎታ ሊጠቀም ይችላል።

በዴስክቶፕ መተግበሪያ

የሞጁሉን አቃፊ በመተግበሪያው modules አቃፊ ውስጥ ያስቀምጡ፣ በሞጁሎች ገጽ ያንቁት እና መተግበሪያውን እንደገና ያስጀምሩ፦

  • macOS: ~/Library/Application Support/Celerp/celerp-data/modules/
  • Linux: ~/.config/Celerp/celerp-data/modules/
  • Windows: %APPDATA%\Celerp\celerp-data\modules\

ይህ አቃፊ የCelerp ውስጣዊ ሞጁሎችንም ይይዛል። እነሱን አይቀይሩ።

ሞጁሉ ካልተጫነ

የሦስተኛ ወገን ሞጁል መጫን ቢወድቅ Celerp አይቆምም። ከCelerp 2.5.4 ጀምሮ Celerp የነቃ ሞጁል ኮድ ከመሥራቱ በፊት ፋይሎቹን ይፈትሻል፤ ፍተሻውን ካላለፈ የመዋቅር ለውጦችን ጨምሮ ምንም አይሠራም። ካለፈ ግን ለውጦቹና ኮዱ በCelerp ሂደት ውስጥ ይሠራሉ። ፍተሻው ስህተቶችን ይይዛል፣ ያልታመነ ኮድን ግን ደህንነቱ የተጠበቀ አያደርገውም። የሞጁል መንገዶች በጅማሬ ከወደቁ ሞጁሉ በAPI እና UI ይጠፋል፣ በእሱ ላይ የተመሠረቱትም ሞጁሎች ይጠፋሉ። የሞጁሎች ገጽ ምክንያቱን ያሳያል፤ የmanifest ስህተት፣ ያልታወቀ የslot ስም፣ የጎደለ depends_on ሞጁል፣ ያልተሟላ min_celerp_version፣ ደንብ የሚጥስ የslot ግቤት፣ ለውስጣዊ ሞጁሎች የተመደበ slot፣ የሚደራረብ projection ቅድመ ቅጥያ፣ ከሞጁል አቃፊ ውጭ ያለ route ወይም setup ተግባር፣ ከቅድመ ቅጥያው ውጭ ሰንጠረዥ፣ ከCelerp ወይም ሌላ ሞጁል ጋር የሚጋጭ route ወይም package ስም፣ የተከለከለ import፣ በኮድ ውስጥ import ስህተት፣ ያልተጀመረ route ወይም የወደቀ migration። ከዳግም ጅማሬ በፊት lint.pyን ያስኬዱ።

ሞጁሉን ይፈትሹ

አብነቱ ሁለት አይነት ፍተሻዎች አሉት።

lint.py ሞጁሉን ሳያስገባ አቃፊውን ይፈትሻል፤ አስፈላጊ የmanifest መስኮች፣ ያልታወቁ ቁልፎችና Celerp የሚከለክላቸው የslot ስሞች፣ የሞጁል ስም ቁምፊዎችና የተያዘ ቅድመ ቅጥያ፣ የአቃፊ ስም፣ api_routes እና ui_routes በሞጁሉ ውስጥ የራሳቸው የsetup ተግባር ያለበትን ፋይል መጠቆማቸው፣ migrations ጥቅል በሞጁሉ ውስጥ መኖሩ፣ የmin_celerp_version ቅርጸት፣ ሁሉም የslot ግቤቶች ከ2.5.4 ጀምሮ በCelerp የሚተገበሩ ደንቦችን ማሟላታቸው (የሚደገፈው ስሪት ምንም ይሁን)፣ የmanifest ከፍተኛ ደረጃ መስኮች አይነት፣ የtable_prefix ቅርጸትና የCelerp ሰንጠረዥ እንዳይይዝ እና migrations ሲኖር መገለጹ፣ ሰንጠረዦች ሁሉ በcompany_backup መዘርዘራቸው፣ የተከለከሉ imports፣ እና የFastHTML ክፍሎች በstr() እንጂ በto_xml() አለመታየታቸው። Python ብቻ ያስፈልጋል። ሁለት አይነት ግኝቶችን ያሳያል፤ Celerp የሚከለክላቸውን ስህተቶችና የሚዘላቸውን የmanifest ክፍሎች። በሁለቱም የመውጫ ኮድ 1፣ ስህተት ከሌለ 0፣ መለኪያዎች የተሳሳቱ ከሆነ 2 ይመልሳል። እንደ የተለየ ማስጌጫ ያለውን handler ሳያስኬድ መከታተል ካልቻለ ከመገመት ይልቅ ይከለክላል። የሌሎች የተጫኑ ሞጁሎችን ቅድመ ቅጥያዎች ማየት ስለማይችል የprojection ቅድመ ቅጥያዎችን በራሳቸውና በCelerp ውስጣዊ ቅድመ ቅጥያዎች ብቻ ያነጻጽራል።

python lint.py path/to/acme-notes

የሞጁሉ ፈተናዎች የራሱን API እና UI መንገዶች በSQLite ላይ በሙከራ መተግበሪያዎች ያስኬዳሉ፣ የCelerp መግቢያና ኩባንያ አገናኞች የሙከራ ምትክ ይሆናሉ። የገጽ ጥያቄ እውነተኛ የገጽ ማቅረብ፣ API ጥሪና ወደ ውሂብ ጎታ ጽሑፍ ማስገባት ያከናውናል። የአብነቱን ፈተናዎች ለማስኬድ የCelerp ምንጭ ኮድ ከአብነቱ አጠገብ በ.github/workflows/ci.yml የተወሰነው ትክክለኛ commit ላይ ያስቀምጡ። ፈተናዎቹ ለዚያ የተጻፉ ናቸው፤ በሌላ commit ላይ ከሞጁሉ ጋር ያልተያያዘ ፍተሻ ሊወድቅ ይችላል፦

git clone https://github.com/celerp/celerp.git
git clone https://github.com/celerp/celerp-module-template.git
grep ref: celerp-module-template/.github/workflows/ci.yml
git -C celerp checkout COMMIT_FROM_THE_LINE_ABOVE
pip install -e ./celerp
pip install pytest pytest-xdist aiosqlite
cd celerp-module-template
python lint.py acme-maintenance
pytest tests
PYTHONPATH=../celerp:acme-maintenance pytest acme-maintenance/tests

pytest tests የlint.py መሣሪያውን ራሱን ይፈትሻል። የመጨረሻው ትዕዛዝ የሞጁሉን ፈተናዎች ያስኬዳል። እንዲሁ ለመፈተሽ acme-maintenance/tests/conftest.pyን ወደ ሞጁልዎ tests አቃፊ ይቅዱ። በፋይሉ መጀመሪያ ላይ ሦስት ማስተካከያዎች ተጠቅሰዋል፤ ከላይ ያሉ imports፣ MODULE_TABLE_PREFIX እና ገጾችዎ ሌላ የኩባንያ መስክ ካነበቡ የሙከራ ኩባንያው። ፈተናዎቹ ባዶ ሁኔታ፣ API አለመገኘት፣ ፈቃድ መከልከል እና አንድ ኩባንያ የሌላውን ውሂብ አለማየት እንዴት እንደሚፈተሽ ያሳያሉ።

የተጠናቀቀ ሞጁል መጫን

የጭነቱ ባለቤት በሞጁሎች ገጽ ላይ ሞጁል አስገባ በመምረጥ ZIP ፋይል ወይም አቃፊ ያስገባል። የማስገባቱ ሂደት ኮድ ሳያስኬድ ፋይሎችን ያነባል እና የሚከተሉትን ይፈትሻል፦

  • ZIP ከ50 MB ያልበለጠ እና ከተፈታ በኋላ ከ200 MB ያልበለጠ መሆን አለበት። ምልክታዊ አገናኞች ይከለከላሉ።
  • ስሙ የmanifest ማጣቀሻ ደንቦችን የሚከተል እና አስቀድሞ ያልተጫነ መሆን አለበት። ስሪት ለመተካት መጀመሪያ አሮጌውን ያስወግዱ።
  • የሚሠራው Celerp ከmin_celerp_version ጋር እኩል ወይም ከዚያ በላይ መሆን አለበት።
  • migrations ያለው ሞጁል table_prefix መወሰን አለበት። የተወሰነ table_prefix ህጋዊ መሆን እና ከCelerp ሰንጠረዦች ወይም ከሌላ ሞጁል ቅድመ ቅጥያ ጋር አለመጋጨት አለበት።

ማስገባት ብቻውን ሞጁሉን አያነቃም። የኩባንያው አስተዳዳሪ በዚያው ገጽ ለዚያ ኩባንያ ያነቃዋል። ከዚያ በፊት ማንም ኩባንያ ካልተጠቀመበት፣ የጭነቱ ባለቤት Celerpን እንደገና ካስጀመረ በኋላ ይሠራል።

ማን ምን ማድረግ ይችላል?

አንድ የCelerp ጭነት ብዙ ኩባንያዎችን ሊይዝ ይችላል፣ የተጫነ ሞጁል ኮድም ለሁሉም ይሠራል። ስለዚህ ጭነቱን ራሱን የሚቀይሩ እርምጃዎችን የጭነቱ ባለቤት ብቻ ያከናውናል፤ ይህም ጭነቱን ያዘጋጀው መለያ ወይም በተጠቃሚዎች ገጽ ይህ ሚና የተሰጠው ተጠቃሚ ነው። የኩባንያ አስተዳዳሪዎች ቀድሞ የተጫኑ ሞጁሎችን ለራሳቸው ኩባንያ ብቻ ያስተዳድራሉ፤ ለዚህ manage_company_settings ፈቃድ ያስፈልጋል።

እርምጃማን ይፈቀድለታል
ሞጁል ማስገባት ወይም ከMarketplace ገዝቶ መጫንየጭነቱ ባለቤት
ሞጁልን ውሂቡን በማቆየት መሰረዝ ወይም ከውሂቡ ጋር ማጥፋትየጭነቱ ባለቤት
Celerpን እንደገና ማስጀመርየጭነቱ ባለቤት
ለኩባንያ የተጫነ ሞጁልን ማንቃት ወይም ማጥፋትየዚያ ኩባንያ አስተዳዳሪዎች

እያንዳንዱ ኩባንያ በሞጁሎች ገጽ ላይ ሞጁሎቹን ይመርጣል። ዝርዝሩን እስኪቀይር ድረስ በጭነቱ ውስጥ የነቁትን ሞጁሎች ሁሉ ይጠቀማል። ቢያንስ አንድ ኩባንያ ሞጁልን ሲያነቃ Celerp ሞጁሉንና ጥገኛ ሞጁሎቹን ይጭናል። ለአንድ ኩባንያ ማንቃት ጥገኛዎቹንም በዚያ ኩባንያ ያነቃል። በዚያው ኩባንያ ያለ ሌላ ሞጁል የሚፈልገውን ሞጁል መጀመሪያ ያንን ሞጁል ሳያጠፉ ማጥፋት አይቻልም። ማጥፋት ያለ ዳግም ጅማሬ ወዲያውኑ ይሠራል፤ ኩባንያው የሞጁሉን ገጾች፣ ምናሌዎች፣ ቁልፎች ወይም የፍለጋ ውጤቶች አያይም፣ መንገዶቹም የዚያን ኩባንያ ጥያቄዎች ይከለክላሉ፣ ሌሎች ኩባንያዎች ሞጁሉን ቢጠቀሙም። ፈቃድ የሌላቸው እርምጃዎች መቆጣጠሪያ አይታይም፣ በቀጥታ ሲሞከርም ይከለከላል። የራስዎን ሞጁል ቁልፎች መደበቅ ብቻ አይበቃም፤ መንገዱን በrequire_permission ይጠብቁ።

የሞጁል API

celerp.modules.api ለሞጁሎች ኮድ የተዘጋጀው ይፋዊ መገናኛ ነው። ከCelerp 2.5.4 ጀምሮ ሦስት አጋዥ ተግባሮች አሉት፦

  • await api_request(request, method, path, *, json=None, params=None) የCelerp ውስጣዊ APIን በrequest የገባው ተጠቃሚ ስም ይጠራል እና httpx.Response ይመልሳል። path እንደ /companies/me ያለ የCelerp ውስጣዊ መንገድ ነው። Celerp አድራሻውን፣ መግቢያውንና የተወሰነ የጊዜ ገደብ ያዘጋጃል፤ ሌላ መድረሻ ይከለክላል። JSON ውሂብ ወይም የጥያቄ መለኪያዎች ብቻ ስለሚላኩ ፋይልን በJSON ውስጥ base64 በማድረግ ይላኩ።
  • read_resource(module_file, relative_path) ከሞጁሉ ጋር የመጣ ፋይል ባይቶችን ይመልሳል። አንጻራዊ መንገዱ ከሚመነጭበት ፋይል read_resource(__file__, "templates/invoice.html") ብለው ይጠሩት። ከዚያ ፋይል አቃፊ ወይም ከስሩ ብቻ ያነባል፤ መጻፍ አይችልም። ሞጁሉ የሚቀይረው ውሂብ በውሂብ ጎታ ወይም በCelerp ውሂብ አቃፊ መቀመጥ አለበት።
  • await ai_query(query, company_id, session_token=None, db_session=None) በCelerp AI አገልግሎት ጥያቄ ያስኬዳል እና answer፣ model_used እና tools_called ያለበትን dictionary ይመልሳል። የጥያቄውን የውሂብ ጎታ session በመጠቀም await ai_query(query, company_id, db_session=session) ብለው ይጠሩት። ጥያቄው የሚሠራው ለዚያ ጥያቄ ኩባንያ ብቻ እና AI ረዳትን ለመጠቀም ፈቃድ ላለው ሚና ብቻ ነው። የሞጁል AI APIን ይመልከቱ።

ለሁሉም ሞጁሎች ሦስት ደንቦች ይሠራሉ፦

  • አውታረ መረብ። Celerpን በapi_request ይድረሱ። ሌላ የአውታረ መረብ ጥሪ የሚያደርግ ሞጁል (የራሱ HTTP ደንበኛ፣ socket ወይም የሌላ አገልግሎት API) በCommunity ዝርዝር ከመግባቱ በፊት በCelerp ይመረመራል፣ በዝርዝሩም ጥሪዎቹ መገለጽ አለባቸው።
  • AI። ለሁሉም የAI ባህሪያት ai_queryን ይጠቀሙ። ገለልተኛ AI ግምት የሚፈቀድ ውህደት አይደለም፤ ሞዴል የሚያስኬድ ወይም የAI አገልግሎት በሌላ መንገድ የሚጠራ ሞጁል በዝርዝር አይቀበልም።
  • ጥገኛ ጥቅሎች። Celerp ለሞጁል ጥገኛ ጥቅሎችን አይጭንም። ሞጁሉ በCelerp ጭነት አስቀድሞ ያሉትን ጥቅሎች ይጠቀማል፣ requirements.txtንም አያካትትም፤ lint.py በሞጁሉ አቃፊ ውስጥ የትም ቢኖር ያሳውቃል።

ሞጁሎች በCelerp ሂደት ውስጥ ያለ sandbox ይሠራሉ፤ ስለዚህ እነዚህ ደንቦች በዝርዝር መግባታቸውን ይወስናሉ።

የሞጁል ኮድ ምን ማስመጣት ይችላል

ሞጁሎች በCelerp ሂደት ውስጥ እንደ Celerp ራሱ ውሂብና ፋይሎች የማግኘት ችሎታ አላቸው። ይፋዊ ክፍሎቹን ሊጠቀሙ ይችላሉ፦ celerp.db.get_session፣ በcelerp.services.auth ያሉ የማረጋገጫ ጥገኛ ተግባሮች፣ celerp.services.permissions፣ celerp.models.base.Base እና በui.components እና ui.i18n ያሉ የUI አጋዥ ተግባሮች። የሦስተኛ ወገን ሞጁል celerp.session_gate፣ celerp.ai ወይም በስሩ ያለ ነገር፣ celerp.gateway ወይም celerp.connectors ማስመጣት አይችልም፤ Celerp ይህን ሲያገኝ ሞጁሉን መጫን ይከለክላል። በምትኩ የሞጁል APIን ይጠቀሙ።

በዝርዝር ያስገቡት ወይም ይሽጡት

ምን እንደሚደርስበት ይግለጹ

የሞጁሉ ዝርዝር ሞጁሉ ምን እንደሚደርስበት በቀላል ቃላት ሊገልጽ ይችላል። እነዚህ በዝርዝሩ ውስጥ data_access እና network_calls መስኮች ናቸው፦

  • የውሂብ መዳረሻ፦ የሚነበብና የሚጻፍ የCelerp ውሂብ፣ ለምሳሌ «እቃዎችንና እውቂያዎችን ያነባል፤ በራሱ የማስታወሻ ሰንጠረዦች ላይ ይጽፋል»።
  • የአውታረ መረብ ጥሪዎች፦ የሚገናኝባቸው ሁሉም ውጫዊ አገልግሎቶችና የሚልከው ውሂብ፣ ወይም «የለም»።

እያንዳንዱ መግለጫ ከ500 ቁምፊዎች መብለጥ የለበትም። ሁሉም community እና verified ዝርዝሮች ሁለቱንም መያዝ አለባቸው። ተጠቃሚዎች ከመጫናቸው በፊት ያነቧቸዋል፤ ሙሉና ወቅታዊ ያድርጓቸው፣ በREADME መጀመሪያም ይድገሟቸው።

በነፃ በዝርዝር ያስገቡ

ሞጁሉን በራስዎ ይፋዊ የኮድ ማከማቻ ያትሙ፣ ከዚያ በcelerp/community-modules ላይ pull request ከፍተው ወደ index-v2.json አንድ ግቤት ይጨምሩ። በማከማቻው ያለው schema/index.schema.json ግቤቱን ይገልጻል እና ሌሎች መስኮችን ይከለክላል። የcommunity ግቤት id፣ name፣ description፣ tier (community)፣ author፣ license፣ repo፣ data_access እና network_calls ይፈልጋል፤ min_celerp_version፣ homepage፣ feedback እና እስከ ስድስት tags መጨመር ይቻላል። id በmanifest ውስጥ ያለው የሞጁል ስም ነው፤ ትንንሽ የላቲን ፊደላት፣ ቁጥሮችና ሰረዞች ብቻ ይኖሩት፣ በፊደል ወይም በቁጥር ይጀምር፣ ለምሳሌ acme-maintenance። versionን አያካትቱ፤ Celerp በማከማቻው ያለውን ይጭናል፣ ከመጫኑም በኋላ በሞጁሉ manifest ያለው ስሪት ይታያል። ለverified ግቤቶች verified_commit፣ sha256፣ price_monthly፣ price_once እና versionን የዝርዝሩ አስተዳዳሪ ይወስናል። የሞጁል ጥገኛዎች በዝርዝሩ አይገቡም፤ በmanifest ውስጥ depends_on ላይ ይቀራሉ። ምንጭ ኮዱ ሊነበብ ሲችል፣ ፈቃዱ ግልጽ ሲሆን፣ data_access እና network_calls ሲገለጹ፣ community ደረጃ ሲሆን version ሳይኖር፣ ID የተጠቀሱትን ቁምፊ ደንቦች ሲከተል፣ ስሙ በcelerp- ሳይጀምር፣ ሁሉም አገናኞች https ሲጠቀሙ እና ሞጁሉ lint.py እና የማከማቻውን scripts/validate_index.py ሲያልፍ ግቤቱ ይቀበላል።

ሞጁሉን ይሽጡ

የሚከፈልባቸው ሞጁሎች በCelerp Marketplace ይሸጣሉ። በcelerp.com/authors የGitHub መለያ ይግቡ፣ የStripe መለያ ያገናኙ፣ ሞጁሉንም በወርሃዊ ወይም በአንድ ጊዜ ዋጋ ያትሙ። Celerp ከእያንዳንዱ ሽያጭ 20% ይወስዳል። የሚከፈልበት ሞጁል የCelerpን የደህንነት ቅኝት ካለፈ በኋላ ሊጫን ይችላል። በኋላ ከዝርዝር ቢወገድ በአንድ ጊዜ የተገዛ ፈቃድ ይቆያል፣ ምዝገባም የተከፈለበት ጊዜ እስኪያበቃ ይቀጥላል። ሞጁሉ የእርስዎ ነው፤ እንደ ክፍት ምንጭ ፈቃድ ሊሰጡት ወይም ምንጩ የሚታይ የንግድ ፈቃድ ሊያደርጉት ይችላሉ።

የዝርዝር ደረጃዎች

ዝርዝሮች ከሦስት ደረጃዎች አንዱን ይይዛሉ፦ community ለራስዎ የሚያስተናግዱትና ተጠቃሚዎች ለሚጭኑት ሞጁል፣ verified በMarketplace ለሚሸጥ ሞጁል፣ official በCelerp ለሚገነባና ለሚጠበቅ ሞጁል።

ስሪቶችና ጥገኛ ሞጁሎች

min_celerp_versionን እርስዎ በፈተሹት በጣም የቆየ ስሪት ላይ ያድርጉ፣ ለምሳሌ "2.5.0"። ከዚያ በታች ባለ Celerp ማስገባት ይከለከላል እና የሚያስፈልገው ስሪት ይጠቀሳል። የCelerp የልማት ስሪቶች ይህን ፍተሻ ይዘላሉ።

Celerp ለሞጁል ጥገኛ ጥቅሎችን አይጭንም፤ የPython ጥቅሎችን የመጫኛ ደረጃ የለም፣ requirements.txtም ፈጽሞ አይነበብም። በCelerp ጭነት አስቀድሞ ያለውን ብቻ ይጠቀሙ።

depends_on የሌሎች ሞጁሎችን ስሞች ይዘረዝራል። Celerp እነሱን ቀድሞ ይጭናል። አንዱ ከጎደለ፣ ከጠፋ ወይም ከወደቀ ሞጁልዎ አይጫንም እና የሞጁሎች ገጽ የሚያስፈልገውን ሞጁል ይጠቅሳል።

የሞጁል መገናኛው በስሪቶች መካከል አሁንም ይለዋወጣል። ለአሁኑ ስሪት ይገንቡ እና ለውጦቹን የሚከታተለውን አብነት ይከተሉ።

እገዛ ማግኘት

በGitHub Discussions ይጠይቁ፣ ሌሎች የሞጁል ፈጣሪዎችም መልሱን እንዲያዩ። በይፋ መውጣት የሌለበትን ጉዳይ ወደ [email protected] በኢሜይል ይላኩ።