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

Change repo/package/module namespace to oemetadata #15

Closed
4lm opened this issue Dec 3, 2019 · 8 comments · Fixed by #20
Closed

Change repo/package/module namespace to oemetadata #15

4lm opened this issue Dec 3, 2019 · 8 comments · Fixed by #20
Assignees
Labels
part: documentation 📖 Improvements or additions to documentation

Comments

@4lm
Copy link
Collaborator

4lm commented Dec 3, 2019

  1. The OEP related repos now use the wording "Open Energy Family" instead of "OpenEngeryPlatform", because of this the namespace should change on PyPI from "oep-" to "oef-" (which seems to be available: https://pypi.org/search/?q=oef).

  2. The module name "metadata" is very generic and IMO should be changed to "oef_metadata", to avoid possible module name conflicts in the future. Because of this I also would change the repo name to "oef-metadata" (conventions: Git(hub) repo and (PyPI) package names separated by "-" and the module names by "_").

What do you think?

@4lm 4lm self-assigned this Dec 3, 2019
@4lm 4lm added the type: enhancement ⚙️ Improvement of an existing feature label Dec 3, 2019
@4lm
Copy link
Collaborator Author

4lm commented Dec 3, 2019

@Ludee had IMO a good idea we could change the namespace like in oedialect to "oe", which would result in "oemetadata", so we would not have to decide between "oef-" or "oep-" and we would be consistent with "oedialect" the only other* OEP/OEF package released on PyPI.

What do you think?

Edit: *Wrong. "omi" is also on PyPI. But nevertheless IMO "oe" namespacing is a good solution, which we also used for the OEP, hence the "oeplatform" repo name.

@4lm 4lm changed the title Change PyPI namespace from "oep-" to "oef-" and maybe use namespace also for repo/module Change repo/package/module namespace Dec 3, 2019
@Bachibouzouk
Copy link
Contributor

I am for the "oe" namespacing :)

4lm added a commit that referenced this issue Dec 5, 2019
@Ludee Ludee changed the title Change repo/package/module namespace Change repo/package/module namespace to oemetadata Apr 16, 2020
@Ludee Ludee assigned jh-RLI and christian-rli and unassigned 4lm Apr 16, 2020
@Ludee Ludee added part: documentation 📖 Improvements or additions to documentation and removed type: enhancement ⚙️ Improvement of an existing feature labels Apr 16, 2020
@jh-RLI
Copy link
Contributor

jh-RLI commented Apr 16, 2020

@Ludee Have we agreed on "oemetadata"?

@Ludee
Copy link
Member

Ludee commented Apr 16, 2020

It seems like it! Can you do it?
Please have a look at the other repos as well.

@jh-RLI
Copy link
Contributor

jh-RLI commented Apr 16, 2020

@Ludee I haven't done that yet, but I'm gonna figure it out!

@Ludee
Copy link
Member

Ludee commented Apr 16, 2020

@Ludee I haven't done that yet, but I'm gonna figure it out!

Perfekt, please research (try) and document:
https://github.com/OpenEnergyPlatform/organisation/wiki/OEP-Organisation
OpenEnergyPlatform/organisation#33

@jh-RLI
Copy link
Contributor

jh-RLI commented May 5, 2020

I want to rename the repo to "oemetadata" and update de package name on PyPI. Do you see any major problems with that? @Ludee @christian-rli @MGlauer

@jh-RLI jh-RLI linked a pull request Jun 23, 2020 that will close this issue
@jh-RLI
Copy link
Contributor

jh-RLI commented Jun 23, 2020

Done. I will close this. We have to figure out, how the new URL is handled before merging into the master branch.

@jh-RLI jh-RLI closed this as completed Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: documentation 📖 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants