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

Package maap-py so it can be installed through a package manager #801

Open
marjo-luc opened this issue Sep 12, 2023 · 20 comments
Open

Package maap-py so it can be installed through a package manager #801

marjo-luc opened this issue Sep 12, 2023 · 20 comments
Assignees
Labels
API MAAP API Subsystem
Milestone

Comments

@marjo-luc
Copy link
Member

Right now, maap-py needs to be installed from source. This makes it harder on users who are creating custom environments who may not know how or which versions to install from source. Having the module packaged and installable using a package manager such as pip would improve the user experience and align it with how users install other packages.

@marjo-luc marjo-luc self-assigned this Sep 12, 2023
@grallewellyn
Copy link
Collaborator

@marjo-luc Do you want me to work on this? I am looking for new tickets. Is pip the preferred way to go?

@rtapella
Copy link
Collaborator

we did this for the Unity project in case you want to talk to ppl about how to get it into pypi
https://pypi.org/project/unity-sds-client/

@rtapella
Copy link
Collaborator

One thing you should do first is look at pypi to see if there are similarly named packages...
https://pypi.org/project/MAAP/

@rtapella
Copy link
Collaborator

(some of the MAAP stuff is from Marjorie, it looks like... but not all?)

@grallewellyn
Copy link
Collaborator

Thanks Rob! I was working on this for ipycmc following these steps: https://packaging.python.org/en/latest/tutorials/packaging-projects/

Looks like I can get away with the name maap-py

@marjo-luc
Copy link
Member Author

We have the jupyter server extension on pypi already. The frontend extensions are on npm.

Let's hold off on doing this right away. I want to take this opportunity to review maap-py first.

@marjo-luc marjo-luc added this to the 3.1.4 milestone Nov 20, 2023
@marjo-luc marjo-luc modified the milestones: 3.1.4, 3.1.5 Jan 10, 2024
@grallewellyn
Copy link
Collaborator

I believe this includes removing the need for locating the maap.cfg file to instantiate a MAAP instance, correct me if I am wrong since that is not a separate ticket but I can make one

@marjo-luc
Copy link
Member Author

We would like to do that, but that doesn't necessarily preclude us from packaging maap-py. Feel free to create a ticket to track maap.cfg updates separately.

@grallewellyn
Copy link
Collaborator

Created new ticket here: #909

@chuckwondo
Copy link
Collaborator

@grallewellyn, we can package maap.cfg within the maap-py package as part of the packaging process. To aid doing so, it should be moved within the maap directory so that it becomes a package resource. It's a matter of only a couple of code changes related to reading the config and an addition to setup.py.

I'd be happy to show you how to do this.

@grallewellyn
Copy link
Collaborator

@sujen1412 said he wanted to work on the ticket for removing the need for tracking maap.cfg

@chuckwondo
Copy link
Collaborator

@grallewellyn, as mentioned in conversation with @sujen1412 in #909, I'll now work on making maap.cfg a package resource, which will obviate the need for using the MAAP_CONF env var. This corresponding issue in the maap-py repo: MAAP-Project/maap-py#78.

@chuckwondo
Copy link
Collaborator

I believe my work on MAAP-Project/maap-py#78 addressed this issue. Does that suffice to close this issue as complete?

@grallewellyn
Copy link
Collaborator

@chuckwondo Did you release maap-py on a package manager? I don't see it on pip, conda or npm
I think you did resolve this issue though: #909

@chuckwondo
Copy link
Collaborator

Nope, no release. Isn't @bsatoriu supposed to work on setting things up to allow us to cut releases to pip and/or conda-forge?

@marjo-luc
Copy link
Member Author

MAAP-Project/maap-py#78 does not satisfy the work captured in this ticket.

@chuckwondo I'm not aware of any other ticket that describes the work outlined in this ticket. If there is one, please feel free to link it to this one.

@chuckwondo
Copy link
Collaborator

@marjo-luc and @grallewellyn, apologies, I replied to the wrong issue. I meant to comment in #909, which I'll do now.

@chuckwondo
Copy link
Collaborator

As we discussed in a Slack thread, I'm adding a dependency on removing support for Python 2. We'll wait to publish any sort of package until Python 2 remnants are removed, and a minimum Python 3.x version is documented.

@gchang gchang removed this from the 3.1.5 milestone Mar 14, 2024
@chuckwondo
Copy link
Collaborator

@marjo-luc, I just chatted with @grallewellyn about prioritizing this issue of packaging/publishing maap-py over other things and she mentioned that you seem to be on the same page. She also indicated that you'v recently been packaging and publishing other things as well, so do you want to do it for maap-py, or do you need someone else to pick up this issue?

@marjo-luc
Copy link
Member Author

@chuckwondo the platform team will discuss this during our release planning tomorrow.

@marjo-luc marjo-luc added this to the 4.0.0 milestone Apr 10, 2024
@marjo-luc marjo-luc assigned sujen1412 and unassigned marjo-luc Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API MAAP API Subsystem
Projects
None yet
Development

No branches or pull requests

7 participants