Skip to content

The hdf5 and hdf5-sys names on crates.io #25

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

Closed
aldanor opened this issue Jan 11, 2019 · 1 comment
Closed

The hdf5 and hdf5-sys names on crates.io #25

aldanor opened this issue Jan 11, 2019 · 1 comment

Comments

@aldanor
Copy link
Owner

aldanor commented Jan 11, 2019

Dear user of / contributor to hdf5-rs: if you support the idea that this crate is renamed to hdf5 on crates.io (and the library is renamed to hdf5 as well), please leave a shout here (your voice matters!):

Longer story: when this crate was created, names "hdf5" and "hdf5-sys" (and "hdf5" library name) had already been reserved on crates.io, hence we currently have the following collection of crates:

  • hdf5-rs
  • libhdf5-sys
  • hdf5-derive
  • hdf5-types

Also, since hdf5_rs makes for an unwieldy import name, the library is currently named h5, like h5::File. This makes it somewhat confusing and is arguably non-idiomatic, compared to other popular Rust crates (e.g. take "curl": the github repo is "curl-rust", the crates are "curl-sys" and "curl", the library is "curl").

As the author (@IvanUkhov) of hdf5 and hdf5-sys crates notes, he has no future plans in supporting or developing those packages -- which may lead to further confusion for new users. However, he kindly agrees to transfer the ownership of those names to us, conditional on the fact that this is "what the community prefers" (which is the part where you, the community, come in):

However, I do want to make sure that it is indeed what the community prefers, and I wasn’t able to infer this from the download counters of hdf5 and hdf5-rs.

If we rename the crates, we'll end up with the following:

  • hdf5
  • hdf5-sys
  • hdf5-derive
  • hdf5-types

with the library name being "hdf5", importable like hdf5::File.

libhdf5-sys crate would then be deprecated and eventually removed from the crates.io index.

@aldanor
Copy link
Owner Author

aldanor commented Mar 7, 2019

The naming dilemma has been resolved, thanks a million to everyone involved (see hilbert-space/hdf5#5 for details).

@aldanor aldanor closed this as completed Mar 7, 2019
@aldanor aldanor unpinned this issue Mar 7, 2019
magnusuMET added a commit to magnusuMET/hdf5-rust that referenced this issue Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant