update setup.md for mastodon version

.dockerignore

@@ -0,0 +1,2 @@
+venv/
+__pycache__/

.example.env

@@ -1,5 +1,3 @@
-MISSKEY_INSTANCE_ADDRESS="worldc.one"
+MASTODON_INSTANCE_ADDRESS=mastodon.social
-MISSKEY_ACCESS_TOKEN="BWbGlK6lWuUgXQpFM7igtmbZ30g6BOIc" # it is just a sample
+SENTENCES_DIRECTORIES=['./data/sentences/']
-
+WORDS_DIRECTORIES=["./data/words/"]
-SENTENCES_FILES=['./data/sentences/default.txt'] # Putting an absolute path is recommended
-# SENTENCES_DIRECTORIES=['./data/sentences/'] 

.gitignore

@@ -1,6 +1,6 @@
 venv/
 setting.py
-google_api.json
 __pycache__/
 .env
 docker-compose.yml
+token.secret

Dockerfile

@@ -2,12 +2,8 @@ FROM python:bookworm
 
 WORKDIR /app
 
-COPY src src
+COPY . .
-COPY main.py main.py
-COPY requirements.txt requirements.txt
 
-# RUN python -m venv venv
-# RUN source ./venv/bin/activate
 RUN pip install -r requirements.txt
 
 CMD ["python", "main.py"]

README.md

