Skip to content

Commit d0fedb2

Browse files
fcosantosfcosantos
committed
Update docs.vt links
1 parent d44c39a commit d0fedb2

16 files changed

+110
-111
lines changed

‎README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
![GitHub](https://img.shields.io/github/license/VirusTotal/vt-py)
33
![GitHub issues](https://img.shields.io/github/issues/VirusTotal/vt-py)
44

5-
65
# vt-py
76

87
This is the official Python client library for VirusTotal. With this library
9-
you can interact with the [VirusTotal REST API v3](https://developers.virustotal.com/v3.0/reference)
8+
you can interact with the [VirusTotal REST API v3](https://docs.virustotal.com/reference/overview)
109
and automate your workflow quickly and efficiently.
1110

1211
## Things you can do with vt-py

‎docs/_modules/vt/feed.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@
99
<!--[if lt IE 9]>
1010
<script src="../../_static/js/html5shiv.min.js"></script>
1111
<![endif]-->
12-
12+
1313
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
1414
<script src="../../_static/doctools.js"></script>
1515
<script src="../../_static/sphinx_highlight.js"></script>
1616
<script src="../../_static/js/theme.js"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
18-
<link rel="search" title="Search" href="../../search.html" />
18+
<link rel="search" title="Search" href="../../search.html" />
1919
</head>
2020

21-
<body class="wy-body-for-nav">
21+
<body class="wy-body-for-nav">
2222
<div class="wy-grid-for-nav">
2323
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2424
<div class="wy-side-scroll">
2525
<div class="wy-side-nav-search" >
2626

27-
28-
27+
28+
2929
<a href="../../index.html" class="icon icon-home">
3030
vt-py
3131
</a>
@@ -68,7 +68,7 @@
6868
</div>
6969
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
7070
<div itemprop="articleBody">
71-
71+
7272
<h1>Source code for vt.feed</h1><div class="highlight"><pre>
7373
<span></span><span class="ch">#!/usr/local/bin/python</span>
7474
<span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
@@ -116,7 +116,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
116116
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Feed represents a stream of objects received from VirusTotal in real-time.</span>
117117

118118
<span class="sd"> For more information about VirusTotal Feeds see:</span>
119-
<span class="sd"> https://developers.virustotal.com/v3.0/reference#feeds</span>
119+
<span class="sd"> https://docs.virustotal.com/reference/feeds</span>
120120

121121
<span class="sd"> In the example below the loop iterates forever, retrieving file objects as</span>
122122
<span class="sd"> they are processed by VirusTotal. For a more elaborate example see the file</span>
@@ -255,7 +255,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
255255
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
256256
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
257257
provided by <a href="https://readthedocs.org">Read the Docs</a>.
258-
258+
259259

260260
</footer>
261261
</div>
@@ -266,7 +266,7 @@ <h1>Source code for vt.feed</h1><div class="highlight"><pre>
266266
jQuery(function () {
267267
SphinxRtdTheme.Navigation.enable(true);
268268
});
269-
</script>
269+
</script>
270270

271271
</body>
272-
</html>
272+
</html>

‎docs/_modules/vt/iterator.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@
99
<!--[if lt IE 9]>
1010
<script src="../../_static/js/html5shiv.min.js"></script>
1111
<![endif]-->
12-
12+
1313
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
1414
<script src="../../_static/doctools.js"></script>
1515
<script src="../../_static/sphinx_highlight.js"></script>
1616
<script src="../../_static/js/theme.js"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
18-
<link rel="search" title="Search" href="../../search.html" />
18+
<link rel="search" title="Search" href="../../search.html" />
1919
</head>
2020

21-
<body class="wy-body-for-nav">
21+
<body class="wy-body-for-nav">
2222
<div class="wy-grid-for-nav">
2323
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2424
<div class="wy-side-scroll">
2525
<div class="wy-side-nav-search" >
2626

27-
28-
27+
28+
2929
<a href="../../index.html" class="icon icon-home">
3030
vt-py
3131
</a>
@@ -68,7 +68,7 @@
6868
</div>
6969
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
7070
<div itemprop="articleBody">
71-
71+
7272
<h1>Source code for vt.iterator</h1><div class="highlight"><pre>
7373
<span></span><span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
7474
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
@@ -98,14 +98,14 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
9898
<span class="sd"> Some endpoints in the VirusTotal API represent a collection of objects, for</span>
9999
<span class="sd"> example:</span>
100100

101-
<span class="sd"> `/files/{id}/comments &lt;https://developers.virustotal.com/v3.0/reference#files-comments-get&gt;`_</span>
101+
<span class="sd"> `/files/{id}/comments &lt;https://docs.virustotal.com/reference/files-comments-get&gt;`_</span>
102102

103-
<span class="sd"> `/intelligence/search &lt;https://developers.virustotal.com/v3.0/reference#intelligence-search&gt;`_</span>
103+
<span class="sd"> `/intelligence/search &lt;https://docs.virustotal.com/reference/intelligence-search&gt;`_</span>
104104

105105
<span class="sd"> These collections can be iterated using an instance of this class.</span>
106106

107107
<span class="sd"> Learn more about collections in the VirusTotal API in:</span>
108-
<span class="sd"> https://developers.virustotal.com/v3.0/reference#collections</span>
108+
<span class="sd"> https://docs.virustotal.com/reference/collections</span>
109109

110110
<span class="sd"> The following example iterates over the most recent 200 comments, retrieving</span>
111111
<span class="sd"> them in batches of 20:</span>
@@ -253,7 +253,7 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
253253
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
254254
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
255255
provided by <a href="https://readthedocs.org">Read the Docs</a>.
256-
256+
257257

258258
</footer>
259259
</div>
@@ -264,7 +264,7 @@ <h1>Source code for vt.iterator</h1><div class="highlight"><pre>
264264
jQuery(function () {
265265
SphinxRtdTheme.Navigation.enable(true);
266266
});
267-
</script>
267+
</script>
268268

269269
</body>
270-
</html>
270+
</html>

‎docs/_modules/vt/object.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@
99
<!--[if lt IE 9]>
1010
<script src="../../_static/js/html5shiv.min.js"></script>
1111
<![endif]-->
12-
12+
1313
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
1414
<script src="../../_static/doctools.js"></script>
1515
<script src="../../_static/sphinx_highlight.js"></script>
1616
<script src="../../_static/js/theme.js"></script>
1717
<link rel="index" title="Index" href="../../genindex.html" />
18-
<link rel="search" title="Search" href="../../search.html" />
18+
<link rel="search" title="Search" href="../../search.html" />
1919
</head>
2020

21-
<body class="wy-body-for-nav">
21+
<body class="wy-body-for-nav">
2222
<div class="wy-grid-for-nav">
2323
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2424
<div class="wy-side-scroll">
2525
<div class="wy-side-nav-search" >
2626

27-
28-
27+
28+
2929
<a href="../../index.html" class="icon icon-home">
3030
vt-py
3131
</a>
@@ -68,7 +68,7 @@
6868
</div>
6969
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
7070
<div itemprop="articleBody">
71-
71+
7272
<h1>Source code for vt.object</h1><div class="highlight"><pre>
7373
<span></span><span class="c1"># Copyright © 2019 The vt-py authors. All Rights Reserved.</span>
7474
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
@@ -125,7 +125,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
125125
<span class="sd"> to :meth:`vt.Client.post_object`.</span>
126126

127127
<span class="sd"> Learn more about objects in the VirusTotal API in:</span>
128-
<span class="sd"> https://developers.virustotal.com/v3.0/reference#objects</span>
128+
<span class="sd"> https://docs.virustotal.com/reference/objects</span>
129129
<span class="sd"> &quot;&quot;&quot;</span>
130130

131131
<span class="c1"># Attributes from all object types that match any of the following names</span>
@@ -313,7 +313,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
313313
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
314314
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
315315
provided by <a href="https://readthedocs.org">Read the Docs</a>.
316-
316+
317317

318318
</footer>
319319
</div>
@@ -324,7 +324,7 @@ <h1>Source code for vt.object</h1><div class="highlight"><pre>
324324
jQuery(function () {
325325
SphinxRtdTheme.Navigation.enable(true);
326326
});
327-
</script>
327+
</script>
328328

329329
</body>
330-
</html>
330+
</html>

‎docs/_sources/index.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Welcome to vt-py's documentation!
77
=================================
88

99
`vt-py <https://github.com/VirusTotal/vt-py>`_ is the official Python client library
10-
for the `VirusTotal API v3 <https://developers.virustotal.com/v3.0/reference>`_.
10+
for the `VirusTotal API v3 <https://docs.virustotal.com/reference/overview>`_.
1111

1212
This library requires Python 3.6.0+, Python 2.x is not supported. This is because vt-py
1313
makes use of the new `async/await <https://snarky.ca/how-the-heck-does-async-await-work-in-python-3-5/>`_

‎docs/_sources/overview.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Overview
33
********
44

55
The API for this library is relatively small and shares the same concepts and
6-
principles seen in the underlying `REST API <https://developers.virustotal.com/v3.0/reference>`_.
6+
principles seen in the underlying `REST API <https://docs.virustotal.com/v3.0/reference>`_.
77
For this reason we highly recommend you to familiarize yourself with these
8-
`concepts <https://developers.virustotal.com/v3.0/reference#key-concepts>`_ before
8+
`concepts <https://docs.virustotal.com/reference/key-concepts>`_ before
99
continuing.
1010

1111
While using this library you may have the impression that it's very similar to

‎docs/_sources/quickstart.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ with some other SHA-256, SHA-1 or MD5:
2222
Now `file` is an instance of :class:`vt.Object` that contains information
2323
about the requested file. This object have the attributes returned in the
2424
API response which are listed in the `VirusTotal API v3 documentation
25-
<https://developers.virustotal.com/v3.0/reference#files>`_. Some examples:
25+
<https://docs.virustotal.com/reference/files>`_. Some examples:
2626

2727
>>> file.size
2828
68
@@ -66,7 +66,7 @@ While retrieving a file any of its hashes can be used as the file identifier,
6666
but with URLs is a bit more complicated. You must use :func:`vt.url_id` for
6767
generating the appropriate identifier. You can find more information about why
6868
this is necessary in:
69-
`<https://developers.virustotal.com/v3.0/reference#url>`_.
69+
`<https://docs.virustotal.com/reference/url>`_.
7070

7171
Also notice how we are using a placeholder `{}` in the path. The placeholder
7272
will be replaced with the value of `url_id`. This works exactly like Python's
@@ -187,7 +187,7 @@ Let's abort the job:
187187

188188
Here we are using :meth:`vt.Client.post` instead of :meth:`vt.Client.post_object`,
189189
this is because the `/intelligence/retrohunt_jobs/{id}/abort
190-
<https://developers.virustotal.com/v3.0/reference#abort-retrohunt-job>`_
190+
<https://docs.virustotal.com/reference/abort-retrohunt-job>`_
191191
endpoint doesn't expect an object, just a POST request with an empty body. The
192192
result from :meth:`vt.Client.post` is a :class:`vt.ClientResponse` instance.
193193

‎docs/api/feed.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,25 @@
1010
<!--[if lt IE 9]>
1111
<script src="../_static/js/html5shiv.min.js"></script>
1212
<![endif]-->
13-
13+
1414
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
1515
<script src="../_static/doctools.js"></script>
1616
<script src="../_static/sphinx_highlight.js"></script>
1717
<script src="../_static/js/theme.js"></script>
1818
<link rel="index" title="Index" href="../genindex.html" />
1919
<link rel="search" title="Search" href="../search.html" />
2020
<link rel="next" title="Object" href="object.html" />
21-
<link rel="prev" title="Client" href="client.html" />
21+
<link rel="prev" title="Client" href="client.html" />
2222
</head>
2323

24-
<body class="wy-body-for-nav">
24+
<body class="wy-body-for-nav">
2525
<div class="wy-grid-for-nav">
2626
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2727
<div class="wy-side-scroll">
2828
<div class="wy-side-nav-search" >
2929

30-
31-
30+
31+
3232
<a href="../index.html" class="icon icon-home">
3333
vt-py
3434
</a>
@@ -79,7 +79,7 @@
7979
</div>
8080
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
8181
<div itemprop="articleBody">
82-
82+
8383
<section id="feed">
8484
<h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading"></a></h1>
8585
<div class="admonition note">
@@ -92,7 +92,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
9292
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">vt.</span></span><span class="sig-name descname"><span class="pre">Feed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feed_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cursor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vt/feed.html#Feed"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
9393
<dd><p>Feed represents a stream of objects received from VirusTotal in real-time.</p>
9494
<p>For more information about VirusTotal Feeds see:
95-
<a class="reference external" href="https://developers.virustotal.com/v3.0/reference#feeds">https://developers.virustotal.com/v3.0/reference#feeds</a></p>
95+
<a class="reference external" href="https://docs.virustotal.com/reference/feeds">https://docs.virustotal.com/reference/feeds</a></p>
9696
<p>In the example below the loop iterates forever, retrieving file objects as
9797
they are processed by VirusTotal. For a more elaborate example see the file
9898
examples/file_feed.py in this repository.</p>
@@ -153,7 +153,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
153153
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
154154
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
155155
provided by <a href="https://readthedocs.org">Read the Docs</a>.
156-
156+
157157

158158
</footer>
159159
</div>
@@ -164,7 +164,7 @@ <h1>Feed<a class="headerlink" href="#feed" title="Permalink to this heading">
164164
jQuery(function () {
165165
SphinxRtdTheme.Navigation.enable(true);
166166
});
167-
</script>
167+
</script>
168168

169169
</body>
170-
</html>
170+
</html>

0 commit comments

Comments
 (0)