[CONPY-71] Connector/Python source tarball uses non-descriptive name for top-level directory Created: 2020-06-08 Updated: 2020-06-09 Resolved: 2020-06-09 |
|
| Status: | Closed |
| Project: | MariaDB Connector/Python |
| Component/s: | Installation |
| Affects Version/s: | 0.9.59 |
| Fix Version/s: | N/A |
| Type: | Bug | Priority: | Major |
| Reporter: | Geoff Montee (Inactive) | Assignee: | Georg Richter |
| Resolution: | Won't Fix | Votes: | 0 |
| Labels: | None | ||
| Description |
|
MariaDB Connector/Python's source tarballs currently uses a non-description name for the top-level directory. For example, I downloaded the following source tarball:
Let's look at what the top-level directory inside the tarball is called:
The name mariadb-0.9.59 is obviously not very descriptive. In my opinion, it would be more appropriate to use a name like mariadb-connector-python-0.9.59 instead. |
| Comments |
| Comment by Georg Richter [ 2020-06-09 ] | |||
|
The name of the module is mariadb, so when creating the tarball setuptools use the module name and the version number as directory name. | |||
| Comment by Geoff Montee (Inactive) [ 2020-06-09 ] | |||
|
Hi georg, That makes sense. However, the non-descriptive directory complicates the installation documentation a bit, because we have to worry about whether the non-descriptive directory name conflicts with other directories or files that the user might have on their system. Couldn't you fix this by keeping the module directory name like mariadb-0.9.59, but then packaging that directory in a separate top-level directory like mariadb-connector-python-0.9.59? So the tarball would look like this instead:
| |||
| Comment by Georg Richter [ 2020-06-09 ] | |||
|
We create the tarbar with
This tarball is also used for all platforms (except windows) for building the module when installing via pip. | |||
| Comment by Geoff Montee (Inactive) [ 2020-06-09 ] | |||
|
OK, thanks! |