0.2.0 release

- add option "future" as version
- don't allow the update command to run if installed via pip or executable.
- add github action to publish to pip when pushing to main branch (and updating packscript.py)
- move photos to .github folder

Author: Slackow

photos/in_game_img.png .github/photos/in_game_img.pngphotos/in_game_img.png renamed to .github/photos/in_game_img.png

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - packscript.py
+jobs:
+  build-and-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12.2"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

photos/packscript_ex.png .github/photos/packscript_ex.pngphotos/packscript_ex.png renamed to .github/photos/packscript_ex.png

@@ -5,3 +5,4 @@
 
 /*.mcfunction
 /PackScript.code-workspace
+.venv

photos/packscript_ex2.png .github/photos/packscript_ex2.pngphotos/packscript_ex2.png renamed to .github/photos/packscript_ex2.png

@@ -1,12 +1,8 @@
-
-1. Overlays
-2. Create statements with interpolation
-3. Cleaning
-4. Temporary Directory? (would avoid errors causing partial output)
-5. generic zip or dir (make archive without dir at all)
-6. highlight backslashes
-7. Add more tests for each feature/command
-8. make the mod print errors from loading datapack
-9. entrypoint?
-10. edit/get statement?
-11. import via making python files and running them that way
+This document is to keep track of potential changes, nothing here is guaranteed to come later.
+1. Temporary Directory? (would avoid errors causing partial output)
+2. generic zip or dir (make archive without dir at all)
+3. Add more tests for each feature/command
+4. make the reloader mod print errors from loading datapack
+5. entrypoint?
+6. import via making python files and running them that way
+7. labeled lines/find and replace?

.github/workflows/publish.yml

@@ -21,7 +21,7 @@ and generate any other kind of file (especially JSON) easily.
 There is an associated syntax highlighter for VSCode with this project.
 Get it [here](https://marketplace.visualstudio.com/items?itemName=Slackow.ps-support).
 
-![packscript_ex](photos/packscript_ex.png)
+![packscript_ex](.github/photos/packscript_ex.png)
 
 # Constructs
 
@@ -229,9 +229,9 @@ function example_pack:say_something
 
 # Example Usage + PackScript Reloader
 
-![packscript_ex1](photos/packscript_ex2.png)
+![packscript_ex1](.github/photos/packscript_ex2.png)
 
-![minecraft_output](photos/in_game_img.png)
+![minecraft_output](.github/photos/in_game_img.png)
 
 This was used with the associated [packscript_reloader](https://github.com/Slackow/packscript_reloader) fabric mod.
 This mod works on snapshots, and will automatically compile packs under the `dev` directory in the world into the 
@@ -244,7 +244,7 @@ replaces to turn your invalid Python code
 into valid Python code, and then executing it.
 You can see this when you compile in verbose mode:
 
-![packscript_ex2](photos/packscript_ex2.png)
+![packscript_ex2](.github/photos/packscript_ex2.png)
 
 turns into
 
@@ -291,14 +291,15 @@ as the main generated function.
 
 # The CLI
 This tool has two main actions it can perform: compiling packs and initializing templates.
-- `python3 packscript.py c` (you can also use compile or comp)
-- `python3 packscript.py init`
+- `packscript c` (you can also use compile or comp)
+- `packscript init`
 
 More actions:
-- `python3 packscript.py --help` list general help
-- `python3 packscript.py --version` print the version of packscript
-- `python3 packscript.py c --help` print the help for compiling
-- `python3 packscript.py init --help` print the help for initializing a datapack
+- `packscript --help` list general help
+- `packscript --version` print the version of packscript
+- `packscript c --help` print the help for compiling
+- `packscript init --help` print the help for initializing a datapack
+- `packscript pf` edit and view the pack_format(s) supported by your datapack, you can use recognized version numbers directly
 ## Compile Options
 - `-i/--input <dir>` specify the directory of the pack you are compiling defaults to current dir.
 - `-o/--output <dir/zip>` specify the output of the pack (can output zip too) defaults to `output`
@@ -311,11 +312,11 @@ using this action.
 
 You can also specify options using flags
 
-ex: `python3 packscript.py init --output "Datapack" --name "Datapack" --namespace "main" --description "Datapack for version 1.20.4" --pack-format 26`
+ex: `packscript init --output "Datapack" --name "Datapack" --namespace "main" --description "Datapack for version 1.20.4" --pack-format 26`
 
 it's preferable to do just call the following instead:
 
-`python3 packscript.py init`
+`packscript init`
 
 ## Compile Action
 When a PackScript file is being compiled it will first print its location to the console, this is so if an error is encountered
@@ -346,12 +347,10 @@ In this case it's because there's a letter before the command line, making it ge
 # Get Started
 1. **Install Python.** Get [Python3](https://www.python.org/downloads/) and
    make sure it's in your path. (You can check by running `python3 -V` in your terminal)
-2. **Download PackScript.** You can find `packscript.py`
-   [here](https://github.com/Slackow/PackScript/releases/latest)
-3. **Setup Environment.** Place the `packscript.py` file into your working directory
-4. **Create A Datapack.** Run `python3 packscript.py init` in order to create a datapack with
+2. **Download/Install PackScript.** run `pip3 install packscript`, or directly use the `packscript.py` file in releases, and use `python3 packscript.py` instead of `packscript`
+3. **Create a Datapack.** Run `packscript init` in order to create a datapack with
    PackScript. You'll be prompted for information about the datapack.
    You should have a new datapack, you can put files in there as usual for them to
    be outputted, files in `<pack>/data/*/source/*.dps` and `<pack>/*.fps` will be interpreted as PackScript
    on compilation. By default, you will find a main.dps file there.
-5. **Compile Datapack.** To compile, run `python3 packscript.py compile -i <datapack directory> -o <output>`
+4. **Compile Datapack.** To compile, run `packscript compile -i <datapack directory> -o <output>`

.gitignore

@@ -3,8 +3,8 @@
 # /// script
 # requires-python = ">=3.12"
 # ///
-__version__ = '0.1.6'
-__v_type__  = 'dev'
+__version__ = '0.2.0'
+__v_type__  = 'release'
 __author__  = 'Slackow'
 __license__ = 'MIT'
 
@@ -25,6 +25,7 @@ def ver(base_version, start, end, *, pf):
 
 
 pack_formats = {
+    'future': 9001,
     '1.21.4': 61,
     '1.21.3': 57, '1.21.2': 57,
     '1.21.1': 48, '1.21': 48,
@@ -147,7 +148,8 @@ def __getattr__(self, attr: str):
             return Dp((*self._type, attr))
         def __setattr__(self, attr: str, value: dict | list | str | bytes):
             if attr == '_type':
-                return object.__setattr__(self, attr, value)
+                object.__setattr__(self, attr, value)
+                return
             other.setdefault('/'.join(self._type), {})[n(attr)] = value
         def __delattr__(self, item):
             other['/'.join(self._type)].pop(n(item))
@@ -230,7 +232,7 @@ def comp_file(parent: Path, filename: Path, globals: dict[str, object], verbose=
             create_match = create_statement_re.fullmatch(line)
             if create_match:
                 indent, file_type, name, data = create_match.groups()
-                name = ns(name, default=globals['ns'])
+                name = ns(name, default=str(globals['ns']))
                 code.append(f'{indent}__other__("{file_type}")["{name}"] ={data}')
             else:
                 code.append(line)
@@ -270,7 +272,7 @@ def comp_pack(output_folder, pack_format, source, verbose):
                 (namespace / 'sources').exists()):
             raise ValueError('Legacy "sources" folder detected! Rename your folders to be singular!')
 
-        for filename in working_folder.rglob(f'*.{DATA_EXT}'):
+        for filename in sorted(working_folder.rglob(f'*.{DATA_EXT}')):
             comp_file(working_folder, filename, globals, verbose=verbose)
 
         if not source:
@@ -367,7 +369,7 @@ def comp(*, input: str, output: str, verbose: bool, source: bool, **_):
             shutil.rmtree(output_folder)
 
     func_files = {}
-    for f in input.glob(f'*.{FUNC_EXT}'):
+    for f in sorted(input.glob(f'*.{FUNC_EXT}')):
         func_stack = [f.name]
         func_files[f.name] = []
         globals = build_globals(func_stack, [], func_files, {})
@@ -442,6 +444,7 @@ def update_pack_format(*, input: str, target: str, min: str, max: str, **_):
         (input / 'pack.mcmeta').write_text(json.dumps(pack_meta, indent=4))
     else:
         target, min, max = target_pack_format, min_pack_format, max_pack_format
+        print('edit these values via the --min, --target, or --max options')
 
     def versions_of(pf):
         return f"({', '.join(key for key, value in pack_formats.items() if value == pf)})"
@@ -471,7 +474,7 @@ def get_data_from_url(url: str, default_context=True, max_redirects=10):
     headers = {'Accept': '*/*', 'User-Agent': 'packscript.py'}
     connection.request('GET', path, headers=headers)
     response = connection.getresponse()
-    if response.status in range(300, 400) and max_redirects > 0:
+    if 300 <= response.status < 400 and max_redirects > 0:
         return get_data_from_url(response.getheader('Location'), default_context, max_redirects - 1)
     return response
 
@@ -504,6 +507,10 @@ def replace_script_with_latest():
 
 
 def update():
+    if __package__ is not None or getattr(sys, 'frozen', False):
+        print('You are using pip or the script is otherwise frozen! Cannot update.')
+        print('To update the package via pip use "pip install --upgrade packscript"' + ("" if __package__ is not None else "!"))
+        return
     latest = get_latest_version()
     if latest == __version__:
         print(f"Up to date, PackScript {__version__}")

.todo.md

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "packscript"
+dynamic = ["version", "authors", "license"]
+requires-python = ">=3.12"
+readme = {file = "README.md", content-type = "text/markdown"}
+keywords = ["packscript", "mcfunction", "datapack", "pack.mcmeta", "nbt", "templating", "language"]
+
+[project.scripts]
+packscript = "packscript:main"
+
+[tool.setuptools]
+py-modules = ["packscript"]
+
+[tool.setuptools.dynamic]
+version = {attr = "packscript.__version__"}
+license = {attr = "packscript.__license__"}
+authors = [{name = {attr = "packscript.__author__"}}]