pybiolib 1.2.520__tar.gz → 1.2.561__tar.gz

{pybiolib-1.2.520 → pybiolib-1.2.561}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pybiolib
-Version: 1.2.520
+Version: 1.2.561
 Summary: BioLib Python Client
 License: MIT
 Keywords: biolib
@@ -26,7 +26,7 @@ Requires-Dist: gunicorn (>=20.1.0) ; extra == "compute-node"
 Requires-Dist: importlib-metadata (>=1.6.1)
 Requires-Dist: pyyaml (>=5.3.1)
 Requires-Dist: rich (>=12.4.4)
-Requires-Dist: typing_extensions (>=3.10.0) ; python_version < "3.8"
+Requires-Dist: typing-extensions (>=4.1.0) ; python_version < "3.11"
 Project-URL: Homepage, https://github.com/biolib
 Description-Content-Type: text/markdown
 

pybiolib-1.2.561/biolib/__init__.py

@@ -0,0 +1,338 @@
+# Imports to hide
+import os
+from urllib.parse import urlparse as _urlparse
+
+from biolib import typing_utils as _typing_utils
+from biolib.app import BioLibApp as _BioLibApp
+# TODO: Fix ignore of type
+from biolib.app.search_apps import search_apps  # type: ignore
+from biolib.biolib_errors import BioLibError
+from biolib.biolib_logging import logger as _logger, logger_no_user_data as _logger_no_user_data
+from biolib.experiments.experiment import Experiment
+from biolib.biolib_api_client import BiolibApiClient as _BioLibApiClient, App
+from biolib.jobs import Job as _Job
+from biolib import user as _user
+from biolib.typing_utils import List, Optional, cast as _cast
+from biolib._data_record.data_record import DataRecord as _DataRecord
+
+import biolib.api
+import biolib.app
+import biolib.cli
+import biolib.sdk
+import biolib.utils
+
+
+# ------------------------------------ Function definitions for public Python API ------------------------------------
+
+def call_cli() -> None:
+    biolib.cli.cli()
+
+
+def load(uri: str) -> _BioLibApp:
+    r"""Load a BioLib application by its URI or website URL.
+
+    Args:
+        uri (str): The URI or website URL of the application to load. Can be either:
+            - App URI (e.g., 'biolib/myapp:1.0.0')
+            - Website URL (e.g., 'https://biolib.com/biolib/myapp/')
+
+    Returns:
+        BioLibApp: The loaded application object
+
+    Example::
+
+        >>> # Load by URI
+        >>> app = biolib.load('biolib/myapp:1.0.0')
+        >>> # Load by website URL
+        >>> app = biolib.load('https://biolib.com/biolib/myapp/')
+        >>> result = app.cli('--help')
+    """
+    return _BioLibApp(uri)
+
+
+def search(
+        search_query: Optional[str] = None,
+        team: Optional[str] = None,
+        count: int = 100,
+) -> List[str]:
+    r"""Search for BioLib applications.
+
+    Args:
+        search_query (str, optional): Search query string
+        team (str, optional): Filter by team name
+        count (int): Maximum number of results to return. Defaults to 100.
+
+    Returns:
+        List[str]: List of application URIs matching the search criteria
+
+    Example::
+
+        >>> # Search all apps
+        >>> apps = biolib.search()
+        >>> # Search by query
+        >>> alignment_apps = biolib.search('alignment')
+        >>> # Search team's apps
+        >>> team_apps = biolib.search(team='myteam')
+    """
+    apps: List[str] = search_apps(search_query, team, count)
+    return apps
+
+
+def get_job(job_id: str, job_token: Optional[str] = None) -> _Job:
+    r"""Get a job by its ID.
+
+    Args:
+        job_id (str): The UUID of the job to retrieve
+        job_token (str, optional): Authentication token for accessing the job.
+            Only needed for jobs that aren't owned by the current user.
+
+    Returns:
+        Job: The job object
+
+    Example::
+
+        >>> job = biolib.get_job('abc123')
+        >>> # Access shared job
+        >>> job = biolib.get_job('abc123', job_token='xyz789')
+    """
+    return _Job.create_from_uuid(uuid=job_id, auth_token=job_token)
+
+
+def get_data_record(uri: str) -> _DataRecord:
+    r"""Get a data record by its URI.
+
+    Args:
+        uri (str): The URI of the data record to retrieve
+
+    Returns:
+        DataRecord: The data record object
+
+    Example::
+
+        >>> record = biolib.get_data_record('biolib/data/sequences:1.0.0')
+    """
+    return _DataRecord.get_by_uri(uri)
+
+
+def fetch_jobs(count: int = 25, status: Optional[str] = None) -> List[_Job]:
+    r"""Fetch a list of jobs from the server.
+
+    Args:
+        count (int): Maximum number of jobs to fetch. Defaults to 25.
+        status (str, optional): Filter jobs by status. One of:
+            'in_progress', 'completed', 'failed', 'cancelled'
+
+    Returns:
+        List[Job]: List of job objects matching the criteria
+
+    Example::
+
+        >>> # Get last 10 completed jobs
+        >>> jobs = biolib.fetch_jobs(10, status='completed')
+        >>> # Get last 100 jobs of any status
+        >>> all_jobs = biolib.fetch_jobs(100)
+    """
+    return _Job.fetch_jobs(count, status)
+
+
+def fetch_data_records(uri: Optional[str] = None, count: Optional[int] = None) -> List[_DataRecord]:
+    r"""Fetch a list of data records from the server.
+
+    Args:
+        uri (str, optional): Filter records by URI prefix
+        count (int, optional): Maximum number of records to fetch
+
+    Returns:
+        List[DataRecord]: List of data record objects matching the criteria
+
+    Example::
+
+        >>> # Get all records
+        >>> records = biolib.fetch_data_records()
+        >>> # Get records with URI prefix
+        >>> seq_records = biolib.fetch_data_records('biolib/data/sequences')
+    """
+    return _DataRecord.fetch(uri, count)
+
+
+def get_experiment(uri: Optional[str] = None, name: Optional[str] = None) -> Experiment:
+    r"""Get an experiment by its URI or name.
+
+    Args:
+        uri (str, optional): The URI of the experiment
+        name (str, optional): The name of the experiment
+
+    Returns:
+        Experiment: The experiment object
+
+    Raises:
+        ValueError: If neither or both uri and name are provided
+
+    Example::
+
+        >>> # Get by URI
+        >>> exp = biolib.get_experiment(uri='biolib/experiments/analysis')
+        >>> # Get by name
+        >>> exp = biolib.get_experiment(name='sequence-analysis')
+    """
+    if (not uri and not name) or (uri and name):
+        raise ValueError('Must provide either uri or name')
+
+    return Experiment.get_by_uri(uri=_cast(str, uri or name))
+
+
+def show_jobs(count: int = 25) -> None:
+    r"""Display a table of recent jobs.
+
+    Args:
+        count (int): Maximum number of jobs to display. Defaults to 25.
+
+    Example::
+
+        >>> biolib.show_jobs()  # Show last 25 jobs
+        >>> biolib.show_jobs(100)  # Show last 100 jobs
+    """
+    _Job.show_jobs(count=count)
+
+
+def show_experiments(count: int = 25) -> None:
+    r"""Display a table of experiments.
+
+    Args:
+        count (int): Maximum number of experiments to display. Defaults to 25.
+
+    Example::
+
+        >>> biolib.show_experiments()  # Show last 25 experiments
+        >>> biolib.show_experiments(100)  # Show last 100 experiments
+    """
+    Experiment.show_experiments(count=count)
+
+
+def sign_in() -> None:
+    _user.sign_in()
+
+
+def sign_out() -> None:
+    _user.sign_out()
+
+
+def login() -> None:
+    r"""Alias for :func:`sign_in`.
+
+    Example::
+
+        >>> biolib.login()  # Same as biolib.sign_in()
+    """
+    sign_in()
+
+
+def logout() -> None:
+    r"""Alias for :func:`sign_out`.
+
+    Example::
+
+        >>> biolib.logout()  # Same as biolib.sign_out()
+    """
+    sign_out()
+
+
+def set_api_base_url(api_base_url: str) -> None:
+    r"""Set the base URL for the BioLib API.
+
+    Args:
+        api_base_url (str): The base URL for the BioLib API
+
+    Example::
+
+        >>> biolib.set_api_base_url('https://biolib.com')
+
+    Note:
+        This will also update related configuration like site hostname
+        and environment flags.
+    """
+    _BioLibApiClient.initialize(base_url=api_base_url)
+    biolib.utils.BIOLIB_BASE_URL = api_base_url
+    biolib.utils.BIOLIB_SITE_HOSTNAME = _urlparse(api_base_url).hostname
+    biolib.utils.BASE_URL_IS_PUBLIC_BIOLIB = api_base_url.endswith('biolib.com') or (
+            os.environ.get('BIOLIB_ENVIRONMENT_IS_PUBLIC_BIOLIB', '').upper() == 'TRUE'
+    )
+
+
+def set_base_url(base_url: str) -> None:
+    r"""Alias for :func:`set_api_base_url`.
+
+    Args:
+        base_url (str): The base URL for the BioLib API
+
+    Example::
+
+        >>> biolib.set_base_url('https://biolib.com')
+    """
+    return set_api_base_url(base_url)
+
+
+def set_api_token(api_token: str) -> None:
+    r"""Sign in using an API token.
+
+    Args:
+        api_token (str): The API token to authenticate with
+
+    Example::
+
+        >>> biolib.set_api_token('my-api-token')
+        # Signed in using API token
+    """
+    api_client = _BioLibApiClient.get()
+    api_client.sign_in_with_api_token(api_token)
+
+
+def set_log_level(level: _typing_utils.Union[str, int]) -> None:
+    r"""Set the logging level for BioLib.
+
+    Args:
+        level (Union[str, int]): The log level to use. Can be a string
+            ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL') or an integer
+            level from the logging module.
+
+    Example::
+
+        >>> biolib.set_log_level('DEBUG')  # Enable debug logging
+        >>> biolib.set_log_level('WARNING')  # Only show warnings and errors
+    """
+    _logger.setLevel(level)
+    _logger_no_user_data.setLevel(level)
+
+
+def _configure_requests_certificates():
+    if os.getenv('REQUESTS_CA_BUNDLE'):
+        if not os.getenv('SSL_CERT_FILE'):
+            # set SSL_CERT_FILE to urllib use same certs
+            os.environ['SSL_CERT_FILE'] = os.getenv('REQUESTS_CA_BUNDLE')
+        return  # don't change REQUESTS_CA_BUNDLE if manually configured
+
+    certs_to_check = [
+        '/etc/ssl/certs/ca-certificates.crt',
+        '/etc/pki/tls/certs/ca-bundle.crt',
+        '/etc/ssl/ca-bundle.pem',
+        '/etc/pki/tls/cacert.pem',
+        '/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem',
+        '/etc/ssl/cert.pem',
+    ]
+
+    for cert in certs_to_check:
+        if os.path.exists(cert):
+            os.environ['REQUESTS_CA_BUNDLE'] = cert
+            if not os.getenv('SSL_CERT_FILE'):
+                os.environ['SSL_CERT_FILE'] = cert
+            return
+
+
+# -------------------------------------------------- Configuration ---------------------------------------------------
+__version__ = biolib.utils.BIOLIB_PACKAGE_VERSION
+_DEFAULT_LOG_LEVEL = 'INFO' if biolib.utils.IS_RUNNING_IN_NOTEBOOK else 'WARNING'
+_logger.configure(default_log_level=_DEFAULT_LOG_LEVEL)
+_logger_no_user_data.configure(default_log_level=_DEFAULT_LOG_LEVEL)
+_configure_requests_certificates()
+
+set_api_base_url(biolib.utils.load_base_url_from_env())

pybiolib-1.2.561/biolib/_internal/types/resource_version.py

@@ -0,0 +1,13 @@
+from .typing import Literal, NotRequired, TypedDict
+
+
+class ResourceVersionDict(TypedDict):
+    uuid: str
+    semantic_version: str
+    state: Literal['published', 'unpublished']
+    created_at: str
+    git_branch_name: NotRequired[str]
+
+
+class ResourceVersionDetailedDict(ResourceVersionDict):
+    pass

{pybiolib-1.2.520 → pybiolib-1.2.561}/biolib/_internal/types/typing.py

@@ -5,3 +5,6 @@ from typing import *  # noqa:F403 pylint: disable=wildcard-import, unused-wildca
 
 if sys.version_info < (3, 8):  # noqa: UP036
     from typing_extensions import Literal, TypedDict  # pylint: disable=unused-import
+
+if sys.version_info < (3, 11):  # noqa: UP036
+    from typing_extensions import NotRequired  # pylint: disable=unused-import

{pybiolib-1.2.520 → pybiolib-1.2.561}/biolib/app/app.py

@@ -108,7 +108,7 @@ class BioLibApp:
                 (utils.STREAM_STDOUT or stream_logs)
                 and (self._app_version.get('main_output_file') or self._app_version.get('stdout_render_type') == 'text')
             )
-            job._stream_logs(enable_print=enable_print) # pylint: disable=protected-access
+            job._stream_logs(enable_print=enable_print)  # pylint: disable=protected-access
 
             if check:
                 exit_code = job.get_exit_code()

{pybiolib-1.2.520 → pybiolib-1.2.561}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pybiolib"
-version = "1.2.520"
+version = "1.2.561"
 description = "BioLib Python Client"
 readme = "PYPI_README.md"
 license = "MIT"
@@ -32,7 +32,7 @@ importlib-metadata = ">=1.6.1"
 python = "^3.6.3"
 pyyaml = ">=5.3.1"
 rich = ">=12.4.4"
-typing_extensions = { version = ">=3.10.0", python = "<3.8" }
+typing-extensions = { version = ">=4.1.0", python = "<3.11" }
 
 # Optional dependencies included in the below `extras`
 flask = { version = ">=2.0.1", optional = true }

pybiolib-1.2.520/biolib/__init__.py

@@ -1,145 +0,0 @@
-# Imports to hide
-import os
-from urllib.parse import urlparse as _urlparse
-
-from biolib import typing_utils as _typing_utils
-from biolib.app import BioLibApp as _BioLibApp
-# TODO: Fix ignore of type
-from biolib.app.search_apps import search_apps  # type: ignore
-from biolib.biolib_errors import BioLibError
-from biolib.biolib_logging import logger as _logger, logger_no_user_data as _logger_no_user_data
-from biolib.experiments.experiment import Experiment
-from biolib.biolib_api_client import BiolibApiClient as _BioLibApiClient, App
-from biolib.jobs import Job as _Job
-from biolib import user as _user
-from biolib.typing_utils import List, Optional, cast as _cast
-from biolib._data_record.data_record import DataRecord as _DataRecord
-
-import biolib.api
-import biolib.app
-import biolib.cli
-import biolib.sdk
-import biolib.utils
-
-
-# ------------------------------------ Function definitions for public Python API ------------------------------------
-
-def call_cli() -> None:
-    biolib.cli.cli()
-
-
-def load(uri: str) -> _BioLibApp:
-    return _BioLibApp(uri)
-
-
-def search(
-        search_query: Optional[str] = None,
-        team: Optional[str] = None,
-        count: int = 100,
-) -> List[str]:
-    apps: List[str] = search_apps(search_query, team, count)
-    return apps
-
-
-def get_job(job_id: str, job_token: Optional[str] = None) -> _Job:
-    return _Job.create_from_uuid(uuid=job_id, auth_token=job_token)
-
-
-def get_data_record(uri: str) -> _DataRecord:
-    return _DataRecord.get_by_uri(uri)
-
-
-def fetch_jobs(count: int = 25, status: Optional[str] = None) -> List[_Job]:
-    return _Job.fetch_jobs(count, status)
-
-
-def fetch_data_records(uri: Optional[str] = None, count: Optional[int] = None) -> List[_DataRecord]:
-    return _DataRecord.fetch(uri, count)
-
-
-def get_experiment(uri: Optional[str] = None, name: Optional[str] = None) -> Experiment:
-    if (not uri and not name) or (uri and name):
-        raise ValueError('Must provide either uri or name')
-
-    return Experiment.get_by_uri(uri=_cast(str, uri or name))
-
-
-def show_jobs(count: int = 25) -> None:
-    _Job.show_jobs(count=count)
-
-
-def show_experiments(count: int = 25) -> None:
-    Experiment.show_experiments(count=count)
-
-
-def sign_in() -> None:
-    _user.sign_in()
-
-
-def sign_out() -> None:
-    _user.sign_out()
-
-
-def login() -> None:
-    sign_in()
-
-
-def logout() -> None:
-    sign_out()
-
-
-def set_api_base_url(api_base_url: str) -> None:
-    _BioLibApiClient.initialize(base_url=api_base_url)
-    biolib.utils.BIOLIB_BASE_URL = api_base_url
-    biolib.utils.BIOLIB_SITE_HOSTNAME = _urlparse(api_base_url).hostname
-    biolib.utils.BASE_URL_IS_PUBLIC_BIOLIB = api_base_url.endswith('biolib.com') or (
-            os.environ.get('BIOLIB_ENVIRONMENT_IS_PUBLIC_BIOLIB', '').upper() == 'TRUE'
-    )
-
-
-def set_base_url(base_url: str) -> None:
-    return set_api_base_url(base_url)
-
-
-def set_api_token(api_token: str) -> None:
-    api_client = _BioLibApiClient.get()
-    api_client.sign_in_with_api_token(api_token)
-
-
-def set_log_level(level: _typing_utils.Union[str, int]) -> None:
-    _logger.setLevel(level)
-    _logger_no_user_data.setLevel(level)
-
-
-def _configure_requests_certificates():
-    if os.getenv('REQUESTS_CA_BUNDLE'):
-        if not os.getenv('SSL_CERT_FILE'):
-            # set SSL_CERT_FILE to urllib use same certs
-            os.environ['SSL_CERT_FILE'] = os.getenv('REQUESTS_CA_BUNDLE')
-        return  # don't change REQUESTS_CA_BUNDLE if manually configured
-
-    certs_to_check = [
-        '/etc/ssl/certs/ca-certificates.crt',
-        '/etc/pki/tls/certs/ca-bundle.crt',
-        '/etc/ssl/ca-bundle.pem',
-        '/etc/pki/tls/cacert.pem',
-        '/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem',
-        '/etc/ssl/cert.pem',
-    ]
-
-    for cert in certs_to_check:
-        if os.path.exists(cert):
-            os.environ['REQUESTS_CA_BUNDLE'] = cert
-            if not os.getenv('SSL_CERT_FILE'):
-                os.environ['SSL_CERT_FILE'] = cert
-            return
-
-
-# -------------------------------------------------- Configuration ---------------------------------------------------
-__version__ = biolib.utils.BIOLIB_PACKAGE_VERSION
-_DEFAULT_LOG_LEVEL = 'INFO' if biolib.utils.IS_RUNNING_IN_NOTEBOOK else 'WARNING'
-_logger.configure(default_log_level=_DEFAULT_LOG_LEVEL)
-_logger_no_user_data.configure(default_log_level=_DEFAULT_LOG_LEVEL)
-_configure_requests_certificates()
-
-set_api_base_url(biolib.utils.load_base_url_from_env())

pybiolib-1.2.520/biolib/_internal/types/resource_version.py

@@ -1,7 +0,0 @@
-from .typing import Literal, TypedDict
-
-
-class ResourceVersionDetailedDict(TypedDict):
-    semantic_version: str
-    state: Literal['published', 'unpublished']
-    uuid: str