Documents

Contents

Build

モジュール概要

Project scaffolding and gateway config generation.

チュートリアル

最初に以下の最小例でモジュール利用方法を確認し、その後 API リファレンスを参照してください。

from pathlib import Path
from nexom.buildTools.build import start_project

start_project(project_root=Path('.'), main_name='app', auth_name='auth')

運用チェックリスト

  • 本番では例外処理を必ず実装し、戻り値の型を固定してください。
  • 引数のデフォルト値と必須/任意を仕様書としてチーム内で固定してください。
  • ログと監視を追加し、エラー時の復旧手順を運用Runbookに記載してください。

API リファレンス（全関数・全メソッド）

モジュール関数

_bootstrap_auth_master

分類: internal function

シグネチャ

_bootstrap_auth_master(*, project_root: Path, master_user: str, master_user_login_password: str) -> None

使い方と仕様

実装コード由来のAPIです。

引数

  • project_root / kind=keyword-only / type=Path / 必須 / default=なし
  • master_user / kind=keyword-only / type=str / 必須 / default=なし
  • master_user_login_password / kind=keyword-only / type=str / 必須 / default=なし

戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _bootstrap_auth_master

result = _bootstrap_auth_master(project_root="/path/to/value", master_user="sample", master_user_login_password="sample")
print(result)

_copy_from_package

分類: internal function

シグネチャ

_copy_from_package(pkg: str, filename: str, dest: Path) -> None

使い方と仕様

実装コード由来のAPIです。

引数

  • pkg / kind=positional-or-keyword / type=str / 必須 / default=なし
  • filename / kind=positional-or-keyword / type=str / 必須 / default=なし
  • dest / kind=positional-or-keyword / type=Path / 必須 / default=なし

戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _copy_from_package

result = _copy_from_package(pkg="sample", filename="sample", dest="/path/to/value")
print(result)

_read_text_from_package

分類: internal function

シグネチャ

_read_text_from_package(pkg: str, filename: str) -> str

使い方と仕様

実装コード由来のAPIです。

引数

  • pkg / kind=positional-or-keyword / type=str / 必須 / default=なし
  • filename / kind=positional-or-keyword / type=str / 必須 / default=なし

戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _read_text_from_package

result = _read_text_from_package(pkg="sample", filename="sample")
print(result)

_replace_many

分類: internal function

シグネチャ

_replace_many(text: str, repl: dict[str, str]) -> str

使い方と仕様

実装コード由来のAPIです。

引数

  • text / kind=positional-or-keyword / type=str / 必須 / default=なし
  • repl / kind=positional-or-keyword / type=dict[str, str] / 必須 / default=なし

戻り値

str

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _replace_many

result = _replace_many(text="sample", repl="sample")
print(result)

_validate_app_name

分類: internal function

シグネチャ

_validate_app_name(name: str) -> None

使い方と仕様

実装コード由来のAPIです。

引数

  • name / kind=positional-or-keyword / type=str / 必須 / default=なし

戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _validate_app_name

result = _validate_app_name(name="sample")
print(result)

_write_gateway_config

分類: internal function

シグネチャ

_write_gateway_config(gateway_dir: Path, *, kind: str, app_name: str, app_port: int, domain: str) -> Path

使い方と仕様

実装コード由来のAPIです。

引数

  • gateway_dir / kind=positional-or-keyword / type=Path / 必須 / default=なし
  • kind / kind=keyword-only / type=str / 必須 / default=なし
  • app_name / kind=keyword-only / type=str / 必須 / default=なし
  • app_port / kind=keyword-only / type=int / 必須 / default=なし
  • domain / kind=keyword-only / type=str / 必須 / default=なし

戻り値

Path

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import _write_gateway_config

result = _write_gateway_config(gateway_dir="/path/to/value", kind="sample", app_name="sample", app_port=1, domain="sample")
print(result)

create_app

分類: public function

シグネチャ

create_app(project_dir: str | Path, app_name: str, *, options: AppBuildOptions | None = None, gateway_config: str | None = None, domain: str = '') -> Path

使い方と仕様

Create a new Nexom app scaffold. Copies template assets and writes config/gunicorn/wsgi files.

