blob: 5e8d2322c7674955965fd8dcf421fc5d3ac80f2e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
VK scripts
==========
A collection of scripts abusing VK.com API.
Prerequisites
-------------
* Python 3.4 or higher
* [matplotlib][matplotlib] (required by [online_sessions.py])
* [numpy][numpy] (required by [matplotlib])
The versions below have been verified to work properly.
Software | Version
---------- | -------
CPython | 3.5.1
numpy | 1.11.0
matplotlib | 1.5.1
Windows binaries for CPython can be acquired at
http://www.lfd.uci.edu/~gohlke/pythonlibs/.
[matplotlib]: http://matplotlib.org/
[numpy]: http://www.numpy.org/
Usage
-----
The main package resides in the "vk/" directory.
Also, a few scripts are supplied in the "bin/" directory to showcase the
package's capabilities.
Run the scripts from the top-level directory using `python -m`.
Pass the `--help` flag to a script to examine its detailed usage information.
The supplied scripts are listed below.
* [mutual_friends.py] — Learn who your ex and her new boyfriend are both
friends with.
* [track_status.py] — Track when people go online/offline.
* [online_sessions.py] — View/visualize the amount of time people spend
online.
[mutual_friends.py]: docs/mutual_friends.md
[track_status.py]: docs/track_status.md
[online_sessions.py]: docs/online_sessions.md
Development
-----------
### Linting
Requires [PyLint].
To lint everything, run from the top-level directory (notice that you need to
set the `PYTHONPATH` environment variable to lint the scripts; Windows syntax
is used below):
> pylint vk
...
> set PYTHONPATH=%CD%
> pylint bin\mutual_friends.py
...
> pylint bin\online_sessions.py
...
> pylint bin\track_status.py
...
[PyLint]: https://www.pylint.org/
License
-------
Distributed under the MIT License.
See [LICENSE.txt] for details.
[LICENSE.txt]: LICENSE.txt
|
