Skip to content
This repository was archived by the owner on Aug 11, 2025. It is now read-only.

Components

Jump to bottom
Chris Warrick edited this page Dec 19, 2020 · 29 revisions

Table of Contents/Directory Tree

docs/

conf.py

This is a configuration for Sphinx, which may or may not work for everyone.

html/

A sample file to upload to the PyPI as your “project documentation” to redirect to ReadTheDocs. (Not necessary)

reST files

Those are sample files, some of which are copyrighted. Please make sure to read through all of them and decide whether you need them or not!

Some of them are also in the repository root, in multiple copies.

GitHub Actions

The workflow for GitHub Actions lives in .github/workflows/ci.yml. It will run tests on Ubuntu, Windows and macOS, using multiple Python versions, including PyPy.

Python package

__init__.py

A sample __init__.py file with the license and a few additional headers.

__main__.py

A sample __main__.py file, compatible with entry_points and direct usage with -m.

template.py

A sample, almost-empty Python file.

PKGBUILD*

PKGBUILD files for Arch Linux users. You can use them or delete them. You may need to change some names if you aren’t Chris Warrick.

release

A sophisticated, automated script for releasing.

.pypt

Configuration and data files for PyPT.

config

Config options for the entire template. Options include:

  • $PROJECT — human-friendly project name.
  • $PROJECTLC — computer-friendly project name.
  • $GITUSER — GitHub username.
  • $GITREPO — git repository name.
  • $LOCALETYPE — locale type. One of none, gettext, pyqt4, pyside; accepts a -tx suffix for Transifex locale support.
  • $PYTHON2, $PYTHON3 — Python versions supported.
  • $AUR_GIT_PACKAGE — Whether or not to create AUR -git packages. (true/false)
  • $AUR_PKGNAME, $AUR_PKGNAME_GIT — AUR package names. You still need to edit PKGBUILDs!

hooks/

Hooks that are run by the release scripts.

pre-sdist.hook

Run right before creating tarballs.

post-release.hook

Run after the release is complete.

A few other scripts you should not care about

.pypt/commitlog

A hacky script for creating commit messages and changelog entries. Does not work on its own, needs the release scripts.

.pypt/localegen

A script for generating locales.

.pypt/ghrel

A script for creating GitHub Releases. Can also work standalone.

.travis.yml

Configuration for Travis CI.

setup.py

A setup.py file that should be good enough for most people, and that supports entry_points (see https://go.chriswarrick.com/entry_points).

tests/

Tests. Included are some Is My Python Sane? tests. They are guaranteed to pass. pytest is used as the test runner, and the tests are written using pytest syntax.

pypt-extras/Qt/

A resource switcher for PyQt/PySide projects.

pypt-extras/AUR/

A sample post-release hook for AUR package updates and automation for updating AUR packages in a virtual machine. (See README for details!)

PYPT-UPDATE (outside)

A script to update PyPT across all your repositories. You must copy it somewhere else and edit it accordingly.

Clone this wiki locally