Make the PyPI distribution name consistent with the domain name and debian packages. #2011

New Issue

nejucomo · 2013-07-04T16:41:51Z

nejucomo commented

2013-07-04 16:41:51 +00:00

Criteria:

This ticket is closed when the PyPI package name is tahoe-lafs, otherwise this ticket is set to a different unopen status.

Synopsis:

The distribution names are inconsistent, as seen in: (@@https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1950#comment:92342@@)

PyPI package name is allmydata-tahoe
The debian name is tahoe-lafs
The domain name is tahoe-lafs.org: https://tahoe-lafs.org
The github name is tahoe-lafs: https://github.com/tahoe-lafs/
Anecdotally the common "spoken name" is either "tahoe" or "tahoe lafs".

I propose we alter the PyPI package to match the others: tahoe-lafs

Related:

#1950 is about a larger, more time consuming project which involves changing the python module names as well.

**Criteria:** This ticket is closed when the PyPI package name is `tahoe-lafs`, otherwise this ticket is set to a different unopen status. **Synopsis:** The distribution names are inconsistent, as seen in: (@@https://tahoe-lafs.org/trac/tahoe-lafs/ticket/1950#[comment:92342](/tahoe-lafs/trac-2024-07-25/issues/2011#issuecomment-92342)@@) * PyPI package name is `allmydata-tahoe` * The debian name is `tahoe-lafs` * The domain name is `tahoe-lafs.org`: <https://tahoe-lafs.org> * The github name is `tahoe-lafs`: <https://github.com/tahoe-lafs/> * Anecdotally the common "spoken name" is either "tahoe" or "tahoe lafs". I propose we alter the PyPI package to match the others: `tahoe-lafs` **Related:** * #1950 is about a larger, more time consuming project which involves changing the python module names as well.

nejucomo added the

labels 2013-07-04 16:41:51 +00:00

nejucomo added this to the undecided milestone 2013-07-04 16:41:51 +00:00

tahoe-lafs added

packaging

and removed

unknown

labels 2013-07-14 00:45:29 +00:00

tahoe-lafs modified the milestone from undecided to soon

2013-11-17 21:30:54 +00:00

daira commented

2014-10-27 01:41:28 +00:00

This was blocked on #1159 which is now fixed.

If we changed the package name for 1.11, that would mean nodes created by 1.11 could not be run by versions earlier than 1.10.1, but that's probably fine.

This was blocked on #1159 which is now fixed. If we changed the package name for 1.11, that would mean nodes created by 1.11 could not be run by versions earlier than 1.10.1, but that's probably fine.

tahoe-lafs modified the milestone from soon to 1.12.0

2014-10-27 01:41:28 +00:00

daira commented

2014-12-04 13:58:57 +00:00

This ticket also implies changing the name we use for git tags, currently patterned as allmydata-tahoe-1.10.1, to e.g. tahoe-lafs-1.11.0. (source:setup.py already makes this naming assumption as of changeset:e1a3a2001f37ce4225fb0f600c7eb30d9a061e06/trunk.)

This ticket also implies changing the name we use for git tags, currently patterned as `allmydata-tahoe-1.10.1`, to e.g. `tahoe-lafs-1.11.0`. (source:setup.py already makes this naming assumption as of changeset:e1a3a2001f37ce4225fb0f600c7eb30d9a061e06/trunk.)

daira commented

2014-12-05 12:55:21 +00:00

As part of fixing this we should check there are no more references to "allmydata-tahoe" in code or comments.

daira commented

2014-12-07 18:12:40 +00:00

(https://github.com/tahoe-lafs/tahoe-lafs/commits/2011-allmydataectomy-1) (the last two commits).

This is not a pull request yet because it is scheduled for after v1.10.1.

(https://github.com/tahoe-lafs/tahoe-lafs/commits/2011-allmydataectomy-1) (the last two commits). This is not a pull request yet because it is scheduled for after v1.10.1.

daira commented

2014-12-07 18:19:37 +00:00

Also note that builds of the above branch will fail unless there is a tag in the history with name starting "tahoe-lafs-" (e.g. see https://travis-ci.org/tahoe-lafs/tahoe-lafs/jobs/43273843#L436). This is intentional.

Also note that builds of the above branch will fail unless there is a tag in the history with name starting "tahoe-lafs-" (e.g. see <https://travis-ci.org/tahoe-lafs/tahoe-lafs/jobs/43273843#L436>). This is intentional.

tahoe-lafs modified the milestone from 1.12.0 to 1.11.0

2015-04-12 22:49:00 +00:00

warner commented

2016-03-22 05:02:52 +00:00

Milestone renamed

warner modified the milestone from 1.11.0 to 1.12.0

2016-03-22 05:02:52 +00:00

warner commented

2016-03-25 16:46:30 +00:00

I want this in 1.11, so that we can recommend pip install tahoe-lafs right off the bat, rather than having an intermediate period where the instructions say pip install allmydata-tahoe.

I want this in 1.11, so that we can recommend `pip install tahoe-lafs` right off the bat, rather than having an intermediate period where the instructions say `pip install allmydata-tahoe`.

warner modified the milestone from 1.12.0 to 1.11.0

2016-03-25 16:46:30 +00:00

warner commented

2016-03-25 17:58:14 +00:00

When this lands, we should add a Obsoletes-Dist field to our setup.py metadata, to point at the old allmydata-tahoe name.

When this lands, we should add a [Obsoletes-Dist](https://www.python.org/dev/peps/pep-0345/#obsoletes-dist-multiple-use) field to our setup.py metadata, to point at the old `allmydata-tahoe` name.

warner commented

2016-03-25 18:01:12 +00:00

Replying to daira:

If we changed the package name for 1.11, that would mean nodes created by 1.11 could not be run by versions earlier than 1.10.1, but that's probably fine.

I need to test it, but we stopped using the contents of the .tac files back in 1.9.2 (commit [87a6894e62] on 23-May-2012). So I think the lingering pkg_resources.require('allmydata-tahoe') in them won't affect our backwards-compatibility story very much.

Replying to [daira](/tahoe-lafs/trac-2024-07-25/issues/2011#issuecomment-92339): > If we changed the package name for 1.11, that would mean nodes created by 1.11 could not be run by versions earlier than 1.10.1, but that's probably fine. I need to test it, but we stopped using the contents of the .tac files back in 1.9.2 (commit [87a6894e62] on 23-May-2012). So I think the lingering `pkg_resources.require('allmydata-tahoe')` in them won't affect our backwards-compatibility story very much.

warner commented

2016-03-25 18:13:03 +00:00

Oops, I'm wrong, 1.10.0 does use the contents of the tac file (it runs twistd -y $TAC), but 1.10.1 does not. Same argument applies: building a node with the new name=tahoe-lafs 1.11.0 release, then rolling back to 1.10.0 (released in may of 2013), would break.

Oops, I'm wrong, 1.10.0 *does* use the contents of the tac file (it runs `twistd -y $TAC`), but 1.10.1 does not. Same argument applies: building a node with the new `name=tahoe-lafs` 1.11.0 release, then rolling back to 1.10.0 (released in may of 2013), would break.

warner commented

2016-03-25 18:17:59 +00:00

Daira had a great idea: we could help old tahoe versions produce a better error message by writing out .tac files that throw an error if they're imported.

Newer Tahoes don't use the contents of the .tac file at all: they just look at the file name to decide what type of node it is, then instantiate the appropriate class (client, introducer, stats-gatherer, etc). Older Tahoes use twistd -y tac, which imports the .tac file.

So we can raise [RuntimeError](wiki/RuntimeError) in the new .tac files, and then older tahoes will print the exception when they attempt to run twistd on it.

Daira had a great idea: we could help old tahoe versions produce a better error message by writing out .tac files that throw an error if they're imported. Newer Tahoes don't use the contents of the .tac file at all: they just look at the file name to decide what type of node it is, then instantiate the appropriate class (client, introducer, stats-gatherer, etc). Older Tahoes use `twistd -y tac`, which imports the .tac file. So we can `raise [RuntimeError](wiki/RuntimeError)` in the new .tac files, and then older tahoes will print the exception when they attempt to run twistd on it.

Daira Hopwood <daira@jacaranda.org> commented

2016-03-25 19:40:36 +00:00

In 0598c83/trunk:

Rename distribution from allmydata-tahoe to tahoe-lafs. fixes ticket:2011

Signed-off-by: Daira Hopwood <daira@jacaranda.org>

In [0598c83/trunk](/tahoe-lafs/trac-2024-07-25/commit/0598c830ed91c459fe955f4880892a05205e167d): ``` Rename distribution from allmydata-tahoe to tahoe-lafs. fixes ticket:2011 Signed-off-by: Daira Hopwood <daira@jacaranda.org> ```

tahoe-lafs added the

fixed

label 2016-03-25 19:40:36 +00:00

Daira Hopwood <daira@jacaranda.org> closed this issue

2016-03-25 19:40:36 +00:00

Sign in to join this conversation.