Skip to content
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.

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

Add more package index projects #1366

Merged
merged 9 commits into from
Feb 1, 2024
Merged

Conversation

EpicWink
Copy link
Contributor

@EpicWink EpicWink commented Nov 8, 2023

Add many more package index projects to the "Project Summaries" page, add a table comparing these projects in the "Hosting your own simple repository" page, add another table comparing these projects in the "Package index mirrors and caches" page, and update the intro to "Package index mirrors and caches" to reflect the multitude of options

An alternative to #1202

Previews:

source/key_projects.rst Outdated Show resolved Hide resolved
source/key_projects.rst Outdated Show resolved Hide resolved
source/guides/hosting-your-own-index.rst Show resolved Hide resolved
source/key_projects.rst Outdated Show resolved Hide resolved
EpicWink and others added 4 commits November 9, 2023 10:49
Docs link uses intersphinx, issues link uses GitHub role

Co-authored-by: chrysle <fritzihab@posteo.de>
Co-authored-by: chrysle <fritzihab@posteo.de>
Copy link
Contributor

@jeanas jeanas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge this?

@webknjaz
Copy link
Member

@EpicWink let's maybe mention dumb-pypi which is essentially a static site generator that makes a simple index for a bunch of pre-downloaded/created wheels.
As for the hosting, there's GitHub Pages that I use for having extra indexes with "nightly" bleeding-edge dists. So mentioning GitHub/GitLab Pages (or any static hosting for that matter) as possible solutions for limited use-cases would be useful too.
Here's an example: https://ansible.github.io/pylibssh/.

Finally, you mention Twisted, but omit the built-in web server that ships with Python — python -Im http.server. It's more of a local testing tool since it's not really designed to serve HTTP under the high load, but I believe does still deserve an honorary mention. After all, Twisted would be a production-side solution (although, this does omit all the other web servers capable of the same).

Could you bake these tools into the contributed documents, please?

@EpicWink
Copy link
Contributor Author

EpicWink commented Jan 29, 2024

let's maybe mention dumb-pypi which is essentially a static site generator that makes a simple index for a bunch of pre-downloaded/created wheels.

@webknjaz I've included dumb-pypi in the latest change-set.


As for the hosting, there's GitHub Pages

GitHub pages and GitLab pages aren't really "projects", but services. Per this comment, we don't want to list commercial services.

I guess there's an opportunity to explicitly say package indexes can be static file servers.


Finally, you mention Twisted, but omit the built-in web server that ships with Python — python -Im http.server

I have already included it: see source/guides/hosting-your-own-index.rst:113

@edgarrmondragon
Copy link
Contributor

Would it be worth including https://github.com/gorilla-co/s3pypi?

@EpicWink
Copy link
Contributor Author

Would it be worth including https://github.com/gorilla-co/s3pypi?

@edgarrmondragon I don't think so, as it relies on a commercial solution, and is not a self-contained project.

@webknjaz
Copy link
Member

@EpicWink re:gitlab — it can be a self-hosted platform with a free version, since it's an Open Core project. But yeah, maybe a more generic "use any web server to serve static if you want your index accessible over web" would be better (mentioning that it's also possible to point installers to a simple index / wheelhouse on the local file system). I was also thinking that we could mention such examples, but not link them, maybe? Anyway, these two platforms already host the majority of open source and do so for free. So while they're commercial, they also do a lot for the sustainability of the open source. I think it might be fine to mention them in a restricted context with disclaimers — it wouldn't be an advertisement but an acknowledgement that these things exists.

@webknjaz
Copy link
Member

Finally, you mention Twisted, but omit the built-in web server that ships with Python — python -Im http.server

I have already included it: see source/guides/hosting-your-own-index.rst:113

Ah, maybe I missed it because it doesn't have a dot in RST. Though, I was thinking more in the context of having it instead of twisted in the paragraph since it wouldn't be something dependent on the presence of an external project.

@EpicWink
Copy link
Contributor Author

maybe a more generic "use any web server to serve static if you want your index accessible over web" would be better

@webknjaz re-reading the page, the current main version already discusses static file serving (with Twisted as an example), and this pull-request doesn't make changes to that discussion. I think making it more generic, and discussing other services, would better be served in another pull-request.

@webknjaz
Copy link
Member

Okay, fair.

@webknjaz
Copy link
Member

Per this comment, we don't want to list commercial services.

Looks like S3 is still linked?

@EpicWink
Copy link
Contributor Author

EpicWink commented Feb 1, 2024

Looks like S3 is still linked?

@webknjaz my understanding is that PyPA doesn't want to promote or recommend commercial services. I don't think listing a project which has optional functionality to utilise a commercial service (in this case S3) can be considered recommending.

A previous comment suggests s3pypi, which requires S3, which I think means that if s3pypi is listed, S3 is de-facto being recommended.

We could remove the explicit reference to S3, and just say "cloud object storage services", but honestly I left in S3 because I think it helps with Google (and other search engines!) searches, which helps novice package distributors who are familiar with cloud services.

@webknjaz
Copy link
Member

webknjaz commented Feb 1, 2024

Alright, that's fair. Just wanted to clarify.

@webknjaz webknjaz added this pull request to the merge queue Feb 1, 2024
@webknjaz
Copy link
Member

webknjaz commented Feb 1, 2024

@EpicWink thanks!

Merged via the queue into pypa:main with commit 144ebf1 Feb 1, 2024
5 checks passed
@EpicWink EpicWink deleted the more-indexes-2 branch February 2, 2024 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants