vk-scripts 1.1.1__tar.gz → 1.3.0__tar.gz

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/.github/workflows/ci.yml

@@ -22,8 +22,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7
-        with:
-          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v7
         with:
@@ -31,10 +29,14 @@ jobs:
       - name: Run black
         uses: psf/black@stable
 
-  test:
+  test_python:
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
+        python-version:
+          - '3.11'
+          - '3.12'
+          - '3.13'
+          - '3.14'
       # Random number to prevent exceeding the request frequency limit.
       max-parallel: 3
     runs-on: ubuntu-latest
@@ -42,8 +44,6 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v7
-        with:
-          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v7
         with:
@@ -56,17 +56,41 @@ jobs:
           vk-status --version
           vk-sessions --version
       - name: Run tests
-        run: ./test/bin/main.sh
+        run: ./test/main.sh
+
+  test_ubuntu:
+    strategy:
+      matrix:
+        codename:
+          - noble
+          - resolute
+    runs-on: ubuntu-latest
+    container:
+      image: 'ubuntu:${{ matrix.codename }}'
+    name: 'Ubuntu: ${{ matrix.codename }}'
+    steps:
+      - name: Install dependencies
+        run: |
+          apt update
+          DEBIAN_FRONTEND=noninteractive apt install -y --no-install-recommends \
+              ca-certificates \
+              python3 \
+              python3-matplotlib
+      - name: Checkout
+        uses: actions/checkout@v7
+      - name: Run tests
+        run: ./test/main.sh
 
   publish_pypi:
-    needs: [lint, test]
+    needs:
+      - lint
+      - test_python
+      - test_ubuntu
     runs-on: ubuntu-latest
     name: Publish
     steps:
       - name: Checkout
         uses: actions/checkout@v7
-        with:
-          fetch-depth: 0
       - name: Set up Python
         uses: actions/setup-python@v7
         with:

