Merge pull request #34 from dbrennand/1.0.0

1.0.0

Author: dbrennand

.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+on:
+  - pull_request
+  - push
+
+jobs:
+  Test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Load cached Poetry installation
+        uses: actions/cache@v2
+        with:
+          path: ~/.local
+          key: poetry-0
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v2
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies if cache does not exist
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root
+
+      - name: Install library
+        run: poetry install --no-interaction
+
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          black . --check
+          pytest tests/ --cov=virustotal_python

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish
+on:
+  push:
+    tags:
+      - "*.*.*"
+
+jobs:
+  Publish:
+    if: github.repository == 'dbrennand/virustotal-python' && github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Load cached Poetry installation
+        uses: actions/cache@v2
+        with:
+          path: ~/.local
+          key: poetry-0
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Configure Poetry
+        run: poetry config pypi-token.pypi "${{ secrets.PYPI_API_KEY }}"
+
+      - name: Publish virustotal-python
+        run: poetry publish --build

CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+## 1.0.0
+
+### Breaking Changes
+
+* The `Virustotal` class now defaults to version 3 of the VirusTotal API.
+
+* Dropped support for `COMPATIBILITY_ENABLED` parameter on the `Virustotal` class.
+
+### Docs
+
+* Updated README content including instructions for running tests and improve general readability.
+
+* Moved to using Google docstring format.
+
+* Improved type hints.
+
+* Refactored examples to favour version 3 of the VirusTotal API.
+
+* Added a proper CHANGELOG.
+
+### Tests
+
+* Added new unit tests with 95% coverage.
+
+### Misc Changes
+
+* `API_VERSION` can now accept an `int` to specify VirusTotal API version to use.
+
+* Add GitHub actions workflows for automated testing and publishing.
+
+## 0.2.0
+
+Added `large_file` parameter to `request` so a file larger than 32MB can be submitted for analysis. See [#33](https://github.com/dbrennand/virustotal-python/pull/33). Thank you @smk762.
+
+## 0.1.3
+
+Update urllib3 to 1.26.5 to address [CVE-2021-33503](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-33503).
+
+## 0.1.2
+
+Update dependencies for security vulnerability. Fixed an issue with some tests failing.
+
+## 0.1.1
+
+Added Context Manager support and tests. Updated dependencies and license year.
+
+## 0.1.0
+
+Added support for the VirusTotal v3 API. Library redesign (new usage, examples, tests and more.) See [#24](https://github.com/dbrennand/virustotal-python/pull/24).
+
+## 0.0.9
+
+Update dependencies for security vulnerability.
+
+## 0.0.8
+
+Updated dependencies, removed method `file_rescan`
+
+## 0.0.7
+
+Added tests. Updated dependencies, Updated examples and README, `url_report` param `scan` now accepts `type(int)`, no longer `type(str)`
+
+## 0.0.6
+
+Fixed usage example and dependencies in README.md, Setup github.io website, updated requirements.txt.
+
+## 0.0.5
+
+Added proxy support. Via HTTP(S) or using SOCKS: See [#8](https://github.com/dbrennand/virustotal-python/pull/8).
+
+## 0.0.4
+
+README.md updated; dependencies updated.
+
+## 0.0.3
+
+Updated dependencies for `urllib3` security vulnerability.
+
+## 0.0.2
+
+Changes to file_rescan(), file_report(), url_scan(), url_report() to improve ease of use of the wrapper. See issue [#2](https://github.com/dbrennand/virustotal-python/issues/2). Examples updated for changes.
+
+## 0.0.1
+
+Initial release of virustotal-python. Covered all endpoints of the Virustotal public API.