Как правильно выложить проект Python на GitHub?

Question

[Олег]

Есть простенький проект на python. Компилировал с помощью pyinstaller. Соответственно есть сам код в .py и две папки build (как я понимаю, тут рабочие файлы, которые для самой программы ненужны) и distr (непосредственно исполняемый файлы).
Есть также компиляция кода в один файл .exe
Планирую использовать GitHub как портфолио, чтобы можно было показать потенциальным работодателям, чем я вообще занимаюсь.
Так вот, вопрос - как правильнее залить проект на Github?
1) Залить только код .py без всего остального
2) Залить код .py +.exe файл самой программы
3) Залить код .py + обе папки build и distr
4) Залить код .py + одну из папок build или distr (если да, то какую?)

Comments

[Алан Гибизов]

Я бы посмотрел, как делают другие, и из вариантов выбрал бы тот, который мне кажется правильным. А если в дальнейшем получил бы обратную связь от работодателей, то по ним бы и исправил.

[Олег]

Алан Гибизов, как делают другие - это было первое, что я посмотрел) Но у других - очень большие проекты, в которых какое-то огромное количество папок. Вероятно, сам проект их требует.
Но у меня то простая программка. И тут вопрос - нужна для ГитХаьа папка build вообще? И нужны ли исполняемые файлы. Будет ли достаточно одного кода и не будет ли дурным тоном "заливать" вместе с кодом и exeшник

Answer 1

[soremix]

Никто не льет exeшники в репозитории.

Заливаете только .py файл + requirements.txt, ну и другие модули свои, если есть.
В описании можно указать способ использования через Python.
Билд можно засунуть во вкладку Releases. Но нужно учитывать то, что компилировать питон в ехе не самая лучшая идея. Ну и работодатель уже может сам проверить исходный код, билд скрипта здесь не нужен

Comments

[Олег]

Спасибо! Модули pip_овские. requirements.txt - вроде нет)
Простите, а как еще можно скомпилировать питон? Если это по сути просто пользовательская прога, в данном случае?)

[soremix]

Олег Дзен, использовать изначально компилируемый язык. Пользователи банально офигеют, когда скачают .exe файл, который светится на вирустотале и блокируется антивирусами

[Hemul GM]

Питоне не компилируется. "Билд", через pyinstaller - это упаковка всех нужных файлов, включая и интерпретатор, внутрь одного файла ехе. При запуске производится распаковка и обычный запуск py файла.

[DevMan]

на самом деле много кто льёт.
но это неверный подход.

[soremix]

DevMan, об этом и речь, для бинарников есть специальный раздел, лить скомпилированные версии в репо - ме

[DevMan]

SoreMix, совершенно верно.
я лишь уточнил что желающих сделать наоборот - овердофига.

Answer 2

[sergeyfilippov4]

Заливай исходный код программы, потому что по exe файлу ничего не скажешь

Comments

[Олег]

То есть в папках ни в build, ни в distr смысла нет?
Если в проге использовплись модули, то по коду тоже все всё поймут?

[Дмитрий]

wget https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
mv Python.gitignore .gitignore
git init
git add .
git commit -S -m "message"
git push

[Олег]

Дмитрий, сорри. Но это не совсем объясняет какие конкретно файлы будет правильнее залить на ГитХаб помимо кода .py. Компилировал с помощью pyinstaller
"Как" загрузить я знаю (можно еще через GitHub desktop, например) . Вопрос "что" именно грузить)

[Дмитрий]

Какие именно файлы не пушить определяется в файле .gitignore, добрые люди уже создали такой файл для питонячих проектов, где указан минимальный набор правил.

[Олег]

Дмитрий, я новичок в питоновских делах) Потому и говорю, что тот файл, который Вы выложили выше мне ничего не объясняет) Простите

[Дмитрий]

Олег Дзен, Очень советую к ознакомлению

[Олег]

Дмитрий, Спасибо! В моем случае нужно заливать только .py )

[Дмитрий]

Олег, Лучше использовать уже готовый файл и дописать в него свои правила, чем писать велосипед.

[Олег]

Дмитрий, оказывается все еще проще - на самом GitHube можно выбрать gitignore_Python. Все что не нужно грузиться не будет само)
Спасибо)