Skip to content

README.md

Latest commit

 

History

History
111 lines (84 loc) · 2.93 KB

README.md

File metadata and controls

111 lines (84 loc) · 2.93 KB

The PSF Organizers Kit

The Python Software Community and Conference Organizers Kit is a comprehensive resource developed by members of the Python Software Community to support individuals and groups in organizing Python-related events and fostering local communities. Adapted from materials by PyLadies Global, this kit offers practical guidance for both new and experienced organizers.

Prerequisites

Before getting started, you'll need to install the following tools:

Required

  • uv - Python package manager 
    # macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# or with Homebrew
brew install uv

Optional

  • just - Command runner (provides convenient shortcuts)

    # macOS
brew install just

# Linux
cargo install just
# or see https://github.com/casey/just#installation for other options

  • lychee - Link checker (for validating links in documentation)

    # macOS
brew install lychee

# Linux
cargo install lychee

Quick Start

  1. Clone the repository:

    git clone https://github.com/psf/organizer-toolkit.git
cd organizer-toolkit

  2. Install dependencies:

    just install
# or without just:
uv sync

  3. Start the development server:

    just serve
# or without just:
uv run mkdocs serve

  4. Open your browser to http://127.0.0.1:8000

Available Commands

Run just to see all available commands, or use the equivalent uv commands directly:

Command uv Equivalent Description
just install uv sync Install dependencies
just serve uv run mkdocs serve Start development server (port 8000)
just serve-port PORT uv run mkdocs serve --dev-addr=127.0.0.1:PORT Start dev server on specific port
just build uv run mkdocs build Build the documentation site
just validate uv run mkdocs build --strict Build with strict validation
just link-check lychee --cache --verbose . Check all links (requires lychee)
just check — Run all quality checks
just deploy uv run mkdocs gh-deploy --force Deploy to GitHub Pages
just clean — Clean generated files and cache
just help — Show detailed help message

Common Workflows

Development:

just install && just serve
# or without just:
uv sync && uv run mkdocs serve

Pre-publish validation:

just check
# or without just:
uv run mkdocs build && lychee --cache --verbose .

Clean build:

just clean && just build
# or without just:
rm -rf site/ && uv run mkdocs build

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

License

This project is maintained by the Python Software Foundation.