vk-scripts 1.0.4__tar.gz → 1.1__tar.gz

vk_scripts-1.1/.git-blame-ignore-revs

@@ -0,0 +1 @@
+93ad1eb3a63041a49882e6b7b6b0ef506d4fa6c7

{vk_scripts-1.0.4 → vk_scripts-1.1}/.github/workflows/ci.yml

@@ -6,8 +6,8 @@ on:
       - 'docs/**'
       - 'README.md'
   schedule:
-    # Weekly, at 6:45 AM on Thursday (somewhat randomly chosen).
-    - cron: '45 6 * * 4'
+    # Weekly, at 02:30 on Friday (somewhat randomly chosen).
+    - cron: '30 02 * * 5'
   workflow_dispatch:
 
 env:
@@ -15,6 +15,22 @@ env:
   PIP_NO_PYTHON_VERSION_WARNING: 1
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Linting
+    continue-on-error: "${{ github.ref != 'refs/heads/master' }}"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+      - name: Run black
+        uses: psf/black@stable
+
   test:
     strategy:
       matrix:
@@ -25,7 +41,7 @@ jobs:
     name: 'Python ${{ matrix.python-version }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python
@@ -43,12 +59,12 @@ jobs:
         run: ./test/bin/main.sh
 
   publish_pypi:
-    needs: [test]
+    needs: [lint, test]
     runs-on: ubuntu-latest
     name: Publish
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python

vk_scripts-1.1/.pylintrc

@@ -0,0 +1,8 @@
+[MESSAGES CONTROL]
+
+disable=
+    invalid-name,
+    missing-docstring,
+    multiple-imports,
+    too-few-public-methods,
+    too-many-public-methods,

{vk_scripts-1.0.4 → vk_scripts-1.1}/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015 Egor Tensin <Egor.Tensin@gmail.com>
+Copyright (c) 2015 Egor Tensin <egor@tensin.name>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{vk_scripts-1.0.4/vk_scripts.egg-info → vk_scripts-1.1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: vk_scripts
-Version: 1.0.4
+Version: 1.1
 Summary: Scripts to stalk people on VK
-Author-email: Egor Tensin <Egor.Tensin@gmail.com>
+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 :: 4 - Beta
-Requires-Python: >=3.4
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata~=4.0; python_version < "3.8"
@@ -26,8 +26,6 @@ Installation
 
     pip install vk-scripts
 
-
-Python 3.4 or higher is required.
 `vk-sessions` uses [matplotlib].
 
 [matplotlib]: http://matplotlib.org/

{vk_scripts-1.0.4 → vk_scripts-1.1}/README.md

@@ -10,8 +10,6 @@ Installation
 
     pip install vk-scripts
 
-
-Python 3.4 or higher is required.
 `vk-sessions` uses [matplotlib].
 
 [matplotlib]: http://matplotlib.org/

{vk_scripts-1.0.4 → vk_scripts-1.1}/docs/mutuals.md

@@ -13,8 +13,8 @@ Usage
 For example (using made up user IDs/"screen names"),
 
     > vk-mutuals john.doe jane.doe
-    89497105,John,Smith
-    3698577,Jane,Smith
+    89497105,John,Smith,john.smith
+    3698577,Jane,Smith,jane.smith
 
 In the example above, both "John Doe" and "Jane Doe" are friends with "John
 Smith" and "Jane Smith", whose user IDs are 89497105 and 3698577 respectively.
@@ -27,18 +27,13 @@ You can also get a JSON document:
        {
           "uid": 89497105,
           "first_name": "John",
-          "last_name": "Smith"
+          "last_name": "Smith",
+          "domain": "john.smith"
        },
        {
           "uid": 3698577,
           "first_name": "Jane",
-          "last_name": "Smith"
+          "last_name": "Smith",
+          "domain": "jane.smith"
        }
     ]
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.4 → vk_scripts-1.1}/docs/sessions.md

@@ -159,10 +159,3 @@ Known issues
 time (for example, just listening to music), they appear offline.
 Hence the 0:00:00 durations you might sometimes encounter.
 This might also happen using other clients.
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.4 → vk_scripts-1.1}/docs/status.md

@@ -31,10 +31,3 @@ If you want to record when people go online/offline for further analysis using
 [vk-sessions], specify the path to a database using the `--output` parameter.
 
 [vk-sessions]: sessions.md
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.4 → vk_scripts-1.1}/pyproject.toml

@@ -1,15 +1,18 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools-scm"]
+# The SPDX license identifiers are available from 77.0.3:
+# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license-and-license-files
+requires = ["setuptools >= 77.0.3", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "vk_scripts"
 description = "Scripts to stalk people on VK"
 license = "MIT"
+license-files = ["LICENSE.txt"]
 dynamic = ["version"]
-authors = [{name = "Egor Tensin", email = "Egor.Tensin@gmail.com"}]
+authors = [{name = "Egor Tensin", email = "egor@tensin.name"}]
 readme = "README.md"
-requires-python = ">=3.4"
+requires-python = ">=3.6"
 
 dependencies = [
     'importlib-metadata ~= 4.0 ; python_version < "3.8"',
@@ -17,7 +20,7 @@ dependencies = [
 ]
 
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
 ]
 
 [project.urls]

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/bin/main.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright (c) 2019 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/bin/mutuals.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright (c) 2019 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/bin/sessions.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright (c) 2019 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/bin/status.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright (c) 2019 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/bin/status_once.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2019 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright (c) 2019 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/test/lib/test.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2020 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/api.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2015 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
@@ -26,9 +26,15 @@ def _filter_empty_params(params, empty_params=False):
     if empty_params:
         return params
     if isinstance(params, Mapping):
-        return {name: value for name, value in params.items() if not _is_empty_param_value(value)}
+        return {
+            name: value
+            for name, value in params.items()
+            if not _is_empty_param_value(value)
+        }
     if isinstance(params, Iterable):
-        return [(name, value) for name, value in params if not _is_empty_param_value(value)]
+        return [
+            (name, value) for name, value in params if not _is_empty_param_value(value)
+        ]
     raise TypeError()
 
 
@@ -43,28 +49,29 @@ def _build_url(scheme, host, path, params=None, empty_params=False):
     else:
         raise TypeError()
     path = urllib.parse.quote(path)
-    return urllib.parse.urlunsplit((scheme, host, path, params, ''))
+    return urllib.parse.urlunsplit((scheme, host, path, params, ""))
 
 
 def _join_param_values(values):
     if isinstance(values, str):
         return values
     if isinstance(values, Iterable):
-        return ','.join(map(str, values))
+        return ",".join(map(str, values))
     return values
 
 
 def _join_path(base, url):
-    if not base.endswith('/'):
-        base += '/'
+    if not base.endswith("/"):
+        base += "/"
     return urllib.parse.urljoin(base, url)
 
 
-ACCESS_TOKEN = '9722cef09722cef09722cef071974b8cbe997229722cef0cbabfd816916af6c7bd37006'
+ACCESS_TOKEN = "9722cef09722cef09722cef071974b8cbe997229722cef0cbabfd816916af6c7bd37006"
 
 
 class Version(Enum):
-    V5_199 = '5.199'
+    # https://dev.vk.com/en/reference/versions
+    V5_199 = "5.199"
     DEFAULT = V5_199
 
     def __str__(self):
@@ -72,7 +79,7 @@ class Version(Enum):
 
 
 class Language(Enum):
-    EN = 'en'
+    EN = "en"
     DEFAULT = EN
 
     def __str__(self):
@@ -80,24 +87,24 @@ class Language(Enum):
 
 
 class Method(Enum):
-    USERS_GET = 'users.get'
-    FRIENDS_GET = 'friends.get'
+    USERS_GET = "users.get"
+    FRIENDS_GET = "friends.get"
 
     def __str__(self):
         return self.value
 
 
 class CommonParameters(Enum):
-    ACCESS_TOKEN = 'access_token'
-    VERSION = 'v'
-    LANGUAGE = 'lang'
+    ACCESS_TOKEN = "access_token"
+    VERSION = "v"
+    LANGUAGE = "lang"
 
     def __str__(self):
         return self.value
 
 
 class API:
-    _ROOT_URL = 'https://api.vk.com/method/'
+    _ROOT_URL = "https://api.vk.com/method/"
 
     _SCHEME, _HOST, _ROOT_PATH = _split_url(_ROOT_URL)
 
@@ -115,14 +122,14 @@ class API:
 
     def _call_method(self, method, **params):
         url = self._build_method_url(method, **params)
-        #print(url)
+        # print(url)
         try:
             with urlopen(url) as response:
                 response = json.loads(response.read().decode())
-                #print(response)
-                if 'response' not in response:
+                # print(response)
+                if "response" not in response:
                     raise vk.error.InvalidAPIResponseError(response)
-                return response['response']
+                return response["response"]
         except (ConnectionError, URLError) as e:
             raise vk.error.APIConnectionError(str(e)) from e
 
@@ -131,20 +138,22 @@ class API:
         user_list = map(User.from_api_response, user_list)
         if deactivated_users:
             return user_list
-        return [user for user in user_list if not user.is_deactivated()]
+        return [user for user in user_list if not user.is_deactivated]
 
     def users_get(self, user_ids, fields=(), deactivated_users=True):
-        return self._filter_response_with_users(self._call_method(
-            Method.USERS_GET,
-            user_ids=_join_param_values(user_ids),
-            fields=_join_param_values(fields)), deactivated_users)
+        return self._filter_response_with_users(
+            self._call_method(
+                Method.USERS_GET,
+                user_ids=_join_param_values(user_ids),
+                fields=_join_param_values(fields),
+            ),
+            deactivated_users,
+        )
 
     def friends_get(self, user_id, fields=(), deactivated_users=True):
         response = self._call_method(
-            Method.FRIENDS_GET,
-            user_id=user_id,
-            fields=_join_param_values(fields))
-        if 'items' not in response:
+            Method.FRIENDS_GET, user_id=user_id, fields=_join_param_values(fields)
+        )
+        if "items" not in response:
             raise vk.error.InvalidAPIResponseError(response)
