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

[Addons]: Installation system #63

Open
onerandomusername opened this issue Aug 23, 2021 · 0 comments · May be fixed by #69
Open

[Addons]: Installation system #63

onerandomusername opened this issue Aug 23, 2021 · 0 comments · May be fixed by #69
Assignees
Labels
a: addon system Involving the system for addons to utlise l: intermediate p: normal Normal Priority t: feature Relating to the functionality of the application.
Milestone

Comments

@onerandomusername
Copy link
Member

Overview

Installation system for plugins. Portions of this may be used in the future for other addons, so nearly everything up to when the import is done should be in an addons.py utility file.

The currently supported type of repos are in zip format, using the following structure:

user/repo/Plugins/name/name.py

This gives the advantage to be able to extend the addons api in the future without having to worry about the structure of the repo.

Details

Provided a github or gitlab repo, should parse it to get the specific plugin information, if it exists, from the index.toml file. (I'm open to renaming this file, if someone has a better idea.)

This allows for a user to see what plugins are available in a repo, without installing them. At minimum, this should support github and gitlab repos, given that we can utilize the api to see what is available without downloading. If an index.toml file exists, it should be parsed to get the information. If it does not exist, then we need to get a list of all of the directories in the Plugins folder, which will construct our list of plugins. This does have the side effect of not having any of the metadata for any of the plugins, but I'm of the opinion that an index.toml file is optional and should not be required.

At minimum, the portions that should be in an utils file are:

  • checking it contains extensions of this type
  • checking it is a github or gitlab repo
  • getting the index.toml file
@onerandomusername onerandomusername added l: intermediate p: normal Normal Priority t: feature Relating to the functionality of the application. a: addon system Involving the system for addons to utlise labels Aug 23, 2021
@onerandomusername onerandomusername added this to the Plugin System milestone Aug 23, 2021
@onerandomusername onerandomusername self-assigned this Aug 23, 2021
@onerandomusername onerandomusername changed the title [Plugins]: Installation system [Addons]: Installation system Aug 26, 2021
@onerandomusername onerandomusername linked a pull request Aug 30, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: addon system Involving the system for addons to utlise l: intermediate p: normal Normal Priority t: feature Relating to the functionality of the application.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant