PyLinks 0.0.0.dev23__tar.gz → 0.0.0.dev24__tar.gz

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/PKG-INFO

@@ -1,5 +1,5 @@
 Metadata-Version: 2.1
 Name: PyLinks
-Version: 0.0.0.dev23
-Requires-Python: >=3.9
+Version: 0.0.0.dev24
+Requires-Python: >=3.10
 Requires-Dist: requests<3,>=2.31.0

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/pyproject.toml

@@ -17,10 +17,10 @@ namespaces = true
 # ----------------------------------------- Project Metadata -------------------------------------
 #
 [project]
-version = "0.0.0.dev23"
+version = "0.0.0.dev24"
 name = "PyLinks"
 dependencies = [
     "requests >= 2.31.0, < 3",
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/PyLinks.egg-info/PKG-INFO

@@ -1,5 +1,5 @@
 Metadata-Version: 2.1
 Name: PyLinks
-Version: 0.0.0.dev23
-Requires-Python: >=3.9
+Version: 0.0.0.dev24
+Requires-Python: >=3.10
 Requires-Dist: requests<3,>=2.31.0

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/PyLinks.egg-info/SOURCES.txt

@@ -18,5 +18,6 @@ src/pylinks/site/__init__.py
 src/pylinks/site/binder.py
 src/pylinks/site/conda.py
 src/pylinks/site/github.py
+src/pylinks/site/lib_io.py
 src/pylinks/site/pypi.py
 src/pylinks/site/readthedocs.py

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/__init__.py

@@ -11,7 +11,5 @@ but can be used directly from the root. It returns a URL object, also defined in
 Other available modules offer shortcuts for creating useful URLs for popular online services.
 """
 
-from ._settings import settings
-from .url import url
-from .http import request, download, graphql_query
-from . import api, site
+from pylinks._settings import settings
+from pylinks import url, http, api, site, exceptions

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/api/doi.py

@@ -5,7 +5,7 @@ import datetime
 from typing import Optional
 
 # Non-standard libraries
-from pylinks.http import request as _request
+import pylinks as _pylinks
 
 
 class DOI:
@@ -58,13 +58,13 @@ class DOI:
             accept += f"; style={style}"
         if locale:
             accept += f"; locale={locale}"
-        return _request(
+        return _pylinks.http.request(
             self.url, headers={"accept": accept}, encoding="utf-8", response_type="str"
         )
 
     @property
     def bibtex(self) -> str:
-        return _request(
+        return _pylinks.http.request(
             self.url,
             headers={"accept": "application/x-bibtex"},
             encoding="utf-8",
@@ -73,7 +73,7 @@ class DOI:
 
     @property
     def ris(self) -> str:
-        return _request(
+        return _pylinks.http.request(
             self.url,
             headers={"accept": "application/x-research-info-systems"},
             encoding="utf-8",
@@ -85,7 +85,7 @@ class DOI:
         """
         Citation data as a dictionary with Citeproc JSON schema.
         """
-        return _request(
+        return _pylinks.http.request(
             self.url,
             headers={"accept": "application/citeproc+json"},
             encoding="utf-8",
@@ -98,7 +98,7 @@ class DOI:
         journal = data["container-title"] or None
         journal_abbr = (
             (
-                data.get("container-title-short") or _request(
+                data.get("container-title-short") or _pylinks.http.request(
                 f"https://abbreviso.toolforge.org/abbreviso/a/{journal}",
                     response_type="str",
                 ).title()

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/api/github.py

@@ -5,16 +5,15 @@ import re
 import mimetypes
 
 # Non-standard libraries
-import pylinks
-from pylinks import request, url, graphql_query
+import pylinks as _pylinks
 
 
 class GitHub:
 
     def __init__(self, token: Optional[str] = None):
         self._endpoint = {
-            "api": url("https://api.github.com"),
-            "upload": url("https://uploads.github.com"),
+            "api": _pylinks.url.create("https://api.github.com"),
+            "upload": _pylinks.url.create("https://uploads.github.com"),
         }
         self._token = token
         self._headers = {"X-GitHub-Api-Version": "2022-11-28"}
@@ -31,7 +30,7 @@ class GitHub:
         extra_headers: dict | None = None,
     ) -> dict:
         headers = self._headers | extra_headers if extra_headers else self._headers
-        response = graphql_query(
+        response = _pylinks.http.graphql_query(
             url=self._endpoint["api"] / "graphql",
             query=f"{{{query}}}",
             headers=headers,
@@ -50,7 +49,7 @@ class GitHub:
             f'mutation($mutationInput:{mutation_input_name}!) '
             f'{{{mutation_name}(input:$mutationInput) {{{mutation_payload}}}}}'
         )
-        response = graphql_query(
+        response = _pylinks.http.graphql_query(
             url=self._endpoint["api"] / "graphql",
             query=query,
             variables={"mutationInput": mutation_input},
@@ -69,7 +68,7 @@ class GitHub:
         endpoint: Literal['api', 'upload'] = "api"
     ):
         headers = self._headers | extra_headers if extra_headers else self._headers
-        return request(
+        return _pylinks.http.request(
             verb=verb,
             url=self._endpoint[endpoint] / query,
             headers=headers,
@@ -328,7 +327,7 @@ class Repo:
                 if entry["type"] == "file":
                     filename = Path(entry["path"]).name
                     full_download_path = download_path / filename
-                    pylinks.download(
+                    _pylinks.http.download(
                         url=entry["download_url"], filepath=full_download_path, create_dirs=create_dirs
                     )
                     final_download_paths.append(full_download_path)
@@ -362,7 +361,7 @@ class Repo:
             full_download_path = download_path / download_filename
         else:
             full_download_path = download_path / Path(content["path"]).name
-        pylinks.download(
+        _pylinks.http.download(
             url=content["download_url"],
             filepath=full_download_path,
             create_dirs=create_dirs,
@@ -391,11 +390,6 @@ class Repo:
     def discussion_categories(self) -> list[dict[str, str]]:
         """Get discussion categories for a repository.
 
-        Parameters
-        ----------
-        access_token : str
-            GitHub access token.
-
         Returns
         -------
             A list of discussion categories as dictionaries with keys "name", "slug", and "id".

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/api/orcid.py

@@ -3,7 +3,7 @@ import re
 import warnings
 
 # Non-standard libraries
-import pylinks
+import pylinks as _pylinks
 
 
 class Orcid:
@@ -20,7 +20,7 @@ class Orcid:
     @property
     def records(self) -> dict:
         if not self._data:
-            self._data = pylinks.request(
+            self._data = _pylinks.http.request(
                 url=f"https://pub.orcid.org/v3.0/{self.id}",
                 headers={"Accept": "application/json"},
                 response_type="json",

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/http.py

@@ -20,7 +20,7 @@ import time
 from functools import wraps
 from pathlib import Path
 import requests
-from pylinks import exceptions
+import pylinks as _pylinks
 
 
 class RetryConfig(NamedTuple):
@@ -73,7 +73,7 @@ class HTTPRequestRetryConfig(NamedTuple):
 
 
 def request(
-    url: str,
+    url: str | _pylinks.url.URL,
     verb: Union[str, Literal["GET", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"]] = "GET",
     params: Optional[Union[dict, List[tuple], bytes]] = None,
     data: Optional[Union[dict, List[tuple], bytes]] = None,
@@ -189,7 +189,7 @@ def request(
             else _retry_on_exception(
                 get_response,
                 config=retry_config.config_status,
-                catch=exceptions.WebAPITemporaryStatusCodeError,
+                catch=_pylinks.exceptions.WebAPITemporaryStatusCodeError,
             )
         )
         # Call the (decorated or non-decorated) response function.
@@ -212,7 +212,7 @@ def request(
         if response_verifier is None or response_verifier(response_value):
             return response_value
         # otherwise raise
-        raise exceptions.WebAPIValueError(response_value=response_value, response_verifier=response_verifier)
+        raise _pylinks.exceptions.WebAPIValueError(response_value=response_value, response_verifier=response_verifier)
 
     # Depending on specifications in argument `retry_config`, either decorate `get_response_value`
     # with `retry_on_exception`, or leave it as is.
@@ -226,7 +226,7 @@ def request(
         else _retry_on_exception(
             get_response_value,
             config=retry_config.config_response,
-            catch=exceptions.WebAPIValueError,
+            catch=_pylinks.exceptions.WebAPIValueError,
         )
     )
     # Call the (decorated or non-decorated) response-value function and return.
@@ -266,9 +266,9 @@ def graphql_query(
     response = request(**args)
     if isinstance(response, dict):
         if "errors" in response:
-            raise exceptions.WebAPIError(response)
+            raise _pylinks.exceptions.WebAPIError(response)
         elif "data" not in response:
-            raise exceptions.WebAPIError(response)
+            raise _pylinks.exceptions.WebAPIError(response)
         else:
             response = response["data"]
     return response
@@ -352,9 +352,9 @@ def _raise_for_status_code(
         temporary_error_status_codes is not None
         and response.status_code in temporary_error_status_codes
     ):
-        raise exceptions.WebAPITemporaryStatusCodeError(response)
+        raise _pylinks.exceptions.WebAPITemporaryStatusCodeError(response)
     if error_status_code_range[0] <= response.status_code <= error_status_code_range[1]:
-        raise exceptions.WebAPIPersistentStatusCodeError(response)
+        raise _pylinks.exceptions.WebAPIPersistentStatusCodeError(response)
     return
 
 

pylinks-0.0.0.dev24/src/pylinks/site/__init__.py

@@ -0,0 +1 @@
+from pylinks.site import binder, conda, github, pypi, readthedocs, lib_io

pylinks-0.0.0.dev24/src/pylinks/site/binder.py

@@ -0,0 +1,185 @@
+"""URLs for Binder images.
+
+References
+----------
+- [Binder](https://mybinder.org/)
+"""
+
+
+import pylinks as _pylinks
+
+
+_BASE_URL = _pylinks.url.create(url="https://mybinder.org/v2")
+
+
+def github(
+    user: str,
+    repo: str,
+    ref: str = "HEAD",
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a GitHub repository.
+
+    Parameters
+    ----------
+    user : str
+        GitHub username.
+    repo : str
+        GitHub repository name.
+    ref : str, default: "HEAD"
+        Branch, tag, or commit hash to use.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "gh" / user / repo / ref
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def gist(
+    user: str,
+    gist_id: str,
+    ref: str = "HEAD",
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a GitHub Gist.
+
+    Parameters
+    ----------
+    user : str
+        GitHub username.
+    gist_id : str
+        GitHub Gist ID.
+    ref : str, default: "HEAD"
+        Commit hash to use.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "gist" / user / gist_id / ref
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def git(
+    url: str,
+    ref: str = "HEAD",
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a Git repository.
+
+    Parameters
+    ----------
+    url : str
+        URL of the Git repository.
+    ref : str, default: "HEAD"
+        Branch, tag, or commit hash to use.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "git" / url / ref
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def gitlab(
+    user: str,
+    repo: str,
+    ref: str = "HEAD",
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a GitLab repository.
+
+    Parameters
+    ----------
+    user : str
+        GitLab username.
+    project : str
+        GitLab repository name.
+    ref : str, default: "HEAD"
+        Branch, tag, or commit hash to use.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "gl" / user / repo / ref
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def zenodo(
+    doi: str,
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a Zenodo repository.
+
+    Parameters
+    ----------
+    doi : str
+        Zenodo DOI.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "zenodo" / doi
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def figshare(
+    doi: str,
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a Figshare repository.
+
+    Parameters
+    ----------
+    doi : str
+        Figshare DOI.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "figshare" / doi
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def hydroshare(
+    resource_id: str,
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a HydroShare resource.
+
+    Parameters
+    ----------
+    resource_id : str
+        HydroShare resource ID.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "hydroshare" / resource_id
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url
+
+
+def dataverse(
+    doi: str,
+    notebook_path: str | None = None,
+) -> _pylinks.url.URL:
+    """Create a Binder URL for a Dataverse repository.
+
+    Parameters
+    ----------
+    doi : str
+        Dataverse DOI.
+    notebook_path : str, optional
+        Path to a Jupyter notebook file to open.
+    """
+    url = _BASE_URL / "dataverse" / doi
+    if notebook_path is not None:
+        url.queries["labpath"] = notebook_path
+    return url

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/site/conda.py

@@ -7,11 +7,10 @@ from typing import Optional
 
 # Non-standard libraries
 import requests
-from pylinks import settings, url
-from pylinks.url import URL
+import pylinks as _pylinks
 
 
-BASE_URL = url(url="https://anaconda.org")
+BASE_URL = _pylinks.url.create(url="https://anaconda.org")
 
 
 class Package:
@@ -37,7 +36,7 @@ class Package:
             )
         self._name = name
         self._channel = channel
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.homepage)).raise_for_status()
 
     def __repr__(self):
@@ -57,7 +56,7 @@ class Package:
         return self._channel
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the package homepage."""
         return BASE_URL / self.channel / self.name
 

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/site/github.py

@@ -7,11 +7,10 @@ from typing import Literal, Optional
 
 # Non-standard libraries
 import requests
-from pylinks import settings, url
-from pylinks.url import URL
+import pylinks as _pylinks
 
 
-BASE_URL = url(url="https://github.com")
+BASE_URL = _pylinks.url.create(url="https://github.com")
 
 
 class User:
@@ -33,7 +32,7 @@ class User:
                 "GitHub usernames can only contain alphanumeric characters and dashes."
             )
         self._name = name
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.homepage)).raise_for_status()
         return
 
@@ -49,7 +48,7 @@ class User:
         return self._name
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the GitHub user's homepage."""
         return BASE_URL / self.name
 
@@ -88,7 +87,7 @@ class Repo:
             raise ValueError(
                 'GitHub repository names can only contain "_", "-", ".", and alphanumeric characters.'
             )
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.homepage)).raise_for_status()
         return
 
@@ -109,11 +108,11 @@ class Repo:
         return self._name
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the repository's homepage."""
         return self.user.homepage / self.name
 
-    def workflow(self, filename: str) -> URL:
+    def workflow(self, filename: str) -> _pylinks.url.URL:
         """
         URL of a GitHub Actions workflow in the repository.
 
@@ -124,7 +123,7 @@ class Repo:
         """
         return self.homepage / "actions/workflows" / filename
 
-    def workflow_run(self, run_id: str) -> URL:
+    def workflow_run(self, run_id: str) -> _pylinks.url.URL:
         """
         URL of the summary page of a specific GitHub Actions workflow run in the repository.
 
@@ -137,7 +136,7 @@ class Repo:
 
     def pr_issues(
         self, pr: bool = True, closed: Optional[bool] = None, label: Optional[str] = None
-    ) -> URL:
+    ) -> _pylinks.url.URL:
         """
         URL of pull requests or issues in the repository.
 
@@ -162,11 +161,11 @@ class Repo:
             url.queries["q"] += f"+label:{label}"
         return url
 
-    def commit(self, commit_hash: str) -> URL:
+    def commit(self, commit_hash: str) -> _pylinks.url.URL:
         """URL of a specific commit in the repository."""
         return self.homepage / "commit" / commit_hash
 
-    def releases(self, tag: Optional[str | Literal["latest"]] = None) -> URL:
+    def releases(self, tag: Optional[str | Literal["latest"]] = None) -> _pylinks.url.URL:
         """
         URL of the releases overview page, or a specific release.
 
@@ -186,11 +185,24 @@ class Repo:
         return base_url / "tag" / tag
 
     @property
-    def commits(self) -> URL:
+    def commits(self) -> _pylinks.url.URL:
         """URL of commits page."""
         return self.homepage / "commits"
 
-    def discussions(self, category: Optional[str] = None) -> URL:
+    def compare(self, base: str, head: str) -> _pylinks.url.URL:
+        """
+        URL of a comparison between two references, i.e., branches, tags, or hashes.
+
+        Parameters
+        ----------
+        base : str
+            The base reference.
+        head : str
+            The head reference.
+        """
+        return self.homepage / "compare" / f"{base}...{head}"
+
+    def discussions(self, category: Optional[str] = None) -> _pylinks.url.URL:
         """
         URL of discussions page, or a specific discussion category page.
 
@@ -248,7 +260,7 @@ class Branch:
             raise ValueError(
                 'GitHub branch names can only contain "_", "-", ".", "/", and alphanumeric characters.'
             )
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.homepage)).raise_for_status()
         return
 
@@ -258,7 +270,7 @@ class Branch:
         return self._repo
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the branch's homepage."""
         return self.repo.homepage / "tree" / self.name
 
@@ -267,7 +279,7 @@ class Branch:
         """Name of the branch."""
         return self._name
 
-    def workflow(self, filename: str) -> URL:
+    def workflow(self, filename: str) -> _pylinks.url.URL:
         """
         URL of a GitHub Actions workflow for this specific branch.
 
@@ -280,11 +292,11 @@ class Branch:
         url.queries = {"query": f"branch:{self.name}"}
         return url
 
-    def file(self, filename: str, raw: bool = False) -> URL:
+    def file(self, filename: str, raw: bool = False) -> _pylinks.url.URL:
         """URL of a specific file in the branch."""
         if raw:
             return (
-                url("https://raw.githubusercontent.com")
+                _pylinks.url.create("https://raw.githubusercontent.com")
                 / self.repo.user.name
                 / self.repo.name
                 / self.name
@@ -293,7 +305,7 @@ class Branch:
         return self.homepage / filename
 
     @property
-    def commits(self) -> URL:
+    def commits(self) -> _pylinks.url.URL:
         """URL of commits page for this branch."""
         return self.repo.homepage / "commits" / self.name
 

pylinks-0.0.0.dev24/src/pylinks/site/lib_io.py

@@ -0,0 +1,67 @@
+"""URLs for the Libraries.io website."""
+
+
+# Non-standard libraries
+import requests
+import pylinks as _pylinks
+
+
+BASE_URL = _pylinks.url.create(url="https://libraries.io")
+
+
+class Package:
+    """A Libraries.IO package site."""
+
+    def __init__(self, platform: str, package: str, validate: bool | None = None):
+        """
+        Parameters
+        ----------
+        platform : str
+            Name of the platform where the package is distributed, e.g. 'pypi', 'npm', etc.
+        package : str
+            Name of the package.
+        validate : bool, default: None
+            Whether to validate the URL online (requires an active internet connection).
+            If set to None (default), the global default value defined in `pylinks.OFFLINE_MODE` is used.
+        """
+        if not isinstance(platform, str):
+            raise TypeError(f"`platform` must be a string, not {type(platform)}.")
+        if not isinstance(package, str):
+            raise TypeError(f"`package` must be a string, not {type(package)}.")
+        self._platform = platform
+        self._package = package
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
+            requests.get(str(self.homepage)).raise_for_status()
+        return
+
+    @property
+    def platform(self) -> str:
+        """Name of the platform."""
+        return self._platform
+
+    @property
+    def package(self) -> str:
+        """Name of the package."""
+        return self._package
+
+    @property
+    def homepage(self) -> _pylinks.url.URL:
+        """URL of the package's homepage."""
+        return BASE_URL / self._platform / self._package
+
+    def dependencies(self, version: str) -> _pylinks.url.URL:
+        """URL of the webpage showing the dependencies of the package."""
+        return self.homepage / version / "tree"
+
+    @property
+    def source_rank(self) -> _pylinks.url.URL:
+        """URL of the webpage showing the source rank of the package."""
+        return self.homepage / "sourcerank"
+
+
+def package(
+    platform: str,
+    package: str,
+    validate: bool | None = None,
+):
+    return Package(platform=platform, package=package, validate=validate)

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/site/pypi.py

@@ -7,11 +7,10 @@ from typing import Optional
 
 # Non-standard libraries
 import requests
-from pylinks import settings, url
-from pylinks.url import URL
+import pylinks as _pylinks
 
 
-BASE_URL = url("https://pypi.org")
+BASE_URL = _pylinks.url.create("https://pypi.org")
 
 
 class Package:
@@ -34,7 +33,7 @@ class Package:
                 "Distribution name is invalid; see https://peps.python.org/pep-0508/#names."
             )
         self._name = name
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.homepage)).raise_for_status()
 
     @property
@@ -43,7 +42,7 @@ class Package:
         return self._name
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the package homepage."""
         return BASE_URL / "project" / self.name
 

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/site/readthedocs.py

@@ -6,11 +6,10 @@ from typing import Optional
 
 # Non-standard libraries
 import requests
-from pylinks import settings, url
-from pylinks.url import URL
+import pylinks as _pylinks
 
 
-BASE_URL = url(url="https://readthedocs.org")
+BASE_URL = _pylinks.url.create(url="https://readthedocs.org")
 
 
 class Project:
@@ -29,7 +28,7 @@ class Project:
         if not isinstance(name, str):
             raise TypeError(f"`name` must be a string, not {type(name)}.")
         self._name = name
-        if validate is True or (validate is None and not settings.offline_mode):
+        if validate is True or (validate is None and not _pylinks.settings.offline_mode):
             requests.get(str(self.project_home)).raise_for_status()
         return
 
@@ -39,19 +38,19 @@ class Project:
         return self._name
 
     @property
-    def project_home(self) -> URL:
+    def project_home(self) -> _pylinks.url.URL:
         """URL of the project's homepage. This is not the homepage of the website."""
         return BASE_URL / "projects" / self.name
 
     @property
-    def build_status(self) -> URL:
+    def build_status(self) -> _pylinks.url.URL:
         """URL of the webpage showing an overview of the website's build status."""
         return self.project_home / "builds"
 
     @property
-    def homepage(self) -> URL:
+    def homepage(self) -> _pylinks.url.URL:
         """URL of the website's homepage."""
-        return url(f"https://{self.name}.readthedocs.io")
+        return _pylinks.url.create(f"https://{self.name}.readthedocs.io")
 
 
 def project(

{PyLinks-0.0.0.dev23 → pylinks-0.0.0.dev24}/src/pylinks/url.py

@@ -14,7 +14,7 @@ class URL:
     def __init__(
         self,
         base: str,
-        queries: Optional[dict[str, str | bytes | None]] = None,
+        queries: Optional[dict[str, str | bytes | bool | None]] = None,
         fragment: Optional[str] = None,
         quote_safe: Optional[str] = "",
         query_delimiter: str = "&",
@@ -142,7 +142,7 @@ class URL:
         webbrowser.open(url=str(self), new=new, autoraise=autoraise)
 
 
-def url(
+def create(
     url: str,
     queries: Optional[dict[str, str | bytes | None]] = None,
     fragment: Optional[str] = None,

PyLinks-0.0.0.dev23/src/pylinks/site/__init__.py

@@ -1 +0,0 @@
-from . import binder, conda, github, pypi, readthedocs

PyLinks-0.0.0.dev23/src/pylinks/site/binder.py

@@ -1,2 +0,0 @@
-def launch():
-    return "https://mybinder.org/v2/gh/Armin-Ariamajd/duq/main"