Skip to content
This repository has been archived by the owner on May 5, 2024. It is now read-only.

PytonPackages

charlie-sans edited this page Jun 15, 2023 · 1 revision

welcome to the official documentation on how to make packages for PythonicOS!

what is a package?

a package is a collection of files that can be installed on a PythonicOS system. packages can be installed from the PythonicOS package manager, pyton. packages can be installed from a local file, or from the official repository.

please note that local files are not yet supported in Pyton and should be added manualy by downloading the package from the official repo and adding it to the addons folder in system/addons.

how do i make a package?

do note that this is a very early version of the package manager and is not yet finished. the order of this will change with further updates to the package manager.

1. make a python script

make a python script that will be the main file of your package. this is the file that will be executed when the package is run. this file should be named <yourapp>.py replacing <yourapp> with the name of your app. this file should be in the root of your package folder and must be the same name as your repo as to not confuse the user and package manager.

you can have as many python files in your package as you want but only 1 of them can be the main file. the main file is the file that will be executed when the package is run.

2. make a issue on the official repo with your package name and repo link

make a issue on the official repo with your package name and repo link. this is so that the team can scan your package from the repo and add it to the official repo.

your package should be hosted on a git repository. this is so that the package manager can download the package from the repository.

with how the package manager works, Pyton will get data from a Repo.JSON file hosted on the official https://OpenStudioCorp.github.io website, it will then download the package from the repo and install it to the addons folder in system/addons.

instead of it just being comprised of a python script, it will be a folder with the name of the repo and the scripts inside of it, that way Pyton can uninstall it with the users consent when they dont want it anymore by running pyton uninstall <yourapp> replacing <yourapp> with the name of your app.

if you want to intergrate your own apps to the repo you can do so by making a request with json to https://openstudiocorp.github.io/repo.json

3. wait for your package to be added to the official repo

wait for your package to be added to the official repo. this may take a while as the team has to scan your package to make sure it is safe to be added to the official repo.

4. install your package

install your package from the official repo using the package manager. you can do this by running pyton install <yourapp> replacing <yourapp> with the name of your app.

5. run your package

once your package is installed, just press the apps button in the taskbar and click on your app to run it.

6. uninstall your package

if you want to uninstall your package, just run pyton uninstall <yourapp> replacing <yourapp> with the name of your app.

hope you enjoy making packages for PythonicOS!