Django-Markup 项目教程

随笔2个月前发布 侯正非
40 0 0

Django-Markup 项目教程

django-markupConvert text markup to html. Markdown, rST, Textile etc.项目地址:https://gitcode.com/gh_mirrors/dj/django-markup

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

Django-Markup 项目的目录结构如下:

  1. django-markup/

  2. ├── django_markup/

  3. │ ├── __init__.py

  4. │ ├── filters.py

  5. │ ├── formatter.py

  6. │ ├── settings.py

  7. │ ├── templatetags/

  8. │ │ ├── __init__.py

  9. │ │ ├── markup_tags.py

  10. │ ├── tests/

  11. │ │ ├── __init__.py

  12. │ │ ├── test_filters.py

  13. │ │ ├── test_formatter.py

  14. │ │ ├── test_settings.py

  15. │ │ ├── test_templatetags.py

  16. │ ├── utils.py

  17. ├── docs/

  18. │ ├── conf.py

  19. │ ├── index.rst

  20. │ ├── installation.rst

  21. │ ├── usage.rst

  22. ├── .gitignore

  23. ├── LICENSE

  24. ├── MANIFEST.in

  25. ├── README.rst

  26. ├── requirements.txt

  27. ├── setup.cfg

  28. ├── setup.py

目录结构介绍

  • django_markup/: 包含项目的主要代码文件。
    • __init__.py: 初始化文件。
    • filters.py: 定义各种文本过滤器。
    • formatter.py: 格式化文本的主要逻辑。
    • settings.py: 项目的配置文件。
    • templatetags/: 包含模板标签文件。
      • markup_tags.py: 定义模板标签。
    • tests/: 包含测试文件。
      • test_filters.py: 过滤器测试。
      • test_formatter.py: 格式化测试。
      • test_settings.py: 配置测试。
      • test_templatetags.py: 模板标签测试。
    • utils.py: 工具函数。
  • docs/: 包含项目的文档文件。
    • conf.py: Sphinx 配置文件。
    • index.rst: 文档主页。
    • installation.rst: 安装指南。
    • usage.rst: 使用指南。
  • .gitignore: Git 忽略文件。
  • LICENSE: 项目许可证。
  • MANIFEST.in: 打包清单文件。
  • README.rst: 项目说明文件。
  • requirements.txt: 依赖包列表。
  • setup.cfg: 安装配置文件。
  • setup.py: 安装脚本。

2. 项目的启动文件介绍

Django-Markup 项目的启动文件主要是 setup.py,它负责项目的安装和分发。

setup.py 文件介绍

  1. from setuptools import setup, find_packages

  2. setup(

  3. name='django-markup',

  4. version='1.9',

  5. packages=find_packages(),

  6. include_package_data=True,

  7. license='MIT License',

  8. description='A generic Django application to convert text with specific markup to html',

  9. long_description=open('README.rst').read(),

  10. author='Martin Mahner',

  11. author_email='martin@mahner.org',

  12. url='https://github.com/bartTC/django-markup',

  13. classifiers=[

  14. 'Environment :: Web Environment',

  15. 'Framework :: Django',

  16. 'Intended Audience :: Developers',

  17. 'License :: OSI Approved :: MIT License',

  18. 'Operating System :: OS Independent',

  19. 'Programming Language :: Python',

  20. 'Programming Language :: Python :: 3',

  21. 'Programming Language :: Python :: 3.8',

  22. 'Programming Language :: Python :: 3.9',

  23. 'Programming Language :: Python :: 3.10',

  24. 'Topic :: Internet :: WWW/HTTP',

  25. 'Topic :: Internet :: WWW/HTTP :: Dynamic Content',

  26. ],

  27. install_requires=[

  28. 'Django>=3.8,<4.0',

  29. ],

  30. extras_require={

  31. 'all_filter_dependencies': [

  32. 'Markdown',

  33. 'docutils',

  34. 'Pygments',

  35. 'textile',

  36. 'smartypants',

  37. ],

  38. },

  39. )

启动文件功能

  • setup.py 文件使用 setuptools 库来定义项目的元数据和依赖关系。
  • nameversion 定义

django-markupConvert text markup to html. Markdown, rST, Textile etc.项目地址:https://gitcode.com/gh_mirrors/dj/django-markup

© 版权声明

相关文章

暂无评论

您必须登录才能参与评论!
立即登录
暂无评论...