Django-Markup 项目教程
django-markupConvert text markup to html. Markdown, rST, Textile etc.项目地址:https://gitcode.com/gh_mirrors/dj/django-markup
1. 项目的目录结构及介绍
Django-Markup 项目的目录结构如下:
django-markup/
├── django_markup/
│ ├── __init__.py
│ ├── filters.py
│ ├── formatter.py
│ ├── settings.py
│ ├── templatetags/
│ │ ├── __init__.py
│ │ ├── markup_tags.py
│ ├── tests/
│ │ ├── __init__.py
│ │ ├── test_filters.py
│ │ ├── test_formatter.py
│ │ ├── test_settings.py
│ │ ├── test_templatetags.py
│ ├── utils.py
├── docs/
│ ├── conf.py
│ ├── index.rst
│ ├── installation.rst
│ ├── usage.rst
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.rst
├── requirements.txt
├── setup.cfg
├── 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 文件介绍
from setuptools import setup, find_packages
setup(
name='django-markup',
version='1.9',
packages=find_packages(),
include_package_data=True,
license='MIT License',
description='A generic Django application to convert text with specific markup to html',
long_description=open('README.rst').read(),
author='Martin Mahner',
author_email='martin@mahner.org',
url='https://github.com/bartTC/django-markup',
classifiers=[
'Environment :: Web Environment',
'Framework :: Django',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Topic :: Internet :: WWW/HTTP',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
],
install_requires=[
'Django>=3.8,<4.0',
],
extras_require={
'all_filter_dependencies': [
'Markdown',
'docutils',
'Pygments',
'textile',
'smartypants',
],
},
)
启动文件功能
setup.py
文件使用setuptools
库来定义项目的元数据和依赖关系。name
和version
定义
django-markupConvert text markup to html. Markdown, rST, Textile etc.项目地址:https://gitcode.com/gh_mirrors/dj/django-markup