build: switch to poetry

.github/workflows/deploy.yml

@@ -19,26 +19,29 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
       - name: Set up python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-          cache: pip
+          python-version-file: pyproject.toml
+          cache: poetry
 
       - name: Install dependencies
-        run: pip install -r requirements_dev.txt
+        run: poetry install
 
       - name: Run flake8
-        run: flake8 x_notes
+        run: poetry run flake8 x_notes
 
       - name: Run black
-        run: black x_notes --check
+        run: poetry run black x_notes --check
 
       - name: Run isort
-        run: isort x_notes -c --profile black
+        run: poetry run isort x_notes -c --profile black
 
       - name: Run tests
-        run: pytest tests
+        run: poetry run pytest tests
 
   deploy:
     name: Deploy

.github/workflows/fetch_notes.yml

@@ -19,14 +19,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
       - name: Set up python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-          cache: pip
+          python-version-file: pyproject.toml
+          cache: poetry
 
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run: poetry install --only main
 
       - name: Checkout previous version
         uses: actions/checkout@v4
@@ -38,7 +41,7 @@ jobs:
         run: cp -r previous/* output
 
       - name: Fetch notes
-        run: python -m x_notes
+        run: poetry run python -m x_notes
 
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@v4

.github/workflows/fetch_tweets.yml

@@ -19,14 +19,17 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
       - name: Set up python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
-          cache: pip
+          python-version-file: pyproject.toml
+          cache: poetry
 
       - name: Install dependencies
-        run: pip install -r requirements.txt
+        run: poetry install --only main
 
       - name: Checkout previous version
         uses: actions/checkout@v4
@@ -38,7 +41,7 @@ jobs:
         run: cp -r previous/* output
 
       - name: Fetch tweets
-        run: python -m x_notes.fetch_tweets
+        run: poetry run python -m x_notes.fetch_tweets
         env:
           TW_USER: ${{ secrets.USER }}
           TW_PASS: ${{ secrets.PASS }}

README.md

@@ -24,7 +24,7 @@ Initial setup:
 
 ```shell
 # Install python dependencies
-pip install -r requirements_dev.txt
+poetry install
 
 # Install ruby dependencies (Jekyll)
 bundle install
@@ -37,10 +37,10 @@ Then to run:
 
 ```shell
 # Fetch notes
-python -m x_notes
+poetry run python -m x_notes
 
 # Optional: fetch tweets
-python -m x_notes.fetch_tweets
+poetry run python -m x_notes.fetch_tweets
 
 # Start the development server
 cd output

pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "x-community-notes"
+version = "0.0.0"
+description = ""
+authors = ["Your Name <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+loguru = "^0.7.2"
+pynacl = "^1.5.0"
+requests = "^2.31.0"
+twscrape = "^0.12"
+
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.4.2"
+flake8 = "^7.0.0"
+isort = "^5.13.2"
+mypy = "^1.10.0"
+pytest = "^8.2.0"
+python-dotenv = "^1.0.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"