@@ -1,23 +1,33 @@
-# Misskey Random Sentence Bot
+# Mastodon Random Sentence Bot
 
 [![no github badge](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page/)
 
+A mastodon bot posting random sentences. Forked from [Misskey Random Sentence Bot](https://git.worldc.one/worldcone/misskey-random-sentence-bot)
+
 ## How to run with docker compose
 
 1. clone repo
+
 2. change setting
 
-```
+```bash
-# copy example compose file
+# copy compose file
-cp docker-compose.example.yml docker-compose.env
+cp docker-compose.example.yml docker-compose.yml
 
-# edit compose file
+# copy and edit .env
-vim .docker-compose
+cp .example.env .env
+vim .env
 ```
 
-3. RUN
+3. add your access token
-
+```bash
+touch token.secret
+vim token.secret
 ```
+
+4. RUN
+
+```bash
 docker compose up
 docker compose down
 ```
@@ -28,20 +38,20 @@ docker compose down
 
 2. make venv
 
-```
+```bash
 python3 -m venv venv
 source ./venv/bin/activate
 ```
 
 3. install modules
 
-```
+```bash
 pip install -r requirements.txt
 ```
 
-4. change setting
+4. change setting(changing the sentences and words directories as a absolute path is recommended)
 
-```
+```bash
 # copy example setting file
 cp .example.env .env
 
@@ -51,7 +61,7 @@ vim .env
 
 5. RUN
 
-```
+```bash
 python main.py
 ```
 

docker-compose.example.yml

@@ -6,9 +6,8 @@ services:
       context: .
       dockerfile: ./Dockerfile
     environment:
-      - MISSKEY_INSTANCE_ADDRESS=worldc.one
+      - MASTODON_INSTANCE_ADDRESS=${MASTODON_INSTANCE_ADDRESS}
-      - MISSKEY_ACCESS_TOKEN=BWbGlK6lWuUgXQpFM7igtmbZ30g6BOIc
+      - SENTENCES_DIRECTORIES=${SENTENCES_DIRECTORIES}
-      # - SENTENCES_FILES=['/data/sentences/default.txt']
+      - WORDS_DIRECTORIES=${WORDS_DIRECTORIES}
-      - SENTENCES_DIRECTORIES=['/data/sentences/']
     volumes:
-      - ./data:/data
+      - ./data:/app/data

main.py

@@ -1,7 +1,7 @@
 import os
 import random
 
-from misskey import Misskey
+from mastodon import Mastodon
 from dotenv import load_dotenv
 
 from src.choose_sentence import chooseSentence
@@ -10,7 +10,7 @@ from src.generate_sentence import generateSentence
 load_dotenv()
 
 # authentication to misskey
-misskey = Misskey(address=os.environ["MISSKEY_INSTANCE_ADDRESS"], i=os.environ["MISSKEY_ACCESS_TOKEN"])
+mastodon = Mastodon(access_token="token.secret", api_base_url=os.environ["MASTODON_INSTANCE_ADDRESS"])
 
 
 def writeRandomSentenceNote():
@@ -22,12 +22,12 @@ def writeRandomSentenceNote():
     # choose method and get sentence
     sentence: str = random.choice(choice_methods)()
 
-
     # write note
-    random_sentence_note = misskey.notes_create(text=sentence)
+    toot = mastodon.toot(sentence)
-    note_id = random_sentence_note["createdNote"]["id"]
+    toot_url = toot["url"]
-    note_text = random_sentence_note["createdNote"]["text"]
+    toot_content = toot["content"]
-    print(f"{note_id} | {note_text}")
+    toot_created_at = toot["created_at"]
+    print(f"{toot_created_at} {toot_url} : {toot_content}")
 
 
 if __name__ == "__main__":

requirements.txt

@@ -1,3 +1,2 @@
-Misskey.py
+Mastodon.py
 python-dotenv
-

setup.md

@@ -1,12 +1,10 @@
-# Misskey api key 발급받기
+# Get mastodon access token
-
+1. Preferences > Development > New Application
-1. 설정 - api 접속
+2. Set name of your app and enable `write`
-2. 엑세스 토큰 생성 - **"노트를 작성하거나 삭제합니다"** 켬
+3. Submit
-
-# docker compose crontab 설정하기
 
+# Set crontab with docker compose
+If you want your bot to post every hour:
 ```
-docker compose -f 프로젝트경로/docker-compose.yml up
+0 * * * * docker compose -f <your bot's path>/docker-compose.yml up
 ```
-
-을 crontab에 등록하시면 됩니다(아마도)

src/choose_sentence.py

@@ -8,32 +8,34 @@ from dotenv import load_dotenv
 
 load_dotenv() 
 
-_sentences=[]
+_sentences: list[str] =[]
-try:
+
+# try:
 sentence_files=[]
 
-    if os.environ.get("SENTENCES_FILE") and os.path.isfile(os.environ["SENTENCES_FILE"]):
+# if os.environ.get("SENTENCES_FILE") and os.path.isfile(os.environ["SENTENCES_FILE"]):
-        sentence_files.append(os.environ["SENTENCE_FILES"])
+#     sentence_files.append(os.environ["SENTENCE_FILES"])
 
-    if os.environ.get("SENTENCES_FILES"):
+# if os.environ.get("SENTENCES_FILES"):
-        sentence_files.extend(list(filter(os.path.isfile, json.loads(os.environ["SENTENCES_FILES"]))))
+#     sentence_files.extend(list(filter(os.path.isfile, json.loads(os.environ["SENTENCES_FILES"]))))
 
-    if os.environ.get("SENTENCES_DIRECTORY") and os.path.isdir(os.environ["SENTENCES_DIRECTORY"]):
+# if os.environ.get("SENTENCES_DIRECTORY") and os.path.isdir(os.environ["SENTENCES_DIRECTORY"]):
-        sentence_files.extend(glob(f'{os.environ["SENTENCES_DIRECTORY"]}*.txt'))
+#     sentence_files.extend(glob(f'{os.environ["SENTENCES_DIRECTORY"]}*.txt'))
 
-    if os.environ.get("SENTENCES_DIRECTORIES"):
+# if os.environ.get("SENTENCES_DIRECTORIES"):
-        # 원라인 똥 뿌직(터져도 책임 안짐)
+
+# get the directories including the sentences files
 sentence_files.extend([glob(f"{_dir}*.txt") for _dir in filter(os.path.isdir, json.loads(os.environ["SENTENCES_DIRECTORIES"]))][0])
 
 for sentence_file in sentence_files:
     with open(sentence_file, "r") as f:
         _sentences.extend(f.readlines())
-except:
+# except:
-    e = sys.exc_info()[1]
+#     e = sys.exc_info()[1]
-    _sentences = [f"에러발생(진짜임): {e}"]
+#     _sentences = [f"Runtime error(Please contact to the admin): {e}"]
+
 
 # choose random sentence in google spread sheet
 def chooseSentence() -> str:
     # choice random sentence
     return random.choice(_sentences).replace("\\n","\n")
-