引数

  • project_dir / kind=positional-or-keyword / type=str | Path / 必須 / default=なし
  • app_name / kind=positional-or-keyword / type=str / 必須 / default=なし
  • options / kind=keyword-only / type=AppBuildOptions | None / 任意 / default=None
  • gateway_config / kind=keyword-only / type=str | None / 任意 / default=None
  • domain / kind=keyword-only / type=str / 任意 / default=''

戻り値

Path

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import create_app

result = create_app(project_dir="sample", app_name="sample", options=None, gateway_config=None, domain='')
print(result)

create_auth

分類: public function

シグネチャ

create_auth(project_dir: str | Path, *, options: AppBuildOptions | None = None, master_user: str = 'master_user', master_user_login_password: str | None = None) -> Path

使い方と仕様

Create a new Nexom auth app scaffold.

引数

  • project_dir / kind=positional-or-keyword / type=str | Path / 必須 / default=なし
  • options / kind=keyword-only / type=AppBuildOptions | None / 任意 / default=None
  • master_user / kind=keyword-only / type=str / 任意 / default='master_user'
  • master_user_login_password / kind=keyword-only / type=str | None / 任意 / default=None

戻り値

Path

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import create_auth

result = create_auth(project_dir="sample", options=None, master_user='master_user', master_user_login_password=None)
print(result)

create_config

分類: public function

シグネチャ

create_config(project_dir: str | Path, app_name: str, *, options: AppBuildOptions | None = None, auth: bool = False, master_user: str = 'master_user', master_user_login_password: str | None = None) -> Path

使い方と仕様

Create only config.py for an existing app directory. Raises: - FileNotFoundError: app directory does not exist - FileExistsError: config.py already exists

引数

  • project_dir / kind=positional-or-keyword / type=str | Path / 必須 / default=なし
  • app_name / kind=positional-or-keyword / type=str / 必須 / default=なし
  • options / kind=keyword-only / type=AppBuildOptions | None / 任意 / default=None
  • auth / kind=keyword-only / type=bool / 任意 / default=False
  • master_user / kind=keyword-only / type=str / 任意 / default='master_user'
  • master_user_login_password / kind=keyword-only / type=str | None / 任意 / default=None

戻り値

Path

例外・注意点

  • - FileNotFoundError: app directory does not exist
  • - FileExistsError: config.py already exists

利用例

from nexom.buildTools.build import create_config

result = create_config(project_dir="sample", app_name="sample", options=None, auth=False, master_user='master_user', master_user_login_password=None)
print(result)

start_project

分類: public function

シグネチャ

start_project(*, project_root: Path, main_name: str = 'app', auth_name: str = 'auth', main_options: AppBuildOptions | None = None, auth_options: AppBuildOptions | None = None, gateway: str = 'none', domain: str = '', master_user: str = 'master_user', master_user_login_password: str | None = None) -> Path

使い方と仕様

Assumption: user already created the project directory and cd'ed into it. So we DO NOT create the project directory itself; we only populate inside.

引数

  • project_root / kind=keyword-only / type=Path / 必須 / default=なし
  • main_name / kind=keyword-only / type=str / 任意 / default='app'
  • auth_name / kind=keyword-only / type=str / 任意 / default='auth'
  • main_options / kind=keyword-only / type=AppBuildOptions | None / 任意 / default=None
  • auth_options / kind=keyword-only / type=AppBuildOptions | None / 任意 / default=None
  • gateway / kind=keyword-only / type=str / 任意 / default='none'
  • domain / kind=keyword-only / type=str / 任意 / default=''
  • master_user / kind=keyword-only / type=str / 任意 / default='master_user'
  • master_user_login_password / kind=keyword-only / type=str | None / 任意 / default=None

戻り値

Path

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.buildTools.build import start_project

result = start_project(project_root="/path/to/value", main_name='app', auth_name='auth', main_options=None, auth_options=None, gateway='none', domain='', master_user='master_user', master_user_login_password=None)
print(result)

クラス

AppBuildOptions

分類: public class

Options for generated app configuration.

このクラスにメソッド定義はありません。

AppBuildError

分類: public class

Raised when project generation fails for any reason.

このクラスにメソッド定義はありません。

ソース情報

  • module: nexom.buildTools.build
  • source file: services/venv/lib/python3.10/site-packages/nexom/buildTools/build.py
  • generated date: 2026-03-14

©2026 Nexom MIT-License