Files
pypistats.dev/pypistats/templates/about.html
2021-06-30 20:29:09 -04:00

45 lines
2.1 KiB
HTML

{% extends "layout.html" %}
{% block title %}PyPI Download Stats{% endblock %}
{% block body %}
<h1>About PyPI Stats</h1>
<hr>
<h3>Goal</h3>
<p>PyPI Stats aims to provide aggregate download information on python packages available from the Python Package
Index in lieu of having to execute queries against raw download records in Google BigQuery.</p>
<h3>Data</h3>
<p>Download stats are sourced from the Python Software Foundation's publicly available
<a href="https://bigquery.cloud.google.com/table/bigquery-public-data:pypi.downloads">download stats</a>
on Google BigQuery. All aggregate download stats ignore known PyPI mirrors (such as
<a href="{{ url_for('general.package_page', package='bandersnatch') }}">bandersnatch</a>) unless noted
otherwise.</p>
<p>PyPI Stats retains data for 180 days.</p>
<h3>API</h3>
<p>A simple
<a href="{{ url_for('api.api') }}">JSON API</a>
is available for aggregate download stats and time series for packages.</p>
<h3>Downstream</h3>
<p>
<ul>
<li>
<a href="{{ url_for('general.package_page', package='pypistats') }}">pypistats</a> is a <a
href="https://github.com/hugovk/pypistats">python package</a> that provides a client and CLI tool for
the pypistats.org JSON API</a>
</li>
<li>
<a href="https://shields.io/#/examples/downloads">shields.io</a> uses the pypistats.org JSON API to provide
download count badges, like this one for <a
href="{{ url_for('general.package_page', package='pypistats') }}">pypistats</a> <a
href="https://github.com/hugovk/pypistats"><img src="https://img.shields.io/pypi/dm/pypistats.svg"></a>
</li>
</ul>
<p>PyPIStats.org is also <a href="https://github.com/crflynn/pypistats.org">open source</a>.</p>
<h3>Who</h3>
<p>PyPI Stats was created by
<a href="https://flynn.gg">Christopher Flynn</a>.
</p>
<p>
Thanks to <a href="https://github.com/hugovk">Hugo (hugovk)</a> for providing a client interface to the API.
</p>
{% endblock %}