Administration#

Supernavs#

The concept of a Supernav is used heavily on the site. These are the larger bits of text and markup included in the main navigation drop downs. These are implemented as specially named Boxes. They are by convention named supernav-*, for example templates/downloads/supernav.html.

Here is an example of what that looks like on the site.

Example Supernav image

The sub-nav items on the left are simply nested Navigation links in SiteTree relative to the ‘Download’ item in the tree. The larger Download for macOS box however is what we refer to as the supernav.

Most supernavs are updated automatically based on the underlying Django application content using signals. By convention the application will have a template named supernav.html. For example, upon saving any published Release a Django signal is fired to update the supernav-python-downloads box with the most current Python2 and Python3 releases. In this case the markup is structured in a way to allow for the automatic OS detection Javascript to show the user the appropriate download links for the OS they are browsing with.

Pages#

Pages are individual entire pages of markup content. They are require Title, Path, and Content to be acceptable in the system. Note that Pages are implemented using a fall through system of URL routing so a user cannot override an existing defined Django URL on accident with a Page.

Fields and Descriptions

Title:

Title of the Page. Will also be used as the <title></title> attribute in the markup.

Keywords:

HTML META keywords for search engines

Description:

HTML META description for search engines

Path:

Relative URL path where the page will reside, excluding the initial slash. Example: about/psf/somepage/

Content:

The actual content of the page.

Markup Type:

Type of markup contained in the Content field. Options are: HTML, plain text, ReStructured Text, and Markdown

Is Published:

Controls whether or not the page is visible on the site.

Template Name:

By default Pages use the template templates/pages/default.html to use a different template enter the template path here.

Note

Pages are automatically purged from Fastly.com upon save.

Boxes#

Boxes are re-usable bits of HTML markup that are used throughout the site. Things like sidebar info and specific areas of areas of pages with a richer design (i.e. landing pages) that would be cumbersome to edit as one large content textarea.

Note

There are special boxes that are automatically rebuilt using templates, see Supernavs.

Downloads and Releases#

The downloads app stores all of the structured data regarding Python releases. Each Release object has associated ReleaseFile objects that contain information on the various download formats Python.org supports.

If the version you are creating should be considered the “latest” release for the major version in question (Python 2.x.x, 3.x.x, etc) then check the ‘Is this the latest release’ checkbox. When the Release is saved, the previous version will be automatically demoted for you and the new version will be used prominently on the site. For example the download buttons and supernav links.

Note

If you make a mistake here, no worries you can just check the box and save on ANY version and promote it to being the latest release.

To create a release you simply need to fill in the appropriate information. Currently if a Release has an associated Release Page the system redirects to that to accommodate legacy content, but if the Content field is filled they are taken to the Release Detail page which shows the content and lists all of the associated downloadable files.

Release Files have a checkbox named ‘Download button’ that determines which binary/source package download link to display for a given OS. This information is used by the OS detection JS on the site so pick the package in most widespread use. On Source distributions be sure to check the ‘Download button’ for the .tgz version for widest compatibility.

Jobs#

The jobs application is used to display Python jobs on the site. The data items should be fairly self explanatory. There are a couple of things to keep in mind. Logged in users of the site can submit jobs for review.

Status:

Jobs enter the system in ‘review’ status after the submitter has entered them. Only jobs in the ‘approved’ state are displayed on the site.

Featured:

Featured jobs are displayed more prominently on the landing page.

Comments:

Users who have submitted a job and admin reviewers can make comments on a job. Emails will be sent to the other party in order to foster communication about job description and data.

Sponsors#

The Sponsors app is a place to store PSF Sponsors and Sponsorships. This is the most complex app in the project due to the multiple possibilities on how to configure a sponsorship and, to support this, the app has a lot of models that are grouped by context. Here’s a list of the group of models and what do they represent:

sponsorship.py:

The Sponsorship model and all the related information to configure a new sponsorship application like programs, packages and benefits;

benefits.py:

List models that are used to configure benefits. Here you’ll find models that forces a benefit to have an asset or controls it maximum quantity;

assets.py:

Models that are used to configure the type of assets that a benefit can have;

sponsors.py:

Has the Sponsor model and all related information such as their contacts and benefits;

notifications.py:

Any type of sponsor notification that’s configurable via admin;

contract.py:

The Contract model which is used to generate the final contract document and other support models;

Regular users interact with the sponsors app in two places: the application flow (benefit selection at /sponsors/application/, then the form at /sponsors/application/new/) and the sponsorship dashboard at /users/sponsorships/, where sponsors view their sponsorships, update sponsor information, and upload required assets. Everything else is done through the admin action buttons on the Sponsorship and Contract models.

Required text asset configurations can set max_length (enforced on new input, and announced to the sponsor as “Up to N characters.”) and a placeholder example, e.g. Acme Corp is…, to keep submissions short. Limits of 100 characters or fewer render as a single-line input; longer limits as a 4-row textarea. A value already saved before a limit was added or lowered keeps saving until the sponsor edits it. Changes to a configuration reach existing sponsorships after running “Update related sponsorships” on the sponsorship benefit in the admin.

Required text assets whose internal name contains job-listing or job-posting (case and _/- insensitive, configurable with the SPONSOR_JOB_POSTINGS_ASSET_MARKERS environment variable) ask sponsors for one job per row (title, optional location, link) instead of a markdown textarea; the configured help text is replaced by row instructions. Sponsors can add as many rows as they need. Rows are stored in the same text asset, one job per line, as Title | Location | URL (or Title | URL without a location), which PyCon-site’s sponsor sync parses. Existing markdown values are pre-filled as rows where a link can be recovered.

Agreements#

The agreements app handles configurable order forms and custom contracts: preparation, revisions, signatures, and countersignatures. Management access at /agreements/ is controlled only by membership in these groups:

  • Agreements Editors can read agreement records, private programs, and terms; prepare, edit, and discard unoffered order and custom-contract drafts; and save or preview terms drafts. They cannot publish terms, change configuration, offer documents for others, revise offered documents, send signing links, record others’ signatures, or countersign.

  • Agreements Administrators have those preparation rights and can manage configuration, publish terms, offer documents, revise unsigned offers, send signing links, record signed copies, decline, withdraw, countersign, and resend executed copies.

Only Agreements Administrators may assign, replace, or remove a draft’s linked customer or counterparty account. Editors can prepare all other draft fields, including special terms, but their new drafts remain unlinked and edits preserve any existing account. Customers creating their own public orders are linked automatically. An Editor linked as the customer by an Administrator retains that customer’s offer and signing rights.

Migrations create both groups without permissions or members and remove the obsolete agreements.manage_agreement permission. After deployment, explicitly add the appropriate users to these groups in the Django admin. No users are enrolled automatically, and no programs, terms, pricing, or agreements are seeded. Direct permissions, other groups’ model permissions, is_staff, and superuser status do not grant agreement-management access. Even superusers must join an agreement group. Django admin access additionally requires an active staff account; the site workflow does not require is_staff.

Creating, changing, or deleting Django groups is restricted to superusers, including group names, permission assignments, and the admin bulk delete action. Delegated auth.add_group, auth.change_group, and auth.delete_group permissions do not authorize those writes. Superusers are trusted identity administrators who can provision agreement roles; they still need group membership to use the agreements workflow themselves.

Only superusers can grant or remove staff status, superuser status, groups (including both agreement roles), or direct permissions on user accounts. Staff with delegated user-administration permissions can edit, deactivate, reset passwords for, and delete ordinary accounts only. Accounts that hold any authority (superuser, staff, direct or group permissions, or either agreement role, even when inactive) are view-only to them, including password changes, the changelist active toggle, bulk deletion, and API key inlines.

Authenticated accounts outside both groups receive a permission-denied page for management views; anonymous visitors are directed to sign in. Linked customers retain their own order and signing rights independently of group membership, as do valid one-time signing links. Removing group membership removes management access on the next request; historical authorship or offering does not retain access. Agreement, order, and custom-contract records are read-only in the Django admin; use the site workflow to change their state.

Private agreement pages, including queues, terms listings, and contract and terms draft editors, send Cache-Control: private, no-store with immediate expiry and revalidation directives. Browsers and shared caches must not retain these responses or reuse them after session or role revocation. Anonymous public terms remain publicly cacheable.

Programs:

Agreements Administrators create and edit programs in the Django admin. A program’s name, catalog, prices, service descriptions, discounts, and document copy are database configuration, not application source. Programs are private by default. Enabling is public makes a program browsable at /agreements/programs/<slug>/ and lets signed-in customers start orders. Publish the cited terms separately before making a program public. Staff can prepare private orders for a linked customer without exposing the program’s catalog to everyone.

Packages:

Customers move through Services, Extras, Term, Organization, and Contacts & billing before reviewing the saved Order Form. Service comparisons expand beneath the tier cards; optional extras are visible on their own step. Back, Next, and browser history preserve entries, and validation reveals the field that needs attention. Account linkage (Administrators only) and contract adjustments are in a collapsed preparation section of Contacts & billing. New packages start empty unless an agreement is explicitly preselected. Choosing a tier adds that agreement to the package; select its individual base services separately. Base-service selections start empty and do not change the tier fee. Only selected services appear on the Order Form. Changing tiers can make a service unavailable; review the remaining selections before continuing. Extras included at that tier are not charged again. The live summary, saved order, and newly generated Order Form separate recurring and one-time fees, and show prepaid totals for multi-year terms. Existing frozen documents and fee snapshots are not rewritten. Review identifies the terms required by the selections. Without JavaScript, all sections appear together: use each service’s inclusion checkbox and review fees on the next page. Existing private-order access restrictions still apply. Existing orders retain their previously included base services on upgrade, using the frozen catalog for offered orders. Adding services to a catalog does not automatically add them to existing drafts. Signed documents and fees remain unchanged. If a catalog change makes a draft’s selected service unavailable, customer order lists and the staff order queue show Review selections instead of fees. Offered orders continue to use their frozen catalog.

Terms:

Create a set of terms in the admin, then edit its text at /agreements/terms/. Save a private draft or publish an immutable version with a label and change note. Unpublished sets open in the draft editor. Creating a set requires membership in Agreements Administrators and Django admin access; editors should ask an administrator. Once a version is published, its terms slug is read-only in the admin so cited addresses remain permanent. The draft editor is at /agreements/terms/<slug>/edit/draft/; edit is also a valid version label. Both agreement groups can compare any two published versions line by line at /agreements/terms/<slug>/compare/versions/, linked from the editor’s version list and from each terms page. By default it shows what the newest version changed. Publishing a version does not make it public: the separate Make published versions public setting controls that. Private versions are readable only by agreement group members and linked parties to documents citing them. An emailed signatory can review the cited versions through their signing link. Permanent addresses are /agreements/terms/<slug>/<version>/. Documents cite the address and version; integrity hashes are retained internally rather than shown to signatories. Public terms responses are publicly cacheable only for anonymous visitors. Responses to signed-in users are private and must not be stored by shared caches. Terms cited by any public program cannot be made private. Make every referencing program private first; both the terms editor and Django admin enforce this order.

Offering:

Making a draft ready to sign freezes its document, complete program configuration, fees, and cited terms versions. Later catalog or terms changes do not affect it. Withdrawing an unsigned offer returns it to draft and disables signing links; a new offer uses current configuration. Order signing and offering check current account authorization while holding the draft lock; a removed or reassigned customer cannot use a stale request.

Editing:

Before signing, Agreements Administrators can edit an offered document for that counterparty only. Each save records a revision and note. Signing requires the exact revision the signatory reviewed. Signed text cannot be edited. If another administrator saves first, the editor preserves your text and note, displays the current revision and a comparison, and asks you to review or merge before replacing it. Another intervening edit still requires a fresh review. Embedded images are not supported; editors report them as field errors before saving or previewing rather than leaving an unrenderable document.

Document display:

Pages and emails use the reference printed in the document when present. Browser views omit generated fingerprint metadata from older documents; their stored text and complete PDF/DOCX downloads remain intact.

Signing:

Use the linked python.org account, an emailed one-time link (valid for 14 days), or a signed PDF collected through another signing service or on paper. Linked customers and Agreements Administrators can upload signed copies. Copies stay in the database, not public media storage. If an invitation email fails, the page reports the failure and removes the undelivered, unused link. Existing invitations remain valid; send a new link to retry delivery. Signing-link pages, their cited terms, and their error responses omit analytics and advertising scripts so those scripts cannot report signing credentials. If the document changes during link signing, the refreshed form keeps the signatory’s entered name and title but requires acceptance of the new text. Confirmation shows the recorded signatory, even if different from the invitation.

Countersigning:

The staff queue lists documents awaiting the PSF’s signature. Countersigning can include a fully executed uploaded copy and emails that exact PDF, including external signatures and audit pages. Without an uploaded executed copy, the application generates the signed PDF. Delivery also includes PDFs of every terms version cited by that agreement, not newer published versions. Keep the full bundle: private online terms may be inaccessible after a one-time signing link is used. If rendering or email delivery fails, the countersignature still stands. Use Email signed copy on the executed agreement to retry delivery without signing again. This action is available only to Agreements Administrators. If the recorded signatory has no email address, execution still succeeds, but the page explicitly warns that nothing was emailed and hides the resend control. Download and deliver the signed PDF and cited terms separately.

Custom contracts:

Write one-off contracts at /agreements/contracts/new/, optionally incorporating versioned terms. Creation, editing, and deletion use this workflow; the Django admin is read-only. Linked customers return to their accessible agreement record after signing, uploading a copy, or withdrawing an offer.

New kinds:

Other applications can register an apps.agreements.registry.Kind for a model with an agreement field; see apps/agreements/orders/kinds.py.

Events#

TODO

Companies#

TODO

Success Stories#

TODO