|
| 1 | +# Welcome to Pulp Python |
| 2 | + |
| 3 | +The `python` plugin extends [pulpcore](site:pulpcore/) to support |
| 4 | +hosting python packages. This plugin is a part of the [Pulp Project](site:/), and assumes some familiarity with the [pulpcore documentation](site:pulpcore/). |
| 5 | + |
| 6 | +If you are just getting started, we recommend getting to know the [basic |
| 7 | +workflows](site:pulp_python/docs/user/guides/pypi/). |
| 8 | + |
| 9 | +The REST API documentation for `pulp_python` is available [here](site:pulp_python/restapi/). |
| 10 | + |
| 11 | +## Features |
| 12 | + |
| 13 | +- [Create local mirrors of PyPI](site:pulp_python/docs/user/guides/sync/) that you have full control over |
| 14 | +- [Upload your own Python packages](site:pulp_python/docs/user/guides/upload/) |
| 15 | +- [Perform pip install](site:pulp_python/docs/user/guides/publish/) from your Pulp Python repositories |
| 16 | +- Download packages on-demand to reduce disk usage |
| 17 | +- Every operation creates a restorable snapshot with Versioned Repositories |
| 18 | +- Curate your Python repositories with allowed and disallowed packages |
| 19 | +- Host content either locally or on S3/Azure/GCP |
| 20 | +- De-duplication of all saved content |
| 21 | + |
| 22 | +## Tech Preview |
| 23 | + |
| 24 | +Some additional features are being supplied as a tech preview. There is a possibility that |
| 25 | +backwards incompatible changes will be introduced for these particular features. For a list of |
| 26 | +features currently being supplied as tech previews only, see the [tech preview page](site:pulp_python/docs/user/learn/tech-preview/). |
| 27 | + |
| 28 | +# How to use these docs |
| 29 | + |
| 30 | +The documentation here should be considered the **primary documentation for managing Python related content.** |
| 31 | +All relevant workflows are covered here, with references to some pulpcore supplemental docs. |
| 32 | +Users may also find pulpcore’s conceptual docs useful. |
| 33 | + |
| 34 | +This documentation falls into two main categories: |
| 35 | + |
| 36 | +1. `How-to Guides` shows the **major features** of the Python plugin, with links to reference docs. |
| 37 | +2. The [REST API Docs](site:pulp_python/restapi/) are automatically generated and provide more detailed information for each |
| 38 | +minor feature, including all fields and options. |
0 commit comments