Skip to content

Commit e5d7edc

Browse files
committed
docs(readme): add README
1 parent 9be0105 commit e5d7edc

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# İTÜ Keplerbot
2+
3+
## Nedir?
4+
5+
İTÜ Keplerbot önceden zamanlanmış bir şekilde, herhangi bir tarayıcı kullanmadan tamamen HTTP üzerinden ders seçmenize yarar.
6+
7+
## Nasıl Kullanılır
8+
9+
1. Öncelikle sayfanın sağındaki 'Releases' kısmından uygulamanın son versiyonunu indirin. Windows kullanıyorsanız `itu-keplerbot.exe` adlı dosyayı, Linux kullanıyorsanız ise `itu-keplerbot` adlı dosyayı indirmelisiniz.
10+
11+
2. Şimdi gerekli bilgileri programa girmelisiniz. Bunu komut satırını kullanarak veya elle girerek yapabilirsiniz.
12+
13+
#### Komut Satırı İle Bilgi Girme ***ÖNERİLİR***
14+
15+
Aşağıdaki komut ile bilgileriniz girebilirsiniz
16+
17+
```bash
18+
itu-keplerbot make-config -u <KULLANICI_ADI> -p -<ŞİFRE> -t <SEÇİM_SAATİ> --crn <ALINACAK_CRNLER> --scrn <BIRAKILACAK_CRNLER>
19+
```
20+
21+
CRN almak veya bırakmak istemiyorsanız `--crn` / `--scrn` alanlarını yazmanıza gerek yoktur.
22+
23+
> [!WARNING]
24+
> Saat kısmını belirtilen formatta girmelisiniz -> "YIL-AY-GÜN SAAT:DAKİKA:SANİYE"
25+
26+
27+
##### Örnek Komut
28+
29+
```bash
30+
itu-keplerbot make-config -u bicer22 -p 123şifre -t "2025-02-10 14:00:00" --crn 22612,22614,22609 --scrn 20399
31+
```
32+
33+
Örneğin, eğer ders bırakmak istemiyorsanız:
34+
35+
```bash
36+
itu-keplerbot make-config -u bicer22 -p 123şifre -t "2025-02-10 14:00:00" --crn 22612,22614,22609
37+
```
38+
39+
Bu komut programı çalıştırdığınız yerde `config.json` adında bir dosya oluşturacaktır. Artık uygulama çalıştırılmaya hazır.
40+
41+
#### Manuel Bilgi Girme
42+
43+
İndirdiğiniz program ile aynı klasörde `config.json` adında bir dosya oluşturun.
44+
45+
Oluşturulan `config.json` aşağıdaki şablona uyacak şekilde doldurulmalıdır.
46+
47+
```json
48+
{
49+
"username": "<KULLANICI_ADI>",
50+
"password": "<ŞİFRE>",
51+
"time": "<YIL-AY-GÜN>T<SAAT:DAKİKA:SANİYE>+03:00", // Tarih ile saat arasındaki 'T', ve +03:00 öğelerine dikkat edin!
52+
"crn_list": ["<CRN>", "<CRN>", "<CRN>" ...], // Tırnak içerisinde, virgüllerle ayrılmış
53+
"scrn_list": ["<CRN>" ...]
54+
}
55+
```
56+
57+
##### Örnek `config.json`
58+
59+
```json
60+
{
61+
"username": "bicer22",
62+
"password": "123şifre",
63+
"time": "2025-02-10T14:00:00+03:00",
64+
"crn_list": ["22612", "22614", "22609"],
65+
"scrn_list": ["20399"]
66+
}
67+
```
68+
69+
Örneğin, eğer ders bırakmak istemiyorsanız:
70+
71+
```json
72+
{
73+
"username": "bicer22",
74+
"password": "123şifre",
75+
"time": "2025-02-10T14:00:00+03:00",
76+
"crn_list": ["22612", "22614", "22609"],
77+
"scrn_list": []
78+
}
79+
```
80+
81+
3. Bilgilerinizi girdikten sonra artık programı çalıştırmaya hazırsınız.
82+
83+
`config.json` dosyanızın uygulama ile aynı klasörde olduğundan emin olun. Komut satırından aşağıdaki komut ile uygulamayı çalıştırın.
84+
85+
```bash
86+
itu-keplerbot run
87+
```
88+
89+
Eğer JSON bilgi dosyanız farklı bir konumdaysa aşağıdaki komutu kullanabilirsiniz:
90+
91+
```bash
92+
itu-keplerbot run --config <JSON_DOSYASI_KONUMU>
93+
94+
```
95+
96+
> [!CAUTION]
97+
> Eğer bilgilere girdiğiniz saat geçmişteyse, uygulama hemen HTTP request atmaya başlayacaktır.
98+
99+
4. Uygulama artık çalışıyor, bol şans :pray: :rocket: !
100+
101+
## Teşekkür
102+
103+
Ata'nın yaptığı uygulama benim için önemli bir kaynaktı, teşekkürler :) [Yıldızlamayı unutmayın!](https://github.com/AtaTrkgl/itu-ders-secici)

0 commit comments

Comments
 (0)