{vk_scripts-1.1.1/vk_scripts.egg-info → vk_scripts-1.3.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: vk_scripts
-Version: 1.1.1
+Version: 1.3.0
 Summary: Scripts to stalk people on VK
 Author-email: Egor Tensin <egor@tensin.name>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/egor-tensin/vk-scripts
 Project-URL: Bug Tracker, https://github.com/egor-tensin/vk-scripts/issues
 Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.6
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata~=4.0; python_version < "3.8"

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/pyproject.toml

@@ -12,7 +12,8 @@ license-files = ["LICENSE.txt"]
 dynamic = ["version"]
 authors = [{name = "Egor Tensin", email = "egor@tensin.name"}]
 readme = "README.md"
-requires-python = ">=3.6"
+requires-python = ">=3.11"
+# ^^^ For enum.StrEnum, at least?
 
 dependencies = [
     'importlib-metadata ~= 4.0 ; python_version < "3.8"',
@@ -33,3 +34,8 @@ vk-status = "vk.tracking.status:main"
 vk-mutuals = "vk.mutuals:main"
 
 [tool.setuptools_scm]
+
+[tool.pylint."messages control"]
+disable = [
+    "missing-docstring",
+]

vk_scripts-1.3.0/test/lib/log.sh

@@ -0,0 +1,139 @@
+# Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+# This file is part of the "VK scripts" project.
+# For details, see https://github.com/egor-tensin/vk-scripts
+# Distributed under the MIT License.
+
+log() {
+    local msg
+    for msg; do
+        echo -e "$test_file | $msg" >&2
+    done
+}
+
+log_run() {
+    if [ "$#" -lt 1 ]; then
+        log "usage: ${FUNCNAME[0]} ARGV0 [ARG...]"
+        return 1
+    fi
+
+    local msg='Running:'
+    msg="$msg$( printf -- ' %q' "$@" )"
+    log "$msg"
+}
+
+fail() {
+    local msg
+    for msg; do
+        log "FAIL: $msg"
+    done
+}
+
+fail_details() {
+    local msg
+    for msg; do
+        fail "    $msg"
+    done
+}
+
+log_numof_tests_ok=0
+log_numof_tests_failed=0
+declare -a log_tests_failed=()
+declare -A log_tests_should_fail=()
+
+log_test_start() {
+    if [ "$#" -ne 1 ]; then
+        echo "usage: ${FUNCNAME[0]} TEST_FILE" >&2
+        return 1
+    fi
+
+    local test_file="$1"
+
+    if [ -n "${test_should_fail:-}" ]; then
+        log_tests_should_fail["$test_file"]=1
+    fi
+
+    cat <<EOF >&2
+
+======================================================================
+TEST: $test_file
+======================================================================
+EOF
+
+    log "Should fail: ${test_should_fail:-No}"
+}
+
+log_test_ok() {
+    if [ "$#" -ne 1 ]; then
+        echo "usage: ${FUNCNAME[0]} TEST_FILE" >&2
+        return 1
+    fi
+
+    log_numof_tests_ok=$((log_numof_tests_ok + 1))
+
+    cat <<EOF >&2
+----------------------------------------------------------------------
+OK: $1
+----------------------------------------------------------------------
+EOF
+}
+
+log_test_fail() {
+    if [ "$#" -ne 1 ]; then
+        echo "usage: ${FUNCNAME[0]} TEST_FILE" >&2
+        return 1
+    fi
+
+    log_numof_tests_failed=$((log_numof_tests_failed + 1))
+    log_tests_failed+=("$1")
+
+    cat <<EOF >&2
+----------------------------------------------------------------------
+FAIL: $1
+----------------------------------------------------------------------
+EOF
+}
+
+log_test_finish() {
+    if [ "$#" -ne 2 ]; then
+        echo "usage: ${FUNCNAME[0]} TEST_FILE EXIT_CODE" >&2
+        return 1
+    fi
+
+    local test_file="$1"
+    local ret="$2"
+    local test_should_fail
+    test_should_fail="${log_tests_should_fail["$test_file"]:+x}"
+
+    if [ "$ret" -eq 0 ] || [ -n "$test_should_fail" ]; then
+        log_test_ok "$test_file"
+    else
+        log_test_fail "$test_file"
+    fi
+}
+
+log_tests_summary() {
+    cat <<EOF >&2
+
+======================================================================
+SUMMARY
+======================================================================
+OK:   $log_numof_tests_ok
+FAIL: $log_numof_tests_failed
+EOF
+
+    local test_file
+    for test_file in ${log_tests_failed[@]+"${log_tests_failed[@]}"}; do
+        cat <<EOF >&2
+FAIL: $test_file
+EOF
+    done
+
+    cat <<EOF >&2
+----------------------------------------------------------------------
+EOF
+
+    local ret=0
+    [ "$log_numof_tests_failed" -gt 0 ] && ret=1
+
+    return "$ret"
+}

vk_scripts-1.3.0/test/lib/test.sh

@@ -0,0 +1,26 @@
+# Copyright (c) 2020 Egor Tensin <egor@tensin.name>
+# This file is part of the "VK scripts" project.
+# For details, see https://github.com/egor-tensin/vk-scripts
+# Distributed under the MIT License.
+
+test_should_fail=
+test_root_dir=
+
+test_setup() {
+    test_root_dir="$( mktemp -d )"
+
+    log "Root directory: $test_root_dir"
+}
+
+test_cleanup_default() {
+    if [ -n "$test_root_dir" ]; then
+        log "Removing test's root directory: $test_root_dir"
+        rm -rf -- "$test_root_dir"
+    fi
+}
+
+test_run_module() {
+    local cmd=(python3 -m "$@")
+    log_run "${cmd[@]}"
+    PYTHONPATH="$script_dir/.." "${cmd[@]}"
+}

vk_scripts-1.3.0/test/main.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2026 Egor Tensin <egor@tensin.name>
+# This file is part of the "VK scripts" project.
+# For details, see https://github.com/egor-tensin/vk-scripts
+# Distributed under the MIT License.
+
+set -o errexit -o nounset -o pipefail
+shopt -s inherit_errexit lastpipe
+
+script_dir="$( dirname -- "${BASH_SOURCE[0]}" )"
+script_dir="$( cd -- "$script_dir" && pwd )"
+readonly script_dir
+script_name="$( basename -- "${BASH_SOURCE[0]}" )"
+readonly script_name
+
+source "$script_dir/lib/log.sh"
+
+run_test_file() {
+    local test_file
+    for test_file; do
+        source "$script_dir/lib/test.sh"
+        source "$script_dir/$test_file"
+
+        log_test_start "$test_file"
+
+        set +e
+        (
+            set -o errexit -o nounset -o pipefail
+            shopt -s inherit_errexit lastpipe
+
+            if [ "$( type -t test_cleanup )" == function ]; then
+                trap test_cleanup EXIT
+            else
+                trap test_cleanup_default EXIT
+            fi
+
+            test_run
+        )
+        local ret="$?"
+        set -e
+
+        log_test_finish "$test_file" "$ret"
+    done
+}
+
+main() {
+    if [ "$#" -gt 1 ]; then
+        echo "usage: $script_name [PATTERN]" >&2
+        return 1
+    fi
+
+    local -a test_files=()
+    local test_file
+
+    local pattern='*'
+    [ "$#" -gt 0 ] && pattern="$1"
+
+    find "$script_dir" \
+        -mindepth 1 \
+        -maxdepth 1 \
+        -type f \
+        -regex '.*/tst-.*\.sh$' \
+        -regextype posix-basic \
+        -name "$pattern" \
+        -printf '%P\0' \
+        | sort -z \
+        | \
+    while IFS= read -d '' -r test_file; do
+        test_files+=("$test_file")
+    done
+
+    run_test_file ${test_files[@]+"${test_files[@]}"}
+    log_tests_summary
+}
+
+main "$@"

vk_scripts-1.3.0/test/tst-mutuals.sh

@@ -0,0 +1,38 @@
+test_run() {
+    test_setup
+
+    local users=(kreed58 korya_mc)
+
+    test_run_module vk.mutuals --format csv "${users[@]}"  > "$test_root_dir/mutuals.csv"
+    test_run_module vk.mutuals --format json "${users[@]}" > "$test_root_dir/mutuals.json"
+
+    local expected=10
+
+    local actual_csv
+    actual_csv="$( cat -- "$test_root_dir/mutuals.csv" | wc -l )"
+    log "Mutuals in CSV: $actual_csv"
+
+    if [ "$actual_csv" -lt "$expected" ]; then
+        fail "Expected a lot more mutual friends in CSV output"
+        fail_details "Expected: $expected"
+        fail_details "Actual: $actual_csv"
+        return 1
+    fi
+
+    local actual_json
+    actual_json="$( grep -F -- '"id":' "$test_root_dir/mutuals.json" | wc -l )"
+    log "Mutuals in JSON: $actual_json"
+
+    if [ "$actual_json" -lt "$expected" ]; then
+        fail "Expected a lot more mutual friends in JSON output"
+        fail_details "Expected: $expected"
+        fail_details "Actual: $actual_json"
+        return 1
+    fi
+
+    if [ "$actual_csv" -ne "$actual_json" ]; then
+        fail "Number of mutuals in CSV unequal to that in JSON"
+        fail_details "Can technically happen, because it's kind of a race"
+        return 1
+    fi
+}

vk_scripts-1.3.0/test/tst-sessions.sh

@@ -0,0 +1,43 @@
+test_db_path="$script_dir/data/test_db.csv"
+readonly test_db_path
+
+_test_format() {
+    local output_path
+    output_path="$( mktemp --tmpdir="$test_root_dir" )"
+
+    test_run_module vk.tracking.sessions "$@" "$test_db_path" "$output_path"
+
+    if [ ! -s "$output_path" ]; then
+        fail "Output file '$output_path' either doesn't exists or is empty"
+        return 1
+    fi
+
+    if file --brief --dereference --mime -- "$output_path" | grep --quiet -- 'charset=binary$'; then
+        log 'Output is a binary file, not going to show that'
+        return 0
+    fi
+
+    cat -- "$output_path" >&2
+}
+
+_test_group_by() {
+    local group_by
+    for group_by; do
+        local format
+        for format in csv json plot; do
+            _test_format --output-format "$format" --group-by "$group_by"
+        done
+    done
+}
+
+_test_main() {
+    _test_group_by user
+    _test_group_by hour
+    _test_group_by date
+    _test_group_by weekday
+}
+
+test_run() {
+    test_setup
+    _test_main
+}

vk_scripts-1.3.0/test/tst-status-once.sh

@@ -0,0 +1,25 @@
+test_run() {
+    test_setup
+
+    local users=(egor.tensin kreed58)
+    local db_path
+    db_path="$test_root_dir/db.csv"
+
+    test_run_module vk.tracking.status --only-once -o "$db_path" "${users[@]}"
+
+    if [ ! -s "$db_path" ]; then
+        fail "Database file '$db_path' either doesn't exists or is empty"
+        return 1
+    fi
+
+    log "Database:"
+    cat -- "$db_path" >&2
+
+    local lines
+    lines="$( cat -- "$db_path" | wc -l )"
+
+    if [ "$lines" -ne 2 ]; then
+        fail "Database '$db_path' has the wrong number of entries"
+        return 1
+    fi
+}

vk_scripts-1.3.0/test/tst-status.sh

@@ -0,0 +1,45 @@
+test_run() {
+    test_setup
+
+    local users=(egor.tensin)
+
+    local log_path
+    log_path="$test_root_dir/status.log"
+    local db_path
+    db_path="$test_root_dir/status.csv"
+
+    test_run_module vk.tracking.status \
+        --log "$log_path" \
+        --format csv \
+        --output "$db_path" \
+        "${users[@]}" &
+    local pid="$!"
+
+    sleep 3
+    log "Log file: $log_path"
+    log "Database file: $db_path"
+    log "PID: $pid"
+
+    local timeout=10
+    log "Sleeping for $timeout seconds..."
+    sleep "$timeout"
+
+    log 'Terminating track_status.py...'
+    kill "$pid"
+    log 'Waiting for track_status.py to terminate...'
+    wait "$pid" || true
+
+    if [ ! -s "$log_path" ]; then
+        fail "Log file '$log_path' either doesn't exists or is empty"
+        return 1
+    fi
+    log 'Log file:'
+    cat -- "$log_path" >&2
+
+    if [ ! -s "$db_path" ]; then
+        fail "Database file '$db_path' either doesn't exists or is empty"
+        return 1
+    fi
+    log 'Database:'
+    cat -- "$db_path" >&2
+}

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/api.py

@@ -1,10 +1,10 @@
 # Copyright (c) 2015 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
 from collections.abc import Iterable, Mapping
-from enum import Enum
+from enum import auto, StrEnum
 import json
 from urllib.error import URLError
 import urllib.parse
@@ -69,39 +69,27 @@ def _join_path(base, url):
 ACCESS_TOKEN = "3d242bac3d242bac3d242bacd03e66eae033d243d242bac5755894cf6163d769859232d"
 
 
-class Version(Enum):
+class Version(StrEnum):
     # https://dev.vk.com/en/reference/versions
     V5_199 = "5.199"
     DEFAULT = V5_199
 
-    def __str__(self):
-        return self.value
 
-
-class Language(Enum):
-    EN = "en"
+class Language(StrEnum):
+    EN = auto()
     DEFAULT = EN
 
-    def __str__(self):
-        return self.value
-
 
-class Method(Enum):
+class Method(StrEnum):
     USERS_GET = "users.get"
     FRIENDS_GET = "friends.get"
 
-    def __str__(self):
-        return self.value
 
-
-class CommonParameters(Enum):
+class CommonParameters(StrEnum):
     ACCESS_TOKEN = "access_token"
     VERSION = "v"
     LANGUAGE = "lang"
 
-    def __str__(self):
-        return self.value
-
 
 class API:
     _ROOT_URL = "https://api.vk.com/method/"

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/error.py

@@ -1,6 +1,6 @@
 # Copyright (c) 2016 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
 

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/last_seen.py

@@ -1,12 +1,12 @@
 # Copyright (c) 2016 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
 from collections import OrderedDict
 from collections.abc import MutableMapping
 from datetime import datetime, timezone
-from enum import Enum
+from enum import auto, StrEnum
 from numbers import Integral, Real
 
 from .platform import Platform
@@ -30,12 +30,9 @@ def _parse_platform(x):
     return Platform(x)
 
 
-class LastSeenField(Enum):
-    TIME = "time"
-    PLATFORM = "platform"
-
-    def __str__(self):
-        return self.value
+class LastSeenField(StrEnum):
+    TIME = auto()
+    PLATFORM = auto()
 
 
 class LastSeen(MutableMapping):

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/mutuals.py

@@ -1,12 +1,12 @@
 # Copyright (c) 2015 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
 import abc
 import argparse
 from collections import OrderedDict
-from enum import Enum
+from enum import auto, StrEnum
 import sys
 
 from vk.api import API
@@ -56,12 +56,9 @@ class OutputSinkJSON(OutputSinkMutualFriends):
         self._writer.write(friend_list)
 
 
-class OutputFormat(Enum):
-    CSV = "csv"
-    JSON = "json"
-
-    def __str__(self):
-        return self.value
+class OutputFormat(StrEnum):
+    CSV = auto()
+    JSON = auto()
 
     @staticmethod
     def open_file(path=None):
@@ -93,7 +90,10 @@ def _parse_args(args=None):
     vk.version.add_to_arg_parser(parser)
 
     parser.add_argument(
-        "uids", metavar="UID", nargs="+", help='user IDs or "screen names"'
+        "uids",
+        metavar="UID",
+        nargs="+",
+        help='user IDs or "screen names"',
     )
     parser.add_argument(
         "-f",

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/platform.py

@@ -1,12 +1,12 @@
 # Copyright (c) 2016 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
-from enum import Enum
+from enum import IntEnum
 
 
-class Platform(Enum):
+class Platform(IntEnum):
     # https://dev.vk.com/en/reference/objects/user#last_seen
     MOBILE = 1
     IPHONE = 2
@@ -20,9 +20,6 @@ class Platform(Enum):
     def from_string(s):
         return Platform(int(s))
 
-    def __str__(self):
-        return str(self.value)
-
     @property
     def descr(self):
         return f"the {_PLATFORM_DESCRIPTIONS[self]}"

{vk_scripts-1.1.1 → vk_scripts-1.3.0}/vk/tracking/db/__init__.py

@@ -1,6 +1,6 @@
 # Copyright (c) 2016 Egor Tensin <egor@tensin.name>
 # This file is part of the "VK scripts" project.
-# For details, see https://github.com/egor-tensin/vk-scripts.
+# For details, see https://github.com/egor-tensin/vk-scripts
 # Distributed under the MIT License.
 
 from .format import Format