Django-FSM-Log 项目教程

Django-FSM-Log 项目教程

django-fsm-logAutomatic logging for Django FSM项目地址:https://gitcode.com/gh_mirrors/dj/django-fsm-log

1. 项目的目录结构及介绍

Django-FSM-Log 项目的目录结构如下：

django-fsm-log/
├── docs/
├── tests/
├── .gitignore
├── .markdownlint.yaml
├── .pre-commit-config.yaml
├── .readthedocs.yaml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── pyproject.toml
├── setup.cfg
├── setup.py
├── tox.ini

目录介绍

• docs/: 包含项目的文档文件。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件配置。
• .markdownlint.yaml: Markdown 格式检查配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• .readthedocs.yaml: Read the Docs 配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• pyproject.toml: 项目构建配置。
• setup.cfg: 安装配置。
• setup.py: 安装脚本。
• tox.ini: 自动化测试配置。

2. 项目的启动文件介绍

Django-FSM-Log 项目的启动文件主要是 setup.py，它负责项目的安装和依赖管理。

setup.py

from setuptools import setup, find_packages

setup(
    name='django-fsm-log',
    version='1.5.0',
    packages=find_packages(),
    include_package_data=True,
    install_requires=[
        'django>=1.8',
        'django-fsm>=2.0',
    ],
    author='Gizmag',
    author_email='support@gizmag.com',
    description='Provides persistence of the transitions of your fsm\'s models',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/jazzband/django-fsm-log',
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Environment :: Web Environment',
        'Framework :: Django',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
    ],
)

3. 项目的配置文件介绍

Django-FSM-Log 项目的配置文件主要是 setup.cfg 和 pyproject.toml。

setup.cfg

[metadata]
name = django-fsm-log
version = 1.5.0
description = Provides persistence of the transitions of your fsm's models
long_description = file: README.md
long_description_content_type = text/markdown
author = Gizmag
author_email = support@gizmag.com
url = https://github.com/jazzband/django-fsm-log
license = MIT

[options]
packages = find:
include_package_data = True
install_requires =
    django>=1.8
    django-fsm>=2.0

[options.packages.find]
where = .

[flake8]
max-line-length = 120
exclude = .git,__pycache__,docs

pyproject.toml

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

以上是 Django-FSM-Log 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

django-fsm-logAutomatic logging for Django FSM项目地址:https://gitcode.com/gh_mirrors/dj/django-fsm-log