Giti kasutamine PyCharmis

Siin juhendis eeldatakse, et teil on Giti salv loodud. Selle jaoks leidub juhend siin: Giti kasutamine TTÜs

Welcome aken

../../_images/pycharm_setup_welcome.png

Uus projekt Gitist

Loome uue projekti oma GitLab salvest klikates Get from VCS:

../../_images/pycharm_git_vcs.png

Giti salve asukoht

Määrake oma salve asukoht. See on kujul: https://gitlab.cs.taltech.ee/UNIID/iti0102-2024.git

UNIID asenda oma Uni-ID-ga.

../../_images/pycharm_git_repository.png

Te võite oma salve asukoha kopeerida ka GitLab keskkonnast, vajutades oma GitLabi projektis (UNIID/iti0102-2024) nupule Clone ning valides sealt ‚Clone with HTTPS‘. NB! UNIID asemel on sinu Uni-ID!

../../_images/clone.png

Salve kloonimine uusimas Pycharmi versioonis

Uusimas Pycharmi versioonis on vaja genereerida token uuest serverist projekti kloonides. Selleks vajuta esmalt Generate… nupule.

../../_images/generate.png

Seejärel vajuta Add new token nupule.

../../_images/add_new_token.png

Pane oma tokenile teemakohane nimi, lisa rist Expiration date nupule, et see lahter näeks välja nagu allolev pilt ning lisa linnuke api ning read_user lahtrisse ning seejärel vajuta sinist nuppu Create personal access token.

../../_images/fill_token_information.png

Kopeerimismärgi alt saad oma uue tokeni ning salvesta see vabalt valitud tekstiredaktorisse (näiteks Notepad, TextEdit), sest hiljem pole seda võimalik Gitlabist kopeerida.

../../_images/copy_access_token.png

Täida kopeeritud tokeniga lahter ja vajuta Log in.

../../_images/pycharm_token.png

Salve kloonimine vanemates versioonides

Kui olete salve asukoha sisestanud, vajutage akna all leiduvat Clone nuppu. Teilt küsitakse kasutajanime ja parooli:

../../_images/pycharm_git_login.png

Log In nupule vajutades laeb PyCharm teie projekti arvutisse alla ning avab selle arendamiseks. Kui mingil põhjusel läheb parool kaks korda valesti ning logimise aken kaob ilma teateta, tasuks lihtsalt uuesti proovida

Kausta loomine

Iga ülesanne algkursuse aines läheb eraldi kausta. Kausta nimi on näidatud ülesande juures (näiteks: ex99_test). Suured ja väikesed tähed on erinevad! All olevad pildinäited on ex99_test näitega.

Hoiatus

ex99_test on pseudoülesanne, sellist ülesannet reaalselt ei eksisteeri ning tester ei tagasta midagi. Kui soovite kaasa proovida, katsetage esimese nädala ülesande peal.

Kaust looge projekt nime peal parema hiire klikiga, sealt New -> Directory:

../../_images/pycharm_create_dir.png

Kausta nimeks läheb ex99_test:

../../_images/pycharm_create_dir_dialog.png

Faili loomine

Ülesande lahendus läheb faili. Ülesande tekstis on kirjas, mis on faili nimi. Siin näites paikneb ülesande lahendus ex99_test/hello.py failis.

Nüüd loome kausta sisse faili (ehk siis ülesande sisse lahenduse). Paremklikk kausta ex99_test peal, sealt New -> Python File

../../_images/pycharm_create_file.png

Paneme faili nimeks hello. Tähelepanu, faililaiend .py lisatakse automaatselt!

../../_images/pycharm_create_file_dialog.png

Faili ettevalmistamine (add) Giti lisamiseks

Kui loote faili, küsib PyCharm teilt, kas soovite selle ette valmistada Giti lisamiseks. Mõistlik on siin vastata positiivselt.

../../_images/pycharm_add_file_to_git.png

Vajadusel saab ka käsitsi lisada, failile parem hiireklikk -> Git -> Add

Faili üles laadimine Giti

Selleks, et tehtud muudatus jõuaks GitLab serverisse (ja automaattester seda hinnata saaks), tuleb teha kaks asja: commit ja push.

Kausta peal parem hiireklikk -> Git -> Commit directory…

../../_images/pycharm_commit_directory.png

Avaneb dialoog, kus saab eelvaadelda üleslaetavat koodi:

../../_images/pycharm_commit_dialog.png
Tasuks järgida selliseid asju:

  • Tekkinud aknaosa üleval on failide nimekiri, mis üleslaadimisele lähevad. Mõistlik oleks laadida vaid vajalikud py-failid. Kõiksugu PyCharm konfiguratsioonifailid jms võivad tekitada segadust. Teisest küljest, kui kasutate kooliarvutit ja koduarvutit kordamööda, on võib-olla mõistlik ka PyCharmi konfiguratsioon Giti panna.

  • Commit Message võiks olla mõistlik. Me otseselt seda ei jälgi. Samas on hea ennast harjutada mõistlikke kommentaare lisama ning ka endal on pärast kergem ajaloost otsida. Häid stiilinäiteid saab nt siit: https://chris.beams.io/posts/git-commit/

  • Commit nupu noolekesest valida Commit and Push

Giti seaded

Kui te veel pole seda sammu täitnud, siis küsitakse teilt nime ja emaili:

../../_images/pycharm_git_name_dialog.png

Failide üleslaadimine (push)

Lõpuks kuvatakse viimane samm (push). Seal vajutage lihtsalt Push:

../../_images/pycharm_push_dialog.png

Kiirnupud Git kasutamiseks

Kui avatud PyCharm projekt kasutab Git’i, siis tekib selle akna üleval vasakule regiooni rippmenüü, kus on tüüpilisemad git käsklused.

../../_images/pycharm_git_buttons.png

Kui kasutate vanemat PyCharm versiooni (või classic UI), tekivad üles paremasse nurka nupud samadest käsklustest.

../../_images/pycharm_git_buttons_old.png
Nool alla (Update project, vanas PyCharmis sinine nool alla)

Tirib GitLabist tehtud muudatused sinu arvutisse. On kasulik, kui soovid koolis tehtud töid koju alla laadida või vastupidi. Sellele klikates avaneb kaks varianti: Rebase viib sinu seisu pilves olevate muudatuste otsa, Merge aga üritab kokku liita erinevused mõlemate vahel. Üldjuhul oleme kursuse jooksul algajatel soovitanud kasutada Rebase, kuna see tekitab vähem segadusi. Lisavaatamist

Ring joone sees (Commit…, vanas PyCharmis roheline linnuke)

Commit ning kõige tihedamini kasutatum Git’i funktsionaalsus. See on Git’i versioon salvestamisest, kus säilitatakse praegune seis koos lühikirjeldusega.

Nool üles (Push, vanas PyCharmis roheline nool üles)

Push laeb üles kõik kohalikud commitid. PyCharm võimaldab commit ajal koheselt ka push teha, seega seda nuppu ei ole vaja ilmtingimata eraldi vajutada.

Järgnevad nupud esinevad classic UI peal või vanemates PyCharm versioonides.

Kell

Näitab commitide ja hargude ajalugu. Neile peale klikates saab võrrelda muutusi praeguse seisuga.

Rollback

Taastab failide seisu eelmise commit’ini.