Project

Profile

Help

Pulp Python Roadmap » History » Sprint/Milestone 14

amacdona@redhat.com, 12/11/2017 08:01 PM

1 1 dalley
# Pulp Python Roadmap
2
3 14 amacdona@redhat.com
Legend:  
4
(Red, undecided)  
5
(Yellow, decided- needs story)  
6
(blue, decided with story)  
7
(Black - Finished bc green is hard to read)
8
9 9 dalley
~~~
10 8 dalley
This is a living document that is moving towards a long term plan to develop pulp_python 3.0 and beyond.
11 6 dalley
~~~
12 1 dalley
13
## Pulp Python Use Cases
14
15 14 amacdona@redhat.com
### Synced Package Index use case:
16 13 bizhang
17 2 dalley
> As a user, I can configure an importer to sync a list of projects \[#2884\]
18
>
19 1 dalley
>> Syncing a project includes all releases  
20
>> Syncing a release includes all distribution packages (all types)  
21 14 amacdona@redhat.com
>> Synced packages can be verified based on digest (md5 from pypi, sha512 Pulp)  
22 1 dalley
>> I can specify sync mode to be either additive or mirror
23 14 amacdona@redhat.com
24
> As a user, I can publish a repository (Published projects will include all releases and distributions):
25 1 dalley
>
26 14 amacdona@redhat.com
>> Published Python Content Units are consumable by pip \[#2885\] #TOBLUE  
27
>> Published projects are consumable by other Pulps \[#2886\] #TOBLUE
28 1 dalley
29
### Upload Use Case:
30
31 14 amacdona@redhat.com
> As a user, I can upload individual distribution packages (name, version, platform) #TOYELLOW
32 1 dalley
>
33 14 amacdona@redhat.com
>> As a user I can upload all types (egg, wheel, sdist)
34
35
### **\[3.1+\]** ==============================================================================
36
37
> **\[3.1+\]** A twine user can publish a distribution package to Pulp \[#2887\]
38
39
### **\[3.1+\]** Migrations:
40
41
> As a user, I can migrate Pulp2 packages to Pulp3 in-place. \[#2888\]
42
43
### **\[3.1+\]** Cache Use Case:
44
45
> As a user, I can use Pulp as a PyPI cache.
46
47
### **\[3.1+\]** PyPI Publish use case
48
49
> As a user, I can publish a release to a remote package index
50 2 dalley
>
51 14 amacdona@redhat.com
>> As a user, I can configure Pulp to publish to PyPI with my auth credentials
52 2 dalley
53 14 amacdona@redhat.com
### Granular Sync
54 4 dalley
55 1 dalley
> Blacklist: As a user, I can disinclude some content of a project
56 2 dalley
>
57 1 dalley
>> By specifying (release, distribution package)  
58 11 bizhang
>> I can disinclude content by distribution type
59
>
60
> Whitelist (Curated Package index Use Case) As a user, I can sync packages that reproduce a specific environment
61
>
62 1 dalley
>> From the output of pip freeze (loose use case)  
63
>> With the name, exact versions, and distribution type (tight use case)
64
65
## Glossary:
66
67
### Project
68
69
> A library, framework, script, plugin, application, or collection of data or other resources, or some combination thereof that is intended to be packaged into a Distribution.  
70
> \[ https://packaging.python.org/glossary/#term-project \]
71 2 dalley
72 1 dalley
### Package Index:
73
74
> A repository of distributions with a web interface to automate package discovery and consumption. (this should align to a pulp repo). A Package Index is assumed to implement the PyPI APIs
75
76
### Release
77
78
> A snapshot of a Project at a particular point in time, denoted by a version identifier.  
79
> Making a release may entail the publishing of multiple Distributions. For example, if version 1.0 of a project was released, it could be available in both a source distribution format and a Windows installer distribution format.
80 5 dalley
81
### Distribution Package
82 1 dalley
83
> "Distribution" for short. If we mean linux, we will say "distro"  
84
> A versioned archive file that contains Python packages, modules, and other resource files that are used to distribute a Release. The archive file is what an end-user will download from the internet and install. A project may contain many releases, and releases may contain many distribution packages. Can be type sdist, bdist, etc. "Distribution package" is used instead of "package" to avoid confusion with "import packages" or linux "distributions".
85
86
## Relevant PEPs:
87
88
  - https://www.python.org/dev/peps/pep-0241/ Final (Original Metadata)
89
  - https://www.python.org/dev/peps/pep-0301/ Final (HTTP API)
90
  - https://www.python.org/dev/peps/pep-0314/ Final (Metadata 1.1)
91
  - https://www.python.org/dev/peps/pep-0345/ Accepted (Metadata 1.2)
92
  - https://www.python.org/dev/peps/pep-0427/ Accepted (Wheel 1.0) 
93
  - https://www.python.org/dev/peps/pep-0491/ Draft (Wheel 1.9)
94
  - https://www.python.org/dev/peps/pep-0426/ Deferred (Metadata 2.0)
95
  - https://www.python.org/dev/peps/pep-0459/ Deferred (Standard Metadata Extensions)
96
  - https://www.python.org/dev/peps/pep-0503/ Accepted (Simple API)
97
  - https://www.python.org/dev/peps/pep-0508/ Active (Dep specification)