ipa-python-kit 0.1.1__tar.gz → 0.1.2__tar.gz

{ipa_python_kit-0.1.1 → ipa_python_kit-0.1.2}/.gitignore

@@ -2,9 +2,12 @@
 logs
 dist
 build
+data
 *.log
 
 **/*.egg-info
 .pypirc
 
-src/sdk/_version.py
+src/sdk/_version.py
+
+!scripts/**

ipa_python_kit-0.1.2/.vscode/settings.json

@@ -0,0 +1,22 @@
+{
+    "python.autoComplete.extraPaths": [
+        "${workspaceFolder}"
+    ],
+    // 用于语言服务分析（语法检查、跳转等）的路径
+    "python.analysis.extraPaths": [
+        "${workspaceFolder}"
+    ],
+    // // 确保终端中 PYTHONPATH 包含 src 目录，但实际上这种方式不通用
+    // // 终端中生效的 PYTHONPATH（可选，确保终端运行时也能识别）
+    // "terminal.integrated.env.windows": {
+    //     "PYTHONPATH": "${workspaceFolder}/src;${workspaceFolder};${env:PYTHONPATH}"
+    // },
+    // "terminal.integrated.env.osx": {
+    //     "PYTHONPATH": "${workspaceFolder}/src:${workspaceFolder}:${env:PYTHONPATH}"
+    // },
+    // "terminal.integrated.env.linux": {
+    //     "PYTHONPATH": "${workspaceFolder}/src:${workspaceFolder}:${env:PYTHONPATH}"
+    // },
+    "python.envFile": "${workspaceFolder}/.env",
+    "jupyter.envFile": "${workspaceFolder}/.env"
+}

{ipa_python_kit-0.1.1 → ipa_python_kit-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ipa-python-kit
-Version: 0.1.1
+Version: 0.1.2
 Summary: kit for python
 Author-email: xdewx <present150608@sina.com>
 Keywords: python,kit,lib,util
@@ -10,6 +10,7 @@ Requires-Dist: deprecated>=1.3.1
 Requires-Dist: pint>=0.21.1
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pyhumps>=3.8.0
+Requires-Dist: typer>=0.20.1
 Provides-Extra: system
 Requires-Dist: psutil>=7.2.1; extra == "system"
 Provides-Extra: i18n
@@ -27,6 +28,7 @@ Provides-Extra: visualization
 Requires-Dist: matplotlib>=3.7.5; extra == "visualization"
 Requires-Dist: pyecharts>=2.0.9; extra == "visualization"
 Provides-Extra: orm
+Requires-Dist: alembic>=1.14.1; extra == "orm"
 Requires-Dist: sqlmodel>=0.0.29; extra == "orm"
 Provides-Extra: network
 Requires-Dist: networkx>=3.1; extra == "network"
@@ -50,18 +52,38 @@ Requires-Dist: simpy>=4.1.1; extra == "des"
 3. darker for code format
 4. ruff for lint
 5. commitlint for commit message format
+6. typer for cli
+7. sqlmodel for database ORM
+8. alembic for database migration
 
-## 使用方式
+## introduction
 
-- 初始化环境：`./scripts/setup`
+the project uses `src-layout`, includes `sdk` (for publish) and `biz` (for business logic).
+`sdk` is designed for publish and no need to rename, we use file/folder mapping `mylib=src/sdk` in `pyproject.toml`.
 
-- 执行测试：`uv run -m pytest`
+### dev
 
-- 启动服务：`uv run main.py`
+before you start:
 
-- 构建发布：`./scripts/publish`
+1. must run `./scripts/setup`
+1. just replace `mylib` with `[the name you want]` in the whole project
+1. remember to `uv pip install -e .[all]` to make sure `mylib` is available in development.
 
+### unit test
 
-## TODO
+`uv run -m pytest`
 
-- [ ] 处理自身与依赖的最低python版本要求关系
+### run cli
+
+`uv run main.py --help`
+
+### release sdk
+
+1. `cp .pypirc.example .pypirc`
+2. replace your token in `.pypirc`
+3. `git tag vx.y.z`
+4. `./scripts/publish`
+
+### build executable file
+
+`./scripts/build`

ipa_python_kit-0.1.2/README.md

@@ -0,0 +1,44 @@
+# pyproject-tmpl
+
+## features
+
+1. pytest
+2. pre-commit
+3. darker for code format
+4. ruff for lint
+5. commitlint for commit message format
+6. typer for cli
+7. sqlmodel for database ORM
+8. alembic for database migration
+
+## introduction
+
+the project uses `src-layout`, includes `sdk` (for publish) and `biz` (for business logic).
+`sdk` is designed for publish and no need to rename, we use file/folder mapping `mylib=src/sdk` in `pyproject.toml`.
+
+### dev
+
+before you start:
+
+1. must run `./scripts/setup`
+1. just replace `mylib` with `[the name you want]` in the whole project
+1. remember to `uv pip install -e .[all]` to make sure `mylib` is available in development.
+
+### unit test
+
+`uv run -m pytest`
+
+### run cli
+
+`uv run main.py --help`
+
+### release sdk
+
+1. `cp .pypirc.example .pypirc`
+2. replace your token in `.pypirc`
+3. `git tag vx.y.z`
+4. `./scripts/publish`
+
+### build executable file
+
+`./scripts/build`

ipa_python_kit-0.1.2/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

ipa_python_kit-0.1.2/alembic/env.py

@@ -0,0 +1,82 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config, pool
+from sqlmodel import SQLModel
+
+from alembic import context
+from conf import setup_alembic
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+setup_alembic(config)
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = [
+    SQLModel.metadata,
+]
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

ipa_python_kit-0.1.2/alembic/script.py.mako

@@ -0,0 +1,29 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlmodel
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    ${downgrades if downgrades else "pass"}

ipa_python_kit-0.1.2/alembic/versions/5227325b977d_baseline.py

@@ -0,0 +1,34 @@
+"""baseline
+
+Revision ID: 5227325b977d
+Revises:
+Create Date: 2026-01-07 16:34:35.310175
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+import sqlmodel
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "5227325b977d"
+down_revision: Union[str, Sequence[str], None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###

ipa_python_kit-0.1.2/alembic.ini

@@ -0,0 +1,149 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+prepend_sys_path = .
+
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the tzdata library which can be installed by adding
+# `alembic[tz]` to the pip requirements.
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to <script_location>/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+
+# keep empty to let setup_alembic load from conf/__init__.py
+sqlalchemy.url =
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

ipa_python_kit-0.1.2/main.py

@@ -0,0 +1,30 @@
+import sys
+from pathlib import Path
+
+from typer import Typer
+
+# TODO: i don't want to add this manually, but i have no idea how to do it automatically at present
+sys.path.append(str(Path(__file__).parent / "src"))
+
+print(sys.path)
+
+cmd = Typer()
+
+
+@cmd.command()
+def sub(a: int, b: int) -> int:
+    c = a - b
+    print(f"sub({a}, {b}) = {c}")
+    return c
+
+
+@cmd.command()
+def setup_db():
+    from conf import setup_database
+
+    # if you need to use database, invoke setup_database freely
+    setup_database()
+
+
+if __name__ == "__main__":
+    cmd()

ipa_python_kit-0.1.2/main.spec

@@ -0,0 +1,75 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+datas=[
+    ("src/conf","conf"),
+    ("src/sdk","ipa"),
+    ("src/biz","biz"),
+    ("alembic","alembic"),
+    ("alembic.ini","."),
+]
+
+a = Analysis(
+    ['main.py'],
+    pathex=[],
+    binaries=[],
+    datas=datas,
+    hiddenimports=[
+        "typer", "click", "ctypes", "_ctypes",
+        "colorlog",
+        'scipy', 'scipy._cyutility',
+        "alembic",
+        'sqlalchemy', 'sqlmodel', "sqlalchemy.sql.default_comparator",
+        "sqlalchemy.engine.url", "sqlalchemy.dialects.sqlite",
+        'sqlite3',
+        "uvicorn.logging",          # 核心日志模块
+        "uvicorn.logging.DefaultFormatter",  # 显式指定默认格式化器
+        "logging.config",           # Python 标准库日志配置
+        "colorama",                  # 若使用颜色日志，需添加（Uvicorn 可能依赖）
+        "uvicorn.loops",
+        "uvicorn.loops.auto",
+        "uvicorn.protocols",
+        "uvicorn.protocols.http",
+        "uvicorn.protocols.http.auto",
+        "uvicorn.protocols.websockets",
+        "uvicorn.protocols.websockets.auto",
+        "uvicorn.lifespan",
+        "uvicorn.lifespan.on",
+        "fastapi.middleware.cors"
+    ],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+    optimize=0,
+)
+pyz = PYZ(a.pure)
+
+onefile=False
+exe = EXE(
+    pyz,
+    a.scripts,
+    [],
+    exclude_binaries=not onefile,
+    name='main',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    console=True,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+)
+if not onefile:
+    coll = COLLECT(
+        exe,
+        a.binaries,
+        a.datas,
+        strip=False,
+        upx=True,
+        upx_exclude=[],
+        name='main',
+    )