Skip to main content

simplelayout

Project description

Open in Visual Studio Code

3-simplelayout-package

简介

  • 本次作业将大家完成的数据生成器进行打包,可供 pip 进行安装,发布到 PyPI。同时使用 Sphinx 构建文档,发布到 Read the Docs

Sphinx is a powerful documentation generator that has many great features for writing technical documentation including:

  • Generate web pages, printable PDFs, documents for e-readers (ePub), and more all from the same sources
  • You can use reStructuredText or Markdown to write documentation
  • An extensive system of cross-referencing code and documentation
  • Syntax highlighted code samples
  • A vibrant ecosystem of first and third-party extensions

要求

  • 将个人完成的 2-simplelayout-generator 项目中的 simplelayout 目录复制到本次作业的 src 目录下。
  • 编写 setup.py
    • 参考官方文档,与 Packaging and distributing projects,正确配置 setuptools.setup(),确保能被 pip 正确安装,要求
      • package 名称设置为 simplelayout-github账号名
      • 正确包含 src/simplelayout 这个 package
      • install_requires 包含 simplelayout 的相关依赖
      • 正确配置 entry_points,使命令 simplelayout 对应 simplelayout/__main__.py 中的 main() 函数
  • 参考 文档,正确打包
  • 参考 文档,正确上传到 PyPI
  • 根据参考教程,创建 docs 目录,并创建 Sphinx 项目。
    • 在执行 sphinx-quickstart 时输入相关信息
    • Sphinx 默认使用 rst 格式(reStructuredText )编写文档,可进行配置使用 Markdown 进行文档编写。
    • 选做:参考 配置 autodoc、napoleon 插件,自动生成 simplelayout 中的 docstring API。
    • 在本地生成正确的 Sphinx 文档
  • 注册 Read the Docs,将个人仓库中的文档正确托管
  • 将个人项目 PyPI 仓库的链接、read the docs 链接以评论的方式发在 Feedback

注意

本次作业的在线测试分为以下部分:

  1. 测试能否正确执行
pip install .

分值:1 分

  1. 测试能否正确执行
pip install .
simplelayout -h

分值:1 分

以上测试通过后,会在 Feedback 中打印相关信息(包括 PyPI 链接,生成图片),但不会对 PyPIRead the Docs 自动测试

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplelayout-YujieFeng20-0.0.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

simplelayout_YujieFeng20-0.0.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file simplelayout-YujieFeng20-0.0.0.tar.gz.

File metadata

  • Download URL: simplelayout-YujieFeng20-0.0.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.0

File hashes

Hashes for simplelayout-YujieFeng20-0.0.0.tar.gz
Algorithm Hash digest
SHA256 4b1e3140cde732eba7d8a2ccfafc1834fb124a5409a23fb706b64668b4edbb34
MD5 51ceb55b21b7489259952dd7e8aea8ef
BLAKE2b-256 6230f2e2c9a90a5d6c63b76c1e2449dd7e58aa76333813d9baf33f1c45d8c459

See more details on using hashes here.

File details

Details for the file simplelayout_YujieFeng20-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: simplelayout_YujieFeng20-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.1 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.0

File hashes

Hashes for simplelayout_YujieFeng20-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57c8fc4f3ba1543ade6e973ab1de78267ec71e5d23fa9c2aa0d2173cb96a1404
MD5 bb91f66008d5fb729f93beb0552e31c1
BLAKE2b-256 9c5e0e3c4af00178d7367217f4dad25e868a02f947a68ce535a5490d8af9e50e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page