sampleproject Documentation

repository·main·Indexed 26 days ago

https://github.com/pypa/sampleproject

A pedagogical Python project version 4.0.0 used to demonstrate the process of packaging and distributing Python software according to official Python Packaging User Guide standards.

Tokens
295
Snippets
0
Records
5
Agent score
40%

What's inside sampleproject

  1. Overview of sampleproject

    main
    sampleproject is a sample Python project designed to assist developers following the [Python Packaging User Guide]'s [Tutorial on Packaging and Distributing Projects]. It serves as a template for understanding how to package and distribute Python software.
  2. Create a project README for PyPI

    main

    When creating a README for a Python project to be displayed on PyPI and code-hosting services, follow these guidelines:

    • Encoding: Use UTF-8 encoding.
    • Format: Use reStructuredText or Markdown (CommonMark variant).
    • Content: Include a project overview and basic usage examples.
    • Best Practices: Avoid including a full changelog; instead, use a simple "What's New" section for the most recent version if necessary.
  3. Configure project metadata using pyproject.toml

    main
    Project metadata for this project is defined in the pyproject.toml file. To adapt this sample project to your own requirements, you should edit the pyproject.toml file with your specific project details.