https://github.com/pypa/sampleproject

A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects"
https://github.com/pypa/sampleproject

Last synced: 3 days ago
JSON representation

A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects"

• Host: GitHub
• URL: https://github.com/pypa/sampleproject
• Owner: pypa
• License: mit
• Created: 2013-12-03T16:43:27.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T22:36:40.000Z (about 1 month ago)
• Last Synced: 2024-12-04T20:06:52.216Z (8 days ago)
• Language: Python
• Homepage: https://packaging.python.org/tutorials/packaging-projects/
• Size: 130 KB
• Stars: 5,131
• Watchers: 108
• Forks: 1,727
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starts - pypa/sampleproject - A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects" (Python)
• awesome-pyproject - PyPA Sample Project - A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects". (Project Templates)
• jimsghstars - pypa/sampleproject - A sample project that exists for PyPUG's "Tutorial on Packaging and Distributing Projects" (Python)

README

        
# A sample Python project

![Python Logo](https://www.python.org/static/community_logos/python-logo.png "Sample inline image")

A sample project that exists as an aid to the [Python Packaging User

Guide][packaging guide]'s [Tutorial on Packaging and Distributing

Projects][distribution tutorial].

This project does not aim to cover best practices for Python project

development as a whole. For example, it does not provide guidance or tool

recommendations for version control, documentation, or testing.

[The source for this project is available here][src].

The metadata for a Python project is defined in the `pyproject.toml` file,

an example of which is included in this project. You should edit this file

accordingly to adapt this sample project to your needs.

----

This is the README file for the project.

The file should use UTF-8 encoding and can be written using

[reStructuredText][rst] or [markdown][md use] with the appropriate [key set][md

use]. It will be used to generate the project webpage on PyPI and will be

displayed as the project homepage on common code-hosting services, and should be

written for that purpose.

Typical contents for this file would include an overview of the project, basic

usage examples, etc. Generally, including the project changelog in here is not a

good idea, although a simple “What's New” section for the most recent version

may be appropriate.

[packaging guide]: https://packaging.python.org

[distribution tutorial]: https://packaging.python.org/tutorials/packaging-projects/

[src]: https://github.com/pypa/sampleproject

[rst]: http://docutils.sourceforge.net/rst.html

[md]: https://tools.ietf.org/html/rfc7764#section-3.5 "CommonMark variant"

[md use]: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional