indygreg / indygreg/PyOxidizer

Add examples to documentation

Open
#27 12 comments 5 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
6.2k
Forks
256
PR merge metrics
No merged PRs in 30d

Description

First of all, congrats on your project, looks promising.

However, as some have pointed out, there are a TON of libraries for packaging python projects (none ideal as you point out).

I have used a bunch of them, and always, always, there is a lack of real example applications. Usually docs go like this:

Step 1: run `packager create app`
Step 2: here are all the crazy settings you can set!

That means its very hard for someone without in depth knowledge of packaging/binaries/links etcetera to even start using the packaging tools.

It would be awesome if you could create a repo with examples. Real examples like, `i want to create an app that opens a gooey interface that loads a pandas dataframe and a pickle scikit learn model and creates predictions on arbitrary user submitted data`.

And I know, why dont i do it? because i have checked your docs and i honestly dont know how i would even start!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing documentation and the `packager create app` workflow described in the issue. Define a small set of realistic Python application examples, including a Gooey interface, pandas dataframe, and scikit-learn pickle model, then document how each is packaged and run. Done means the examples are available in a repository or documented location and can guide a newcomer from project creation to a working application.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.