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

Missing documention for .pypirc format #730

Closed
stdedos opened this issue May 28, 2020 · 4 comments · Fixed by #734
Closed

Missing documention for .pypirc format #730

stdedos opened this issue May 28, 2020 · 4 comments · Fixed by #734

Comments

@stdedos
Copy link

stdedos commented May 28, 2020

Would this be the correct place for this issue? pypa/twine#638

u@h:~/pak$ twine upload .tox/dist/* -r test-pypi
InvalidConfiguration: Missing 'test-pypi' section from the configuration file
or not a complete URL in --repository-url.
Maybe you have a out-dated '~/.pypirc' format?
more info: https://docs.python.org/distutils/packageindex.html#pypirc

Last v3 url that's valid is https://docs.python.org/3.6/distutils/packageindex.html#pypirc (and Google offers https://docs.python.org/3.3/distutils/packageindex.html#pypirc)

@bhrutledge
Copy link
Contributor

bhrutledge commented May 28, 2020

(originally from pypa/twine#638)

Thanks, @stdedos. It looks like that documentation was removed in python/cpython#13087.

After looking around a bit, it seems like there is no current documentation of the .pypirc format. There are some examples at:

But those aren't complete; for example, they don't document how to use a custom repository.

So, it seems like the format should be documented somewhere, but it's not clear to me where. Some relevant discussions:

It seems to me that twine is the primary (and maybe only?) consumer of .pypirc, and that it's a frequent source of confusion, so my initial vote was to document the format in twine's docs, and link to it from the Packaging User Guide.

However, @sigmavirus24 suggested that the Packaging User Guide would be the right place because twine doesn't own or control the format. So, maybe document here, then update the twine error message and mention it in the docs?

It looks like @di might have the most context across projects.

@di
Copy link
Sponsor Member

di commented May 28, 2020

I think we need to document/standardize the existing .pypirc format. It's unclear to me whether this needs to be a PEP or we can just do it in the specifications section of this guide.

@bhrutledge
Copy link
Contributor

@di Would it be reasonable to start with a PR here that adds some combination/edit of the content removed from the distutils docs and pypa/twine#340?

I could take a pass at that.

@di
Copy link
Sponsor Member

di commented May 28, 2020

@bhrutledge I think that would be a reasonable first step.

bhrutledge added a commit to bhrutledge/cpython that referenced this issue Jun 6, 2020
To resolve pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in python#13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.html#the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.
miss-islington pushed a commit to python/cpython that referenced this issue Jun 20, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in #13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.html#the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 20, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in python#13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.htmlGH-the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
(cherry picked from commit af157fa)

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 20, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in python#13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.htmlGH-the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
(cherry picked from commit af157fa)

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
miss-islington added a commit to python/cpython that referenced this issue Jun 20, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in #13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.htmlGH-the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
(cherry picked from commit af157fa)

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
jaraco pushed a commit to python/cpython that referenced this issue Jun 20, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in #13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.htmlGH-the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
(cherry picked from commit af157fa)

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>

Co-authored-by: Brian Rutledge <brian@bhrutledge.com>
fasih pushed a commit to fasih/cpython that referenced this issue Jun 29, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in python#13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.html#the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
arun-mani-j pushed a commit to arun-mani-j/cpython that referenced this issue Jul 21, 2020
Related to pypa/twine#638 and pypa/packaging.python.org#730, I wrote a spec based on the one that was removed in python#13087. However, a Google search for "pypirc" turned up at least one [blog post](https://truveris.github.io/articles/configuring-pypirc/) that links to https://docs.python.org/3/distutils/packageindex.html#the-pypirc-file, which now just links to this document. So, I thought a link to the spec would be handy.

Automerge-Triggered-By: @jaraco
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 a pull request may close this issue.

3 participants