User Manual#

Installation Guide

Step-by-step instructions on installing PyPackIT in a new or existing repository, along with guides on how to maintain and upgrade an existing installation.

Installation
Quickstart Guide

An introductory tutorial that walks you through a simple development cycle with PyPackIT, from submitting an issue ticket to deploying a new release.

Quickstart
Control Center

A detailed explanation of your repository’s control center and its feature, along with a full reference of all its available options.

Control Center
Repository

Introduction to your Git/Github repository, its directory structure, contents, and settings, along with guides on how to customize and manage it.

repo/index
Issue Tracking System
Issue Tracking System
Branch Types

A detailed overview of the different branch types created, managed, and used by PyPackIT.

branches
Commit Types

A detailed overview of the different commit types created, managed, and used by PyPackIT.

commits
Label Types

A detailed overview of the different label types created, managed, and used by PyPackIT.

labels
Workflows

An extensive summary of the continuous integration, deployment, and testing (CI/CD/CT) workflows implemented by PyPackIT, and how they are used to fully automate the entire software development process of your project.

workflows/index
Fundamentals

Detailed explanation of fundamental concepts and features in PyPackIT, to help you understand and and utilize the full potential of your project’s development environment and workflows.

fundamentals/index
Usage

An in-depth guide on how to use PyPackIT’s various features and functionalities in your software development process.

usage/index
Technical

Technical details on PyPackIT’s architecture, implementation, and infrastructure, along with instructions on how to update, extend, and customize it.

technical/index
Development Cycle

A step-by-step guide to various cycles of your software development process with PyPackIT.

dev/index
Package

Instructions on developing your Python package with PyPackIT.

package/index
Test Suite

Instructions on developing the test suite of your package with PyPackIT.

tests/index
Website

Instructions on developing the documentation website of your project with PyPackIT.

website/index
Infrastructure

This technical guide provides detailed information on the implementation details and other technical aspects of PyPackIT. It is more geared towards developers who are interested in contributing to PyPackIT, or auditing the source code for security and other purposes.

A comprehensive overview of PyPackIT’s architecture, implementation, and infrastructure.

infrastructure/index