python project prep

DevOps Community

Skill notes

Workflow Overview

Clarify requirements → Understand project scope and constraints Plan architecture → Design structure appropriate to project type Initialize structure → Create directories and base files Configure tooling → Set up dev tools, linting, testing Document → README, CONTRIBUTING, API docs as needed

Step 1: Clarify Requirements

Gather essential information before scaffolding: Question · Why it matters Project type? (CLI, library, web app, script collection) · Determines structure and entry points Distribution target? (PyPI, internal, single-use) · Affects packaging and versioning Python version constraints? · Influences syntax and dependency choices

Project Type Patterns

Library/Package (for PyPI or internal distribution): CLI Application: Web Application (FastAPI/Flask): Script Collection (utilities, automation): See references/project-templates.md for detailed templates with all standard files.

Use the Init Script

Run the bundled initialization script for quick setup: The script creates the directory structure, pyproject.toml, and base files.

Manual Initialization

If customization is needed, create structure manually:

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
DevOps
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@tomevault-io · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
Python
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

01
Step 1: Clarify Requirements

Gather essential information before scaffolding: Question · Why it matters Project type? (CLI, library, web app, script collection) · Determines structure and entry points Distribution target? (PyPI, internal, single-use) · Affects packaging and versioning Python version constraints? · Influences syntax and dependency choices

02
Step 2: Plan Architecture

Step 2: Plan Architecture

03
Step 3: Initialize Structure

Step 3: Initialize Structure

04
Step 4: Configure Tooling

Step 4: Configure Tooling

05
Step 5: Document

Step 5: Document

06
Step 6: Verify Setup

Run these checks after initialization:

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.