-        return self._filter_response_with_users(response['items'],
-                                                deactivated_users)
+        return self._filter_response_with_users(response["items"], deactivated_users)

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/error.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/last_seen.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
@@ -31,8 +31,8 @@ def _parse_platform(x):
 
 
 class LastSeenField(Enum):
-    TIME = 'time'
-    PLATFORM = 'platform'
+    TIME = "time"
+    PLATFORM = "platform"
 
     def __str__(self):
         return self.value
@@ -80,20 +80,14 @@ class LastSeen(MutableMapping):
 
     _DEFAULT_FIELD_PARSER = str
 
-    def has_time(self):
-        return LastSeenField.TIME in self
-
-    def get_time(self):
+    @property
+    def time(self):
         return self[LastSeenField.TIME]
 
-    def set_time(self, time):
-        self[LastSeenField.TIME] = time
-
-    def has_platform(self):
-        return LastSeenField.PLATFORM in self
+    @property
+    def time_local(self):
+        return self.time.astimezone()
 
-    def get_platform(self):
+    @property
+    def platform(self):
         return self[LastSeenField.PLATFORM]
-
-    def set_platform(self, platform):
-        self[LastSeenField.PLATFORM] = platform

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/mutuals.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2015 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
@@ -14,12 +14,16 @@ from vk.user import UserField
 from vk.utils import io
 import vk.version
 
-
-_OUTPUT_USER_FIELDS = UserField.UID, UserField.FIRST_NAME, UserField.LAST_NAME
+_OUTPUT_USER_FIELDS = (
+    UserField.UID,
+    UserField.FIRST_NAME,
+    UserField.LAST_NAME,
+    UserField.DOMAIN,
+)
 
 
 def _query_friend_list(api, user):
-    return api.friends_get(user.get_uid(), fields=_OUTPUT_USER_FIELDS)
+    return api.friends_get(user.uid, fields=_OUTPUT_USER_FIELDS)
 
 
 def _filter_user_fields(user):
@@ -53,8 +57,8 @@ class OutputSinkJSON(OutputSinkMutualFriends):
 
 
 class OutputFormat(Enum):
-    CSV = 'csv'
-    JSON = 'json'
+    CSV = "csv"
+    JSON = "json"
 
     def __str__(self):
         return self.value
@@ -68,14 +72,14 @@ class OutputFormat(Enum):
             return OutputSinkCSV(fd)
         if self is OutputFormat.JSON:
             return OutputSinkJSON(fd)
-        raise NotImplementedError('unsupported output format: ' + str(self))
+        raise NotImplementedError(f"unsupported output format: {self}")
 
 
 def _parse_output_format(s):
     try:
         return OutputFormat(s)
     except ValueError:
-        raise argparse.ArgumentTypeError('invalid output format: ' + s)
+        raise argparse.ArgumentTypeError(f"invalid output format: {s}")
 
 
 def _parse_args(args=None):
@@ -83,19 +87,30 @@ def _parse_args(args=None):
         args = sys.argv[1:]
 
     parser = argparse.ArgumentParser(
-        description='Learn who your ex and her new boyfriend are both friends with.')
+        description="Learn who your ex and her new boyfriend are both friends with."
+    )
 
     vk.version.add_to_arg_parser(parser)
 
-    parser.add_argument('uids', metavar='UID', nargs='+',
-                        help='user IDs or "screen names"')
-    parser.add_argument('-f', '--format', dest='out_fmt',
-                        type=_parse_output_format,
-                        default=OutputFormat.CSV,
-                        choices=OutputFormat,
-                        help='specify output format')
-    parser.add_argument('-o', '--output', metavar='PATH', dest='out_path',
-                        help='set output file path (standard output by default)')
+    parser.add_argument(
+        "uids", metavar="UID", nargs="+", help='user IDs or "screen names"'
+    )
+    parser.add_argument(
+        "-f",
+        "--format",
+        dest="out_fmt",
+        type=_parse_output_format,
+        default=OutputFormat.CSV,
+        choices=OutputFormat,
+        help="specify output format",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        metavar="PATH",
+        dest="out_path",
+        help="set output file path (standard output by default)",
+    )
 
     return parser.parse_args(args)
 
@@ -117,5 +132,5 @@ def main(args=None):
     write_mutual_friends(**vars(_parse_args(args)))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

vk_scripts-1.1/vk/platform.py

@@ -0,0 +1,39 @@
+# 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.
+# Distributed under the MIT License.
+
+from enum import Enum
+
+
+class Platform(Enum):
+    # https://dev.vk.com/en/reference/objects/user#last_seen
+    MOBILE = 1
+    IPHONE = 2
+    IPAD = 3
+    ANDROID = 4
+    WINDOWS_PHONE = 5
+    WINDOWS10 = 6
+    WEB = 7
+
+    @staticmethod
+    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]}"
+
+
+_PLATFORM_DESCRIPTIONS = {
+    Platform.MOBILE: '"mobile" web version (or an unrecognized mobile app)',
+    Platform.IPHONE: "official iPhone app",
+    Platform.IPAD: "official iPad app",
+    Platform.ANDROID: "official Android app",
+    Platform.WINDOWS_PHONE: "official Windows Phone app",
+    Platform.WINDOWS10: "official Windows 10 app",
+    Platform.WEB: "web version (or an unrecognized app)",
+}

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/tracking/__init__.py

@@ -1,5 +1,8 @@
-# Copyright 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# Copyright 2016 Egor Tensin <egor@tensin.name>
 # This file is licensed under the terms of the MIT License.
 # See LICENSE.txt for details.
 
-__all__ = 'sessions', 'status',
+__all__ = (
+    "sessions",
+    "status",
+)

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/tracking/db/__init__.py

@@ -1,8 +1,8 @@
-# Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
 
 from .format import Format
 
-__all__ = 'format'
+__all__ = ("format",)

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/tracking/db/backend/__init__.py

@@ -1,8 +1,12 @@
-# Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
 
 from . import csv, log, null
 
-__all__ = 'csv', 'log', 'null',
+__all__ = (
+    "csv",
+    "log",
+    "null",
+)

{vk_scripts-1.0.4 → vk_scripts-1.1}/vk/tracking/db/backend/csv.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Egor Tensin <Egor.Tensin@gmail.com>
+# 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.
 # Distributed under the MIT License.
@@ -43,6 +43,6 @@ class Reader(meta.Reader):
     @staticmethod
     def _record_from_row(row):
         record = Record(Timestamp.from_string(row[0]))
-        for i in range(len(Record.FIELDS)):
-            record[Record.FIELDS[i]] = row[i + 1]
+        for i, field in enumerate(Record.FIELDS):
+            record[field] = row[i + 1]
         return record