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

Adding instructions for anaconda install #3310

Merged
merged 2 commits into from
May 20, 2024
Merged

Adding instructions for anaconda install #3310

merged 2 commits into from
May 20, 2024

Conversation

hulsed
Copy link
Contributor

@hulsed hulsed commented May 17, 2024

Adding docs page for installing anaconda within anaconda per our discussion here: #2821. It may require some nudging to fit within the rest of the documentation, but I've verified the process on an otherwise blank windows machine (perhaps this should be titled as windows-only? I am not sure how ).

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bug fix
  • Feature
  • Chore (refactoring, formatting, local variables, other cleanup)
  • Documentation content changes

What is the current behavior?

Currently, it's difficult to work with gaphor from an external python console without a full development install which may require root permissions. This provides instructions for installing gaphor in an anaconda environment so can install and work with gaphor modules without root permissions.

Issue Number: #2821

What is the new behavior?

This commit adds instructions for working in an anaconda environment.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

- Docs page added for anaconda installation
- See: gaphor#2821
@danyeaw
Copy link
Member

danyeaw commented May 19, 2024

Hi @hulsed, thanks so much for the contribution! If libadwaita and gtksourceview5 aren't available with anaconda what is the result of this environment? Are able to successfully install Gaphor and run scripts, but not able to launch Gaphor itself?

- Limited anaconda installation docs now organized under "windows" since this is the relevant development environment for it
- Clarified language about the limitations of an anaconda install (and why you might use it)
@hulsed
Copy link
Contributor Author

hulsed commented May 19, 2024

@danyeaw I added some language here that I hope explains that better. Unfortunately, I haven't really been able to demo this extensively to see what I can/can't do, but I can say:

  • it lets you interact with some gaphor classes like SysML, ElementFactory, and ModelingLanguageService
  • interacting with Session does not work, ostensibly because it wants gtk inspection. The error it gives is:
    image

I'd like to characterize what you can and can't do here a bit better, but unfortunately--if I get a bit further working with this, perhaps I could perform some tests/searches and make a list or diagram?

Copy link
Member

@danyeaw danyeaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for the contribution @hulsed! I think over time we can figure out if using Anaconda or some other solution is best for your use case, but I think adding some initial docs for the Anaconda crowd is great 👍. Maybe we need to work to get libadwaita and gtksourceview packaged.

@danyeaw danyeaw merged commit 2c61673 into gaphor:main May 20, 2024
12 checks passed
@danyeaw
Copy link
Member

danyeaw commented May 20, 2024

@all-contributors please add @hulsed for docs

Copy link
Contributor

@danyeaw

I've put up a pull request to add @hulsed! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants