Project

Profile

Help

Pulp Python Roadmap » History » Sprint/Milestone 10

bizhang, 11/13/2017 07:59 PM

1 1 dalley
# Pulp Python Roadmap
2
3 8 dalley
~~~
4 9 dalley
This is a living document that is moving towards a long term plan to develop pulp_python 3.0 and beyond.
5 8 dalley
~~~
6 6 dalley
7 1 dalley
## Pulp Python Use Cases
8
9 3 dalley
### \[3.0\] Synced Package Index use case:
10 1 dalley
11 10 bizhang
> As a user, I can configure an importer to sync a list of projects \[#2884\]
12 2 dalley
>
13
>> Syncing a project includes all releases  
14
>> Syncing a release includes all distribution packages (all types)
15
>
16
> As a user, I can publish a repository:
17
>
18 10 bizhang
>> Published Distributions are consumable by pip \[#2885\]  
19
>> Published projects are consumable by other Pulps \[#2886\]  
20 2 dalley
>> Published projects will include all releases and distributions
21 1 dalley
22 2 dalley
### Upload Use Case:
23 1 dalley
24 10 bizhang
> **\[3.0\]** As a user, I can upload individual distribution packages (name, version, platform) \[#2887\]
25 2 dalley
>
26
>> As a user I can upload an egg  
27
>> As a user I can upload a wheel  
28
>> As a user I can upload a sdist
29
>
30 4 dalley
> **\[3.1+\]** A twine user can publish a distribution package to Pulp
31 1 dalley
32 4 dalley
### **\[3.1+\]** Granular Sync
33 1 dalley
34 2 dalley
> Blacklist: As a user, I can disinclude some content of a project
35
>
36
>> By specifying (release, distribution package)  
37
>> I can disinclude content by distribution type
38
>
39
> Whitelist (Curated Package index Use Case) As a user, I can sync packages that reproduce a specific environment
40
>
41
>> From the output of pip freeze (loose use case)  
42
>> With the name, exact versions, and distribution type (tight use case)
43 1 dalley
44 4 dalley
### **\[3.1+\]** PyPI Publish use case
45 1 dalley
46 2 dalley
> As a user, I can publish a release to a remote package index
47 1 dalley
>
48 2 dalley
>> As a user, I can configure Pulp to publish to PyPI with my auth credentials
49 1 dalley
50 4 dalley
### **\[3.1+\]** Cache Use Case:
51 1 dalley
52 2 dalley
> As a user, I can use Pulp as a PyPI cache.
53 1 dalley
54
## Glossary:
55
56
### Project
57
58
> 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.  
59
> \[ https://packaging.python.org/glossary/#term-project \]
60
61
### Package Index:
62
63 2 dalley
> 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
64 1 dalley
65
### Release
66
67
> A snapshot of a Project at a particular point in time, denoted by a version identifier.  
68
> 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.
69
70
### Distribution Package
71
72 5 dalley
> "Distribution" for short. If we mean linux, we will say "distro"  
73
> 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".
74 1 dalley
75
## Relevant PEPs:
76
77
  - https://www.python.org/dev/peps/pep-0241/ Final (Original Metadata)
78
  - https://www.python.org/dev/peps/pep-0301/ Final (HTTP API)
79
  - https://www.python.org/dev/peps/pep-0314/ Final (Metadata 1.1)
80
  - https://www.python.org/dev/peps/pep-0345/ Accepted (Metadata 1.2)
81
  - https://www.python.org/dev/peps/pep-0427/ Accepted (Wheel 1.0) 
82
  - https://www.python.org/dev/peps/pep-0491/ Draft (Wheel 1.9)
83
  - https://www.python.org/dev/peps/pep-0426/ Deferred (Metadata 2.0)
84
  - https://www.python.org/dev/peps/pep-0459/ Deferred (Standard Metadata Extensions)
85
  - https://www.python.org/dev/peps/pep-0503/ Accepted (Simple API)
86
  - https://www.python.org/dev/peps/pep-0508/ Active (Dep specification)