set up wheels system (#18)

Author: Pyreko

.github/workflows/build.yml

@@ -0,0 +1,99 @@
+# A simple workflow to build a wheel + binary.
+
+name: build
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The version to upload. Defaults to 'nightly' if not specified."
+        required: false
+        default: "nightly"
+
+env:
+  PYTHON_VERSION: "3.12"
+
+jobs:
+  build:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: "pip"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build wheel
+        run: hatch build -t wheel
+
+      - name: Upload wheel if not nightly
+        if: ${{ inputs.version }} == "nightly"
+        uses: softprops/action-gh-release@v2.0.9
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          prerelease: true
+          tag_name: "nightly"
+          draft: false
+          fail_on_unmatched_files: true
+          name: ${{ inputs.version }} Release
+          files: |
+            ./dist/*
+
+      - name: Upload wheel if not nightly
+        if: ${{ inputs.version }} != "nightly"
+        uses: softprops/action-gh-release@v2.0.9
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          prerelease: false
+          tag_name: ${{ inputs.version }}
+          draft: true
+          fail_on_unmatched_files: true
+          name: ${{ inputs.version }} Release
+          body: |
+            <!-- Rest of summary -->
+
+            ---
+
+            ## Features
+
+
+            ## Changes
+
+
+            ## Bug Fixes
+          files: |
+            ./dist/*
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    if: ${{ inputs.version }} != "nightly"
+    environment:
+      name: pypi
+      url: https://pypi.org/p/yt-community-post-archiver
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4.1.1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: "pip"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build wheel
+        run: hatch build -t wheel
+
+      - name: Upload to pypi
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/routine_check.yml .github/workflows/test.yml.github/workflows/routine_check.yml renamed to .github/workflows/test.yml

@@ -12,6 +12,9 @@ on:
 
 jobs:
   test:
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
     timeout-minutes: 30
     runs-on: ubuntu-latest
     steps:
@@ -21,14 +24,19 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11.7"
+          python-version: ${{ matrix.python-version }}
           cache: "pip"
 
-      - name: Install dependencies
-        run: pip install -r requirements.txt
-
-      - name: Install pytest
-        run: pip install pytest
+      - name: Install hatch
+        run: pip install hatch
 
       - name: Run tests
-        run: pytest
+        run: hatch test
+
+      - name: Test building
+        run: hatch build -t wheel
+
+      - name: Test running the binary
+        run: |
+          pip install dist/*.whl
+          yt-community-post-archiver -h

.gitignore

@@ -152,6 +152,9 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+# ruff
+**/.ruff_cache
+
 # PyCharm
 #  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

README.md

@@ -9,27 +9,62 @@ me know if it's broken, and if I have the bandwidth I'll try and fix it.
 
 ## Usage
 
+### From the wheel
+
+This is _probably_ what you're going to want. From [Releases](https://github.com/Pyreko/yt-community-post-archiver/releases)
+install a wheel using Python.
+
+1. [Install Python](https://www.python.org/downloads/).
+
+2. Download one of the `.whl` files from [Releases](https://github.com/Pyreko/yt-community-post-archiver/releases)
+
+3. Install the wheel file. For example, if the file you downloaded is called `yt_community_post_archiver-0.1.0-py3-none-any.whl`:
+
+    ```shell
+    pip install yt_community_post_archiver-0.1.0-py3-none-any.whl
+    ```
+
+4. Run `yt-community-post-archiver`. For example:
+
+   ```shell
+   yt-community-post-archiver "https://www.youtube.com/@PomuRainpuff/community"
+   ```
+
+   This will spawn a headless Chrome instance (that is, you won't see a Chrome window) and download all posts
+   it can find from the provided page, and save text metadata + images in an automatically created folder called
+   `archive-output` in the same directory the program was called in. Note this will take a while!
+
+   For info on the options you can use, run with `--help`:
+
+   ```shell
+   yt-community-post-archiver --help
+   ```
+
+### From the repo
+
 1. Clone the repo.
 
-2. (Optional) Create and source a venv:
+2. [Install Python](https://www.python.org/downloads/).
+
+3. (Optional) Create and source a venv:
 
    ```shell
    python3 -m venv venv
    source venv/bin/activate
    ```
 
-3. (Optional) Download the dependencies in `requirements.txt` if you do not already have them:
+4. (Optional) Install `hatch` if you do not already have it:
 
    ```shell
-   pip3 install -r requirements.txt
+   pip3 install hatch
    ```
 
-4. Make sure the computer you're running this on has Chrome or Firefox, as it uses a browser to grab posts.
+5. Make sure the computer you're running this on has Chrome or Firefox, as it uses a browser to grab posts.
 
-5. Run `archiver.py`. For example:
+6. Run the archiver using `hatch run yt-community-post-archiver`. For example:
 
    ```shell
-   python3 archiver.py "https://www.youtube.com/@PomuRainpuff/community"
+   hatch run yt-community-post-archiver "https://www.youtube.com/@PomuRainpuff/community"
    ```
 
    This will spawn a headless Chrome instance (that is, you won't see a Chrome window) and download all posts
@@ -39,15 +74,15 @@ me know if it's broken, and if I have the bandwidth I'll try and fix it.
    For info on the options you can use, run with `--help`:
 
    ```shell
-   python3 archiver.py --help
+   hatch run yt-community-post-archiver --help
    ```
 
 ### Example
 
 For example, let's say I ran:
 
 ```shell
-python3 archiver.py "https://www.youtube.com/@IRyS/community" -o "output/testing" -m 1  
+hatch run yt-community-post-archiver "https://www.youtube.com/@IRyS/community" -o "output/testing" -m 1  
 ```
 
 This runs the archiver, directed to `https://www.youtube.com/@IRyS/community`, saving to `output/testing`, and gets
@@ -83,7 +118,7 @@ and an image file (`Ugkxbg1AcEsx5spUWRjgtF8cvXDDgUIW1SFo-0`).
 If you want to set the save location, then use `-o`:
 
 ```shell
-python3 archiver.py "https://www.youtube.com/@IRyS/community" -o "/home/me/my_save"
+hatch run yt-community-post-archiver "https://www.youtube.com/@IRyS/community" -o "/home/me/my_save"
 ```
 
 ### Logging in
@@ -108,7 +143,7 @@ By default this will use the default profile name; if you need to override this
 Another method is if you have a Netscape-format cookies file, which you can pass the path with `-c`:
 
 ```shell
-python3 archiver.py "https://www.youtube.com/@WatsonAmelia/community" -c "/home/me/my_cookies_file.txt"
+hatch run yt-community-post-archiver "https://www.youtube.com/@WatsonAmelia/community" -c "/home/me/my_cookies_file.txt"
 ```
 
 Note that I've personally found this much flakier and occasionally fails in certain situations. It should
@@ -120,7 +155,7 @@ work fine if you just want to get a few posts though, and already have a cookie
 The default driver is Chrome, but Firefox should work as well.
 
 ```shell
-python3 archiver.py "https://www.youtube.com/@PomuRainpuff/community" -d "firefox"
+hatch run yt-community-post-archiver "https://www.youtube.com/@PomuRainpuff/community" -d "firefox"
 ```
 
 ## Notes

pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yt-community-post-archiver"
+dynamic = ["version"]
+description = 'Archives YouTube community posts.'
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+keywords = ["youtube", "community", "posts", "archiver", "cli"]
+authors = [{ name = "Pyreko", email = "25498386+Pyreko@users.noreply.github.com" }]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "attrs==24.2.0",
+  "certifi==2024.7.4",
+  "charset-normalizer==3.3.2",
+  "h11==0.14.0",
+  "idna==3.7",
+  "outcome==1.3.0.post0",
+  "PySocks==1.7.1",
+  "requests==2.31.0",
+  "selenium==4.16.0",
+  "sniffio==1.3.0",
+  "sortedcontainers==2.4.0",
+  "trio==0.26.2",
+  "trio-websocket==0.11.1",
+  "urllib3==2.1.0",
+  "wsproto==1.2.0",
+  "filetype==1.2.0",
+  "pillow==10.4.0",
+  "beautifulsoup4==4.12.3 ",
+]
+
+[project.urls]
+Documentation = "https://github.com/Pyreko/yt-community-post-archiver#readme"
+Issues = "https://github.com/Pyreko/yt-community-post-archiver/issues"
+Source = "https://github.com/Pyreko/yt-community-post-archiver"
+
+[tool.isort]
+profile = "black"
+
+[tool.ruff]
+line-length = 140
+
+[tool.hatch.version]
+path = "src/yt_community_post_archiver/__about__.py"
+
+[tool.hatch.envs.hatch-test]
+dependencies = ["pytest~=8.3"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/yt_community_post_archiver"]
+
+[project.scripts]
+yt-community-post-archiver = "yt_community_post_archiver:main"
+
+[tool.hatch.build.targets.binary]
+yt-community-post-archiver = "yt_community_post_archiver:main"
+python-version = "3.12"
+pyapp-version = "0.24.0"

requirements.txt

@@ -1,18 +0,0 @@
-attrs==24.2.0
-certifi==2024.7.4
-charset-normalizer==3.3.2
-h11==0.14.0
-idna==3.7
-outcome==1.3.0.post0
-PySocks==1.7.1
-requests==2.31.0
-selenium==4.16.0
-sniffio==1.3.0
-sortedcontainers==2.4.0
-trio==0.26.2
-trio-websocket==0.11.1
-urllib3==2.1.0
-wsproto==1.2.0
-filetype==1.2.0
-pillow==10.4.0
-beautifulsoup4==4.12.3 

src/yt_community_post_archiver/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

src/yt_community_post_archiver/__init__.py

@@ -0,0 +1,4 @@
+from yt_community_post_archiver.archiver import main
+
+if __name__ == "__main__":
+    main()

src/yt_community_post_archiver/__main__.py

@@ -0,0 +1,4 @@
+from yt_community_post_archiver.archiver import main
+
+if __name__ == "__main__":
+    main()