Home

Welcome to the Pynventory wiki.

Use this wiki to get the app running, make safe contributions, and follow the project's current direction.

Start here

New contributors should start with these pages. This path takes you from setup to a small tested pull request.

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

1. Getting started - install Python, create a venv, run the app.
2. Git & development workflow - how we work together: branching, PRs, code review.
3. Code style guide - naming, Ruff, what good code looks like here.
4. Testing guide - how to test your change before opening a PR.
5. FAQ - quick answers to common questions.

For a full walkthrough of your first contribution, see the Getting started page.

Useful pages

• Troubleshooting - fixes for common problems.
• Architecture & roadmap - project structure and future plans.
• Release guide - how and when versions are tagged.
• Useful links - external resources for Python, Git, SQLite, and code quality.

Current project phase

Pynventory is currently focused on improving the terminal-based inventory app before moving toward a web interface.

For more detail, see the Architecture & roadmap page.

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.

Issues · Labels · Project board

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