Bump to stable version

Author: mondeja

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.12.0
+    rev: v2.19.1
     hooks:
       - id: pyupgrade
         args:
           - --py36-plus
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
+    rev: v4.0.1
     hooks:
       - id: end-of-file-fixer
         name: end-of-file-fixer
@@ -15,13 +15,13 @@ repos:
     hooks:
       - id: setup-cfg-fmt
   - repo: https://github.com/psf/black
-    rev: 20.8b1
+    rev: 21.5b2
     hooks:
       - id: black
         language_version: python3
         files: \.py$
   - repo: https://github.com/PyCQA/flake8
-    rev: 3.9.1
+    rev: 3.9.2
     hooks:
       - id: flake8
         additional_dependencies:

README.md

@@ -4,6 +4,7 @@
 [![Python versions][pypi-pyversions-badge-link]][pypi-link]
 [![License][license-image]][license-link]
 [![Tests][tests-image]][tests-link]
+[![Downloads][pypi-downloads-image]][pypi-downloads-link]
 
 Pytest plugin for Blender testing. Executes your pytest testsuite with
 Blender in headless mode using its builtin Python interpreter.
@@ -210,4 +211,6 @@ jobs:
 [license-link]: https://github.com/mondeja/pytest-blender/blob/master/LICENSE
 [tests-image]: https://img.shields.io/github/workflow/status/mondeja/pytest-blender/CI
 [tests-link]: https://github.com/mondeja/pytest-blender/actions?query=workflow%3ACI
+[pypi-downloads-image]: https://img.shields.io/pypi/dm/pytest-blender
+[pypi-downloads-link]: https://pypistats.org/packages/pytest-blender
 [blender-downloader-link]: https://github.com/mondeja/blender-downloader

pytest_blender/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.5"
+__version__ = "1.0.0"

pytest_blender/__main__.py

@@ -6,7 +6,7 @@
 from pytest_blender.utils import which_blender_by_os
 
 
-__description__ = "Show a Blender builtin Python interpreter location."
+__description__ = "Show a Blender's builtin Python interpreter location."
 
 
 def build_parser():

pytest_blender/run_pytest.py

@@ -26,6 +26,22 @@ def _join(value):
 
 # this function can't be in 'utils'
 def get_blender_binary_path_python(blender_executable):
+    """Get Blender's Python executable location.
+
+    This function can't be in utils because the module is not loaded from
+    Blender (current script is executed inside Blender's Python executable).
+
+    Parameters
+    ----------
+
+    blender_executable : str
+      Blender's executable location.
+
+    Returns
+    -------
+
+    str: Blender's Python executable path.
+    """
     stdout = subprocess.check_output(
         [
             blender_executable,
@@ -62,6 +78,11 @@ def main():
         argv.append(arg)
 
     class PytestBlenderPlugin:
+        """Pytest plugin used by pytest-blender.
+
+        Injects all the fixtures in the Blender's PyTest session of the user.
+        """
+
         def _blender_python_executable(self, request):
             blender_python_executable = request.config.cache.get(
                 "pytest-blender/blender-python-executable",
@@ -79,14 +100,17 @@ def _blender_python_executable(self, request):
 
         @pytest.fixture
         def blender_executable(self):
+            """Get the executable of the current Blender's session."""
             return blender_executable
 
         @pytest.fixture
         def blender_python_executable(self, request):
+            """Get the executable of the current Blender's Python session."""
             return self._blender_python_executable(request)
 
         @pytest.fixture
         def blender_version(self, request):
+            """Get the Blender version of the current session."""
             blender_version = request.config.cache.get(
                 "pytest-blender/blender-version",
                 None,
@@ -106,6 +130,7 @@ def blender_version(self, request):
 
         @pytest.fixture
         def blender_python_version(self, request):
+            """Get the version of the Blender's Python executable."""
             blender_python_version = request.config.cache.get(
                 "pytest-blender/blender-python-version",
                 None,
@@ -131,6 +156,12 @@ def blender_python_version(self, request):
 
         @pytest.fixture(scope="session")
         def install_addons_from_dir(self, request):
+            """Install Blender's addons from directory.
+
+            Installs a set of Blender's addons into the current Blender's
+            session specifying the names of the addons to be installed.
+            """
+
             def _install_addons_from_dir(
                 addons_dir,
                 addon_module_names,
@@ -157,6 +188,8 @@ def _install_addons_from_dir(
 
         @pytest.fixture(scope="session")
         def disable_addons(self, request):
+            """Disable installed addons in the current Blender's session."""
+
             def _disable_addons(
                 addon_module_names,
                 save_userpref=True,

pytest_blender/utils.py

@@ -3,6 +3,7 @@
 
 
 def which_blender_by_os():
+    """Get the expected Blender executable location by operative system."""
     if sys.platform == "darwin":
         return "Blender"
     return "blender.exe" if "win" in sys.platform else shutil.which("blender")

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest_blender
-version = 0.0.5
+version = 1.0.0
 description = Blender Pytest plugin.
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -48,8 +48,8 @@ dev =
     pytest==6.2.1
     yamllint==1.26.1
 lint =
-    black==20.8b1
-    flake8==3.9.1
+    black==21.5b2
+    flake8==3.9.2
     flake8-implicit-str-concat==0.2.0
     flake8-print==4.0.0
     isort==5.8.0