PEP 503 Simple Repository index by declaring routing rules

[uranusjr (Tzu-ping Chung)]

Inspired by @xafer’s comment in Dependency notation including the index URL:

@xafer

Another solution I did not see mentioned here and that might be worth exploring would be a lightweight PEP-503 private index/proxy that developers could launch on their computer and that could implement all kinds of routing/filtering between multiple private/public indices, package directories, S3 buckets, etc. Developers would simply point pip to this local server with --index-url and be setup.

I put together a tool that does this with local directories.

uranusjr/simpleindex

This is of course at alpha quality at best, although there isn’t really much that can go wrong—there’s no caching, no mirroring, no nothing; requests to non-local sources are transparently redirected with HTTP 302. I did some quick testing and things seem to work as expected.

I know very little about S3 and other web storage stuff, so it’s probably best to leave this in others’ hands.

[steve.dower]

Very nice!

I took a quick look, and would suggest you probably want an explicit extensibility/contrib mechanism, so that other can easily build the wrappers they need without having to force it all back onto yourself.

But as you say, there isn’t much to it PEP 503 is a pretty nicely designed system.

[uranusjr (Tzu-ping Chung)]

@steve.dower

I took a quick look, and would suggest you probably want an explicit extensibility/contrib mechanism, so that other can easily build the wrappers they need without having to force it all back onto yourself.

0.2.0 now offers extensibility by registering simpleindex.routes.Route subclasses as simpleindex.routes entry points! I also wrote down briefly what a subclass should do in the readme.

[brettcannon]

Which reminds me, when mousebender.simple gets upstreamed to packaging that we should include some code to get the appropriate HTML to make this sort of project even easier.

[uranusjr (Tzu-ping Chung)]

@brettcannon

we should include some code to get the appropriate HTML to make this sort of project even easier.

Does this mean something like turning an ArchiveLink back to an HTML anchor tag? That would definitely be very helpful.

[brettcannon]

@uranusjr

Does this mean something like turning an ArchiveLink back to an HTML anchor tag?

Yep. If we know what the HTML is supposed to be like then we might as well provide it to help make sure people can generate standards-compliant simple indexes.