Skip to content
Joel B edited this page May 9, 2026 · 31 revisions

Welcome to the Pynventory wiki.

This wiki explains how to set up the project, contribute safely, and understand where the project is going next.

Start here

If you are new to the project, start with these pages in order:

  1. Local development setup
  2. Your first contribution
  3. Manual testing guide
  4. FAQ

These pages should help you get the app running, make a small first change, test it, and understand the basic contribution flow.

Contributor workflow

Use these pages when working on issues, branches, pull requests, and reviews:

Most work should start from a GitHub issue, happen on a branch, and be merged through a pull request.

Current project phase

Right now, the project is focused on improving the terminal-based inventory app before moving toward a web interface.

Current priorities:

  • improve inventory behavior
  • add quantity and selling features
  • add search and better list output
  • introduce simple automated tests
  • keep the contributor workflow clear and beginner-friendly

For more detail, see the Project roadmap.

Project management

Use GitHub Issues to report bugs, suggest features, ask tracked questions, and discuss planned work.

Before starting work, check whether an issue already exists. If none exists, create one, add the right label, and link it to the project board.

Project knowledge

Use these pages when you need background information:

If a project decision affects future contributors, document it in the wiki or link to the GitHub issue where the decision was made.

Clone this wiki locally