detail.html

{#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#}
{% extends "base.html" %}

{% macro url_icon(name, url) -%}

{% set parsed = url|urlparse %}

{% if name|lower == "download" %}
   {% set icon = "fas fa-cloud-download-alt" %}
{% elif name|lower in ["home", "homepage", "home page"] %}
  {% set icon = "fas fa-home" %}
{% elif name|lower in ["changelog", "change log", "changes", "release notes", "news", "what's new", "history"] %}
  {% set icon = "fas fa-scroll" %}
{% elif name.lower().startswith(("docs", "documentation")) or parsed.netloc in ["readthedocs.io", "readthedocs.org", "rtfd.io", "rtfd.org"] or parsed.netloc.endswith((".readthedocs.io", ".readthedocs.org", ".rtfd.io", ".rtfd.org")) or parsed.netloc.startswith(("docs.", "documentation.")) %}
  {% set icon = "fas fa-book" %}
{% elif name.lower().startswith(("bug", "issue", "tracker", "report")) %}
  {% set icon = "fas fa-bug" %}
{% elif name.lower().startswith(("funding", "donate", "donation", "sponsor")) %}
  {% set icon = "fas fa-donate" %}
{% elif parsed.netloc in ["github.com", "github.io"] or parsed.netloc.endswith((".github.com", ".github.io")) %}
  {% set icon = "fab fa-github" %}
{% elif parsed.netloc == "gitlab.com" or parsed.netloc.endswith(".gitlab.com") %}
  {% set icon = "fab fa-gitlab" %}
{% elif parsed.netloc == "gitter.im" or parsed.netloc.endswith(".gitter.im") %}
  {% set icon = "fab fa-gitter" %}
{% elif parsed.netloc in ["discord.com", "discordapp.com", "discord.gg"] or parsed.netloc.endswith(("discord.com", "discordapp.com", "discord.gg")) %}
  {% set icon = "fab fa-discord" %}
{% elif parsed.netloc == "google.com" or parsed.netloc.endswith(".google.com") %}
  {% set icon = "fab fa-google" %}
{% elif parsed.netloc == "bitbucket.org" or parsed.netloc.endswith(".bitbucket.org") %}
  {% set icon = "fab fa-bitbucket" %}
{% elif parsed.netloc == "reddit.com" or parsed.netloc.endswith(".reddit.com") %}
  {% set icon = "fab fa-reddit-alien" %}
{% elif name.lower().startswith("slack") or parsed.netloc == "slack.com" or parsed.netloc.endswith(".slack.com") %}
  {% set icon = "fab fa-slack" %}
{% elif parsed.netloc == "twitter.com" or parsed.netloc.endswith(".twitter.com") %}
  {% set icon = "fab fa-twitter" %}
{% elif parsed.netloc in ["ci.appveyor.com", "circleci.com", "codecov.io", "coveralls.io", "shippable.com", "travis-ci.com", "travis-ci.org"] or parsed.netloc.endswith((".appveyor.com", ".circleci.com", ".codecov.io", ".coveralls.io", ".shippable.com", ".travis-ci.org", ".travis-ci.com")) %}
  {% set icon = "fas fa-tasks" %}
{% elif parsed.netloc in ["cheeseshop.python.org", "pypi.io", "pypi.org", "pypi.python.org"] %}
  {% set icon = "fas fa-cube" %}
{% elif parsed.netloc == "python.org" or parsed.netloc.endswith(".python.org") %}
  {% set icon = "fab fa-python" %}
{% elif parsed.netloc == "youtube.com" or parsed.netloc.endswith(".youtube.com") %}
  {% set icon = "fab fa-youtube" %}
{% elif name|lower == "mastodon" %}
  {% set icon = "fab fa-mastodon" %}
{% else %}
  {% set icon = "fas fa-external-link-square-alt" %}
{% endif %}

<i class="{{ icon }}" aria-hidden="true"></i>

{%- endmacro %}


{% macro project_snippet(release) -%}
<a class="package-snippet" href="{{ request.route_path('packaging.project', name=release.project.normalized_name) }}">
  <h3 class="package-snippet__title">
    <span class="package-snippet__name">{{ release.project.name }}</span>
    <span class="package-snippet__version">{{ release.version }}</span>
  </h3>
  <p class="package-snippet__description">{{ release.summary }}</p>
</a>
{%- endmacro %}


{%- macro pip_command(release, request_route, test_environment) -%}
  {%- if test_environment -%}
    {% set index_url = " -i https://test.pypi.org/simple/" %}
  {%- endif -%}

  {%- if request_route == "packaging.release" -%}
    {% set project_version = "==" + release.version %}
  {%- endif -%}

  {%- if release.version.epoch -%}
    pip install{{ index_url }} '{{ release.project.name }}{{ project_version }}'
  {%- else -%}
    pip install{{ index_url }} {{ release.project.name }}{{ project_version }}
  {%- endif -%}
{%- endmacro -%}

{%- macro file_table(files) -%}
  {% for file in files %}
    <div class="file">
      <div class="file__graphic">
        <i class="far fa-file" aria-hidden="true"></i>
      </div>

      <div class="card file__card">
        <a href="{{ request.route_url('packaging.file', path=file.path) }}">
          {{ file.filename }}
        </a>
        ({{ file.size|filesizeformat() if file.size else 0|filesizeformat() }}
        <a href="#copy-hash-modal-{{ file.id }}">{%- trans -%}view hashes{%- endtrans -%}</a>)
        <p class="file__meta">
          Uploaded {{ humanize(file.upload_time) }}
          {% if file.python_version %}
          {% for tag in file.python_version.split('.') %}
          <code>{{ tag }}</code>
          {% endfor %}
          {% endif %}
        </p>
      </div>
    </div>
  {% endfor %}

{%- endmacro -%}

{% block title %}{{ release.project.name }}{% endblock %}

{% block description %}{{ release.summary }}{% endblock %}

{% block additional_rss -%}
<link rel="alternate" type="application/rss+xml" title="{% trans project_name=release.project.name %}RSS: latest releases for {{ project_name }}{% endtrans %}" href="{{ request.route_path('rss.project.releases', name=release.project.normalized_name) }}">
{%- endblock %}

{% block canonical_url %}{{ request.route_url('packaging.project', name=release.project.name) }}{% endblock %}

{% block extra_meta %}
{% if release.project.created|is_recent %}
<meta name="googlebot" content="noindex">
{% endif %}
{% endblock %}

{% block content %}
{% csi request.route_path("includes.administer-project-include", project_name=project.normalized_name) %}
{% endcsi %}
<div class="banner">
  <div class="package-header">
    <div class="package-header__left">
      <h1 class="package-header__name">
        {{ release.project.name }} {{ release.version }}
      </h1>

      {% if files %}
      <p class="package-header__pip-instructions">
        <span id="pip-command">{{ pip_command(release, request.matched_route.name, testPyPI) }}</span>
        <button type="button" class="copy-tooltip copy-tooltip-s" data-clipboard-target="#pip-command" data-tooltip-label="{% trans %}Copy to clipboard{% endtrans %}">
          <i class="fa fa-copy" aria-hidden="true"></i>
          <span class="sr-only">{% trans %}Copy PIP instructions{% endtrans %}</span>
        </button>
      </p>
      {% endif %}
    </div>

    <div class="package-header__right">
    {% if release.yanked %}
      <a class="status-badge status-badge--bad" href="{{ request.route_path('packaging.project', name=release.project.name) }}">
        <span>
          {% trans %}This release has been yanked{% endtrans %}<br>
        </span>
      </a>
    {% else %}
      {% if release.version|parse_version > latest_version.version|parse_version %}
      <a class="status-badge status-badge--warn" href="{{ request.route_path('packaging.project', name=release.project.name) }}">
        <span>{% trans version=latest_version.version %}Stable version available ({{ version }}){% endtrans %}</span>
      </a>
      {% elif release.version|parse_version != latest_version.version|parse_version %}
      <a class="status-badge status-badge--bad" href="{{ request.route_path('packaging.project', name=release.project.name) }}">
        <span>{% trans version=latest_version.version %}Newer version available ({{ version }}){% endtrans %}</span>
      </a>
      {% else %}
      <a class="status-badge status-badge--good" href="{{ request.route_path('packaging.project', name=release.project.name) }}">
        <span>{% trans %}Latest version{% endtrans %}</span>
      </a>
      {% endif %}
    {% endif %}
      <p class="package-header__date">
        {% trans release_date=humanize(release.created) %}Released: {{ release_date }}{% endtrans %}
      </p>
    </div>
  </div>
</div>

<div class="horizontal-section horizontal-section--grey horizontal-section--thin">
  <div class="site-container">
    <div class="split-layout split-layout--middle package-description">
    {% if release.summary %}
      <p class="package-description__summary">{{ release.summary }}</p>
    {% else %}
      <p class="package-description__summary">{% trans %}No project description provided{% endtrans %}</p>
    {% endif %}
    {% csi request.route_path("includes.edit-project-button", project_name=project.normalized_name) %}
    {% endcsi %}
    </div>
  </div>
</div>

<div data-controller="project-tabs">
  <div class="tabs-container">
    <div class="vertical-tabs">
      <div class="vertical-tabs__tabs">
        <div class="sidebar-section">
          <h3 class="sidebar-section__title">{% trans %}Navigation{% endtrans %}</h3>
          <nav aria-label="{% trans project=release.project.name %}Navigation for {{ project }}{% endtrans %}">
            <ul class="vertical-tabs__list" role="tablist">
              <li role="tab">
                <a id="description-tab" href="#description" data-project-tabs-target="tab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--is-active" aria-selected="true" aria-label="{% trans %}Project description. Focus will be moved to the description.{% endtrans %}">
                  <i class="fa fa-align-left" aria-hidden="true"></i>
                  {% trans %}Project description{% endtrans %}
                </a>
              </li>
              <li role="tab">
                <a id="history-tab" href="#history" data-project-tabs-target="tab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon" aria-label="{% trans %}Release history. Focus will be moved to the history panel.{% endtrans %}">
                  <i class="fa fa-history" aria-hidden="true"></i>
                  {% trans %}Release history{% endtrans %}
                </a>
              </li>
              {% if files %}
              <li role="tab">
                <a id="files-tab" href="#files" data-project-tabs-target="tab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon" aria-label="{% trans %}Download files. Focus will be moved to the project files.{% endtrans %}">
                  <i class="fa fa-download" aria-hidden="true"></i>
                  {% trans %}Download files{% endtrans %}
                </a>
              </li>
              {% endif %}
            </ul>
          </nav>
        </div>
        {% include "warehouse:templates/includes/packaging/project-data.html" %}
        {% include "warehouse:templates/includes/sidebar-sponsor-logo.html" %}

      </div>
      <div class="vertical-tabs__panel">
        <!-- mobile menu -->
        <nav aria-label="{% trans project=release.project.name %}Navigation for {{ project }}{% endtrans %}">
          <ul class="vertical-tabs__list" role="tablist">
            <li role="tab">
              <a id="mobile-description-tab" href="#description" data-project-tabs-target="mobileTab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--mobile vertical-tabs__tab--no-top-border vertical-tabs__tab--is-active" aria-selected="true" aria-label="{% trans %}Project description. Focus will be moved to the description.{% endtrans %}">
                <i class="fa fa-align-left" aria-hidden="true"></i>
                {% trans %}Project description{% endtrans %}
              </a>
            </li>
            <li role="tab">
              <a id="mobile-data-tab" href="#data" data-project-tabs-target="mobileTab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--mobile" aria-label="{% trans %}Project details. Focus will be moved to the project details.{% endtrans %}">
                <i class="fa fa-info-circle" aria-hidden="true"></i>
                {% trans %}Project details{% endtrans %}
              </a>
            </li>
            <li role="tab">
              <a id="mobile-history-tab" href="#history" data-project-tabs-target="mobileTab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--mobile" aria-label="{% trans %}Release history. Focus will be moved to the history panel.{% endtrans %}">
              <i class="fa fa-history" aria-hidden="true"></i>
              {% trans %}Release history{% endtrans %}
            </a>
            </li>
            {% if files %}
            <li role="tab">
              <a id="mobile-files-tab" href="#files" data-project-tabs-target="mobileTab" data-action="project-tabs#onTabClick" class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--mobile" aria-label="{% trans %}Download files. Focus will be moved to the project files.{% endtrans %}">
                <i class="fa fa-download" aria-hidden="true"></i>
                {% trans %}Download files{% endtrans %}
              </a>
            </li>
            {% endif %}
          </ul>
        </nav>

        {# Tab: Project description #}
        <div id="description" data-project-tabs-target="content" class="vertical-tabs__content" role="tabpanel" aria-labelledby="description-tab mobile-description-tab" tabindex="-1">
          <h2 class="page-title">{% trans %}Project description{% endtrans %}</h2>
          {% if description %}
          <div class="project-description">
            {{ description|camoify|safe }}
          </div>
          {% else %}
          <div class="callout-block">
            <p>{% trans %}The author of this package has not provided a project description{% endtrans %}</p>
          </div>
          {% endif %}
        </div>

        {# Tab: project details #}
        <div id="data" data-project-tabs-target="content" class="vertical-tabs__content" role="tabpanel" aria-labelledby="mobile-data-tab" tabindex="-1">
          <h2 class="page-title">{% trans %}Project details{% endtrans %}</h2>
          {% include "warehouse:templates/includes/packaging/project-data.html" %}
          <br>
        </div>

        {# Tab: Release history #}
        <div id="history" data-project-tabs-target="content" class="vertical-tabs__content" role="tabpanel" aria-labelledby="history-tab mobile-history-tab" tabindex="-1">
          <h2 class="page-title split-layout">
            <span>{% trans %}Release history{% endtrans %}</span>
            <span class="reset-text margin-top">
              <a href="{{ request.route_path('help')}}#project-release-notifications">{% trans %}Release notifications{% endtrans %}</a> |
              <a href="{{ request.route_path('rss.project.releases', name=release.project.normalized_name) }}">{% trans %}RSS feed{% endtrans %} <i class="fa fa-rss" aria-hidden="true"></i></a>
            </span>
          </h2>

          <div class="release-timeline">
            {% set blue_cube = request.static_url('warehouse:static/dist/images/blue-cube.svg') %}
            {% set white_cube = request.static_url('warehouse:static/dist/images/white-cube.svg') %}
            {% for hversion in all_versions %}
            {% set is_current = (hversion.version == release.version) %}
            <div class="release{{ ' release--latest' if loop.first else ' release--oldest' if loop.last }}{{ ' release--current' if is_current }}">
              <div class="release__meta">
                {% if is_current %}
                <span class="badge">{% trans %}This version{% endtrans %}</span>
                {% endif %}
              </div>

              <div class="release__graphic">
                {% if loop.length > 1 %}
                <div class="release__line"></div>
                {% endif %}
                {% if is_current %}
                <img class="release__node" alt="" src="{{ blue_cube }}">
                {% else %}
                <img class="release__node" alt="" src="{{ white_cube }}">
                {% endif %}
              </div>

              <a class="card release__card" href="{{ request.route_path('packaging.release', name=release.project.name, version=hversion.version) }}">
                <p class="release__version">
                  {{ hversion.version }}
                  {% if hversion.is_prerelease %}
                  <span class="badge badge--warning">
                    {% trans %}pre-release{% endtrans %}
                  </span>
                  {% endif %}
                  {% if hversion.yanked %}
                  <span class="badge badge--danger">
                    {% trans %}yanked{% endtrans %}
                  </span>
                  {% endif %}
                </p>
                <p class="release__version-date">
                  {{ humanize(hversion.created) }}
                </p>
              </a>
            </div>
            {% endfor %}
          </div>
        </div>

        {% if files %}
          {# Tab: Downloads #}
          <div id="files" data-project-tabs-target="content" class="vertical-tabs__content" role="tabpanel" aria-labelledby="files-tab mobile-files-tab" tabindex="-1">
            <h2 class="page-title">{% trans %}Download files{% endtrans %}</h2>
            <p>{% trans href='https://packaging.python.org/installing/', title=gettext('External link') %}Download the file for your platform. If you're not sure which to choose, learn more about <a href="{{ href }}" title="{{ title }}" target="_blank" rel="noopener">installing packages</a>.{% endtrans %}</p>
            <h3>
              {% trans count=sdists|length %}
                Source Distribution
              {% pluralize %}
                Source Distributions
              {% endtrans %}
            </h3>

            {% if sdists %}
              {{ file_table(sdists) }}
            {% else %}
              <div class="file">
                <div class="file__graphic">
                  <i class="fas fa-exclamation-circle" aria-hidden="true"></i>
                </div>

                <div class="card">
                  {% trans %}No source distribution files available for this release.{% endtrans %}
                  {% trans href='https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives', title=gettext('External link') %}See tutorial on <a href="{{ href }}" title="{{ title }}" target="_blank" rel="noopener">generating distribution archives</a>.{% endtrans %}
                </div>
              </div>
            {% endif %}

            {% if bdists %}
            <h3>
              {% trans count=bdists|length %}
                Built Distribution
              {% pluralize %}
                Built Distributions
              {% endtrans %}
            </h3>

            {{ file_table(bdists) }}
            {% endif %}
          </div>

          {% for file in files %}
          {% include "warehouse:templates/includes/hash-modal.html" %}
          {% endfor %}

        {% endif %}
      </div>
    </div>
  </div>
</div>
{% endblock %}

{% block extra_js %}
<script>
MathJax = {
  tex: {
    inlineMath: [['$', '$'], ['\\(', '\\)']]
  },
};
</script>
<script async
  src="https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-svg.js"
  integrity="sha256-1CldwzdEg2k1wTmf7s5RWVd7NMXI/7nxxjJM2C4DqII="
  crossorigin="anonymous"
></script>
{% endblock %}