通用pik django实用程序和工具
pik-django-utils的Python项目详细描述
Pik django实用程序
本项目旨在提供常见的django项目实用程序和工具 为所有的Pik Django项目。
它应该为文档提供指导和工具建议, 测试等
这个项目是django-service-boilerplate
的一部分。
版本控制
我们使用语义版本控制major.minor.maintenance scheme,其中项目作者递增:
- 主要版本当他们做出不兼容的API更改时,
- 以向后兼容的方式添加功能时的次要版本,以及
- 当他们进行向后兼容的错误修复时的维护版本。
套餐
pik.core
-django特定人员pik.libs
-django特定的模块和库pik.utils
-不是django特异性的小utils和goodness
活塞芯
pik.core.models
-常见用例的抽象django模型pik.core.models.fields
-公共模型字段pik.core.tests
-测试助手pik.core.shortcuts
-django代码快捷方式和遗漏的帮助程序pik.core.cache
-缓存帮助程序
Pik.Core.型号
BasePHistorical
/BaseHistorical
-基于历史实体模型NullOwned
/Owned
-用户关系模型SoftDeleted
-软可删除模型
pik.core.models.fields
InheritPrimaryUidField
-允许您为继承表中的子表保存与父表中相同的uid标识符
核心测试
create_user
/get_user
-用户设备
pik.core.快捷方式
get_object_or_none(model: Type[models.Model], **search_keys) -> Optional[models.Model]
validate_and_create_object(model: Type[models.Model], **kwargs) -> models.Model
validate_and_update_object(obj: models.Model, **kwargs) -> Tuple[models.Model, bool]
update_or_create_object(model: Type[models.Model], search_keys: Optional[dict] = None, **kwargs) -> Tuple[models.Model, bool, bool]
get_current_request() -> Optional[HttpRequest]
pik.libs
…
像素实用程序
pik.utils.normalization
-文本规范化帮助程序
正常化
normalize(text: str) -> str
company_name_normalization(name: str) -> str
- [X]跟随https://packaging.python.org/
- [X]创建
release.sh
文件 - []生成django通用设置