Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

sampleproject

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

Subscribe to updates I use sampleproject


Statistics on sampleproject

Number of watchers on Github 1621
Number of open issues 14
Average time to close an issue 2 months
Main language Python
Average time to merge a PR 8 days
Open pull requests 8+
Closed pull requests 4+
Last commit almost 2 years ago
Repo Created about 6 years ago
Repo Last Updated over 1 year ago
Size 58 KB
Organization / Authorpypa
Contributors15
Page Updated
Do you use sampleproject? Leave a review!
View open issues (14)
View sampleproject activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating sampleproject for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

A sample Python project

A sample project that exists as an aid to the Python Packaging User Guide <https://packaging.python.org>'s Tutorial on Packaging and Distributing Projects <https://packaging.python.org/en/latest/distributing.html>.

This projects 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 <https://github.com/pypa/sampleproject>_.

Most of the configuration for a Python project is done in the setup.py 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 be written using reStructuredText <http://docutils.sourceforge.net/rst.html>_. 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.

sampleproject open issues Ask a question     (View All Issues)
  • over 3 years setup.py: test_suite
  • over 4 years neither package_data or data_files get installed
  • almost 5 years It would be great to add a simple module and a test for that module.
  • about 5 years docs in sampleproject missing
  • about 5 years Clarify Python 2 and 3 language
  • about 5 years Allow the project to be used as starting point for non-MIT licensed project
  • almost 6 years add tox.ini and .travis.yml
sampleproject open pull requests (View All Pulls)
  • Stop suggesting python 3.2 support
  • Add README.rst to source package, via MANIFEST.in.
  • Disable flake8 tests in py26 and py33
  • Add comment about where to get SPDX License identifier
  • Drop support for Python 2.6
  • Fix name of markup language
  • Include LICENSE.txt in wheel
  • update setuptools configuration
sampleproject questions on Stackoverflow (View All Questions)
  • Difference between session.getServletContext() and session.getServletContext().getContext("/SampleProject")
sampleproject list of languages used
Other projects in Python