Rebrand as Modo Kit Central

feat: Rebrand as Modo Kit Central

.github/workflows/kit_package.yml

@@ -17,19 +17,20 @@ jobs:
       # Get the repository code
       - name: Check out repository code
         uses: actions/checkout@v2
-      # Setup Python
+      # Setup Python and install toml
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
-          python-version: "3.7"
-      # Get the version of the kit and store it as an environment variable
+          python-version: "3.10"
+      # Install toml so we can parse the version file
+      - name: Install toml
+        run: pip install toml
+      # Use toml to get the version of the kit and store it as an environment variable
       - name: Get Kit Version
-        run: |
-          VER=$(cat VERSION)
-          echo "KIT_VERSION=$VER" >> $GITHUB_ENV
+        run: echo "KIT_VERSION=$(python -c 'import toml; print(toml.load("pyproject.toml")["project"]["version"])')" >> $GITHUB_ENV
       # Package the lpk file
       - name: Package Kit
-        run: python build.py
+        run: python -m scripts.build
       # Create a tag release on the repository
       - name: Create Release
         id: create_release
@@ -39,7 +40,7 @@ jobs:
         with:
           # Set tag values
           tag_name: ${{ env.KIT_VERSION }}
-          release_name: Modo Community Hub ${{ env.KIT_VERSION }}
+          release_name: Modo Kit Central ${{ env.KIT_VERSION }}
           draft: false
           prerelease: false
       # Upload the .lpk file to the release tag.
@@ -52,7 +53,7 @@ jobs:
           # Get the url of the checked out code
           upload_url: ${{ steps.create_release.outputs.upload_url }}
           # Get the relative path to the generated kit
-          asset_path: ./build/community_hub_${{ env.KIT_VERSION }}.lpk
+          asset_path: ./build/modo_kit_central_${{ env.KIT_VERSION }}.lpk
           # Get the name of the lpk file
           asset_name: community_hub_${{ env.KIT_VERSION }}.lpk
           # Mark the LPK type as zip

.gitignore

@@ -5,6 +5,8 @@
 # Build
 *.pyc
 build/
+*venv*/
+*.egg*
 
 # Mac crap
 .DS_Store

.python-version

@@ -0,0 +1 @@
+3.10.11

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Franck Elisabeth and ShawnFrueh
+Copyright (c) 2024 Pixel Fondue
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,30 +1,22 @@
-# Modo Community Hub
+# Modo Kit Central
 
-The community hub is a kit for Modo that centralizes community information 
-and third party kits into a singe, easy to use interface.
+Modo Kit Central is a community led project to help users find and install kits for Modo.
 
-# Building or Installing the kit
-Python version: `3.7` 
+# Installing the kit
+Navigate to the releases tab and download the [latest release](https://github.com/Pixel-Fondue/modo-kit-central/releases/latest).
 
-To install the kit to your appdata kits directory, run: `install.py`
-
-To build the lpk file, run: `build.py`
+Once downloaded, drag-and-drop the `modo_kit_central_<version>.lpk` file into Modo to install.
 
 # Current State
-The current state of the kits is displaying Kits, Videos and some Social links.
+The current state of the kit is to show and install (if applicable) all free kits available to the community.
 
 # Future state
-The hub will be designed as a UI that is easy to navigate showing various 
-resources from the community, including: Various hard to find kits, Recent 
-events in the Modo world, links to tutorials, links to all third-party kits 
-with option to install directly from the hub given the developer has set up
-there kit to do so.
+Modo Kit Central will be a hub for all kits, free and paid.
+Users will be able to install and update kits directly from the UI.
 
 # Publicly sourced information
-After initial release, there will be a method for any user to submit their
-kit/tutorial/blog or preset via GitHub. Walk-through tutorials are in the making
-to help make the process easy for new users to GitHub.
+After initial release, there will be a method for any user to submit their free or paid (future) kits
+to be added to the central hub.
 
-# Creating A release
-When A branch is merged to main, a GitHub action will begin to process the LPK 
-generation and add the kit file to a release tag where users can download the latest file.
+# Contributing to the project
+See the [TECH_NOTES.md](TECH_NOTES.md) file for more information.

TECH_NOTES.md

@@ -0,0 +1,46 @@
+# Local setup:
+___
+1. Clone the repository.
+2. Create a virtual environment.
+   - `python -m venv .venv`
+3. Activate the virtual environment.
+   - MAC: `source .venv/bin/activate`
+   - Windows: `.venv\Scripts\activate`
+4. Remove the .venv-mkc folder.
+   - MAC: `rm -rf .venv`
+   - Windows: `rmdir /s .venv`
+5. Install the `pyproject.toml` requirements.
+   - `pip install .`
+
+
+# Python setup using pyenv:
+___
+It is preferred to use `pyenv` to manage python installations on your machine.
+
+MacOS: 
+- `brew install pyenv`
+- `pyenv install 3.10.11`
+- `pyenv global 3.10.11`
+
+Windows:
+- `choco install pyenv-win`
+- `pyenv install 3.10.11`
+- `pyenv global 3.10.11`
+- Without choco:
+- - Follow the instructions on the [pyenv-win github page](https://github.com/pyenv-win/pyenv-win/blob/master/docs/installation.md#powershell).
+
+# Running the scripts
+1. Install the kit locally.
+   - `python -m scripts.install`
+2. Build the .lpk file.
+   - `python -m scripts.build`
+3. Run the UI locally. (Not in modo)
+   - `python -m scripts.run`
+
+
+## TODO List:
+- [ ] Clean up kit JSON data.
+- [ ] Add more kits to the kits.json file.
+- [ ] Create workflow for adding a new kit.
+- [ ] Allow self update of the hub.
+- [ ] Show installed kits.