Skip to content

Document legacy upload API endpoint #3055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 23, 2018
Merged

Document legacy upload API endpoint #3055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c64503e
Improve docs headers and tables of contents
brainwane Feb 23, 2018
a69a2fc
Document legacy upload API endpoint
brainwane Feb 23, 2018
d338c86
Merge branch 'master' into upload-api
di Feb 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/api-reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
API Reference
=============

Warehouse has several API endpoints. See :doc:`../application` for the
parts of Warehouse that generate them.

.. toctree::
:maxdepth: 1
:maxdepth: 2

feeds
json
Expand Down
4 changes: 4 additions & 0 deletions docs/api-reference/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ JSON API

PyPI offers two JSON endpoints.

Project
-------

.. http:get:: /pypi/<project_name>/json

Expand Down Expand Up @@ -117,6 +119,8 @@ PyPI offers two JSON endpoints.

:statuscode 200: no error

Release
-------

.. http:get:: /pypi/<project_name>/<version>/json

Expand Down
11 changes: 11 additions & 0 deletions docs/api-reference/legacy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,14 @@ The Simple API implements the HTML-based package index API as specified in `PEP

.. _`pypi-legacy`: https://pypi.python.org/
.. _`PEP 503`: https://www.python.org/dev/peps/pep-0503/

Upload API
----------

The API endpoint served at `upload.pypi.org/legacy/
<https://upload.pypi.org/legacy/>`_ is Warehouse's emulation of the
legacy PyPI upload API. This is the endpoint that tools such as `twine
<http://twine.readthedocs.io/>`_ and `distutils
<https://docs.python.org/3.6/distutils/packageindex.html#the-upload-command>`_
use to `upload distributions to PyPI
<https://packaging.python.org/tutorials/distributing-packages/>`_.
4 changes: 2 additions & 2 deletions docs/application.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The Warehouse codebase
======================
Warehouse codebase
==================

Warehouse uses the
`Pyramid`_ web framework, the
Expand Down
2 changes: 1 addition & 1 deletion docs/development/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ https://github.com/chadoe/docker-cleanup-volumes)


``make initdb`` is slow or appears to make no progress
------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This typically occur when Docker is not allocated enough memory to perform the
migrations. Try modifying your Docker configuration to allow more RAM for each
Expand Down