Python, MySQL i github

Question

Jeżeli moja aplikacja w Pythonie, którą zamierzam wysłać na githuba, łączy się z bazą danych, w której powinny być informacje potrzebne do pracy programu (ja pisząc program po prostu je wstawiam do bazy danych), to czy mam poinformować użytkownika w pliku readme.md​​​​​​, jak ma wstawić te potrzebne dane do bazy danych? Czy może to zbyt skomplikowane i jakoś inaczej to rozwiązać? 

Answer 1

(Fajnie, gdybyś powiedział co to za program, co w zasadzie robi. Bo w zależności od tego, moja odpowiedź może się zmienić.)

Jako absolutne minimum, powinieneś mieć zdokumentowaną schemę, tak. Nie słownie, tylko od razu SQLowo.

Lepiej, jak napiszesz przy okazji od razu skrypt który przygotuje schemę (i opcjonalnie np wypełni przykładowymi danymi) i skrypt wrzucający dane.

Jeszcze lepiej, jeśli użyjesz standardowego mechanizmu migracji zamiast ręcznie pisać cokolwiek. W sensie użytkownik bierze Twoje repo, odpala `python manage.py migrate` (django) lub `alembic upgrade` (sqlalchemy) lub coś podobnego.

A swoją drogą, czy w ogóle na pewno to musi być koniecznie MySQL? Bo to też trochę niefajne, wymuszać konkretną bazę (i u nas większość by wolała podpiąć do istniejącego clustra postgresowego :P Albo lokalnego sqlite'a do eksperymentów). I to też coś co od lat biblioteki do baz rozwiązują "out of the box".

Comments

Program pobiera dane z bazy, a następnie przetwarza je i wyświetla użytkownikowi (to tak w skrócie). Równie dobrze mógłby pobierać z pliku, ale chciałem trochę "utrudnić". Nie musi to być koniecznie mysql, przyszedł mi na myśl bo go już znam