pyrecli 0.2.0__tar.gz → 0.2.1__tar.gz

pyrecli-0.2.1/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.1
+Name: pyrecli
+Version: 0.2.1
+Summary: Command line utilities for DiamondFire templates
+Home-page: https://github.com/Amp63/pyrecli
+License: MIT
+Keywords: diamondfire,minecraft,template,cli
+Author: Amp
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: dfpyre (>=0.9.3,<0.10.0)
+Project-URL: Repository, https://github.com/Amp63/pyrecli
+Description-Content-Type: text/markdown
+
+# pyrecli
+
+Command line utilities for DiamondFire templates
+
+## Installation
+
+Run the following command in a terminal:
+
+```sh
+pip install pyrecli
+```
+
+## Commands
+
+- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `rename`: Rename all occurences of a variable (including text codes)
+- `script`: Generate python scripts from template data
+- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `docs`: Generate markdown documentation from template data
+- `slice`: Slice a template into multiple smaller templates
+
+
+## What is this useful for?
+
+- Backing up a plot
+- Getting an accurate text representation of DF code
+- Open sourcing
+- Version control
+- Large scale refactoring
+
+
+## Example Command Usages
+
+### Scan
+
+**[Requires CodeClient]**
+
+Grabs all of the templates on your current plot and saves them to a file.
+You will need to run `/auth` in-game to authorize this action.
+
+Example:
+```sh
+# Dumps all template data into templates.dfts
+pyrecli scan templates.dfts
+```
+
+### Send
+
+**[Requires CodeClient]**
+
+Sends all templates in a file back to DiamondFire.
+Essentially the reverse of `scan`.
+
+Example:
+```sh
+pyrecli send templates.dfts
+```
+
+### Rename
+
+Renames all occurences of a variable in a list of templates.
+You can run this command on a single template, or on an entire plot if a variable is used in many places.
+
+This command still requires thorough testing, so make sure you have a backup of your plot before using this command on a large scale.
+
+Example:
+```sh
+# Changes all variables named `foo` to `bar`.
+pyrecli rename templates.dfts foo bar
+
+# You can also target a specific scope.
+# This changes all occurences of the game variable `plotData` to `gameData`.
+pyrecli rename templates.dfts plotData gameData -s game
+```
+
+By default, this modifies the input file in-place, but you can use the `--output_path` flag to output the renamed templates to a new file:
+```sh
+pyrecli rename templates.dfts foo bar --output_path renamed_templates.dfts
+```
+
+### Script
+
+Generates Python scripts from template data.
+
+Example:
+```sh
+# Convert templates into individual scripts and store them in directory `plot_templates`
+pyrecli script templates.dfts plot_templates
+
+# Convert templates into scripts and put them into a single file `plot_templates.py`
+pyrecli script templates.dfts plot_templates.py --onefile
+```
+
+
+### Grabinv
+
+**[Requires CodeClient]**
+
+Scans your inventory for templates and saves them to a file.
+
+Example:
+```sh
+# Save inventory templates to `templates.dfts`
+pyrecli grabinv templates.dfts
+```
+
+
+### Docs
+
+Generates a Markdown documentation file for a list of templates.
+
+Example:
+```sh
+# Generate documentation and save it to `plot_docs.md`
+pyrecli docs templates.dfts plot_docs.md "My Plot Docs"
+```
+
+
+### Slice
+
+Slices a single template into multiple smaller templates.
+This is useful for resizing templates to fit on a smaller plot.
+
+If multiple templates are passed, only the first one will be used.
+
+**NOTE: This feature is not fully implemented yet. Any templates with Control::Return blocks may not work properly if sliced.**
+
+Example:
+```sh
+# Slices the first template in `templates.dfts` with a target length of 50 and stores them in `sliced_templates.dfts`
+pyrecli slice templates.dfts sliced_templates.dfts 50
+```
+

pyrecli-0.2.1/README.md

@@ -0,0 +1,133 @@
+# pyrecli
+
+Command line utilities for DiamondFire templates
+
+## Installation
+
+Run the following command in a terminal:
+
+```sh
+pip install pyrecli
+```
+
+## Commands
+
+- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `rename`: Rename all occurences of a variable (including text codes)
+- `script`: Generate python scripts from template data
+- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))
+- `docs`: Generate markdown documentation from template data
+- `slice`: Slice a template into multiple smaller templates
+
+
+## What is this useful for?
+
+- Backing up a plot
+- Getting an accurate text representation of DF code
+- Open sourcing
+- Version control
+- Large scale refactoring
+
+
+## Example Command Usages
+
+### Scan
+
+**[Requires CodeClient]**
+
+Grabs all of the templates on your current plot and saves them to a file.
+You will need to run `/auth` in-game to authorize this action.
+
+Example:
+```sh
+# Dumps all template data into templates.dfts
+pyrecli scan templates.dfts
+```
+
+### Send
+
+**[Requires CodeClient]**
+
+Sends all templates in a file back to DiamondFire.
+Essentially the reverse of `scan`.
+
+Example:
+```sh
+pyrecli send templates.dfts
+```
+
+### Rename
+
+Renames all occurences of a variable in a list of templates.
+You can run this command on a single template, or on an entire plot if a variable is used in many places.
+
+This command still requires thorough testing, so make sure you have a backup of your plot before using this command on a large scale.
+
+Example:
+```sh
+# Changes all variables named `foo` to `bar`.
+pyrecli rename templates.dfts foo bar
+
+# You can also target a specific scope.
+# This changes all occurences of the game variable `plotData` to `gameData`.
+pyrecli rename templates.dfts plotData gameData -s game
+```
+
+By default, this modifies the input file in-place, but you can use the `--output_path` flag to output the renamed templates to a new file:
+```sh
+pyrecli rename templates.dfts foo bar --output_path renamed_templates.dfts
+```
+
+### Script
+
+Generates Python scripts from template data.
+
+Example:
+```sh
+# Convert templates into individual scripts and store them in directory `plot_templates`
+pyrecli script templates.dfts plot_templates
+
+# Convert templates into scripts and put them into a single file `plot_templates.py`
+pyrecli script templates.dfts plot_templates.py --onefile
+```
+
+
+### Grabinv
+
+**[Requires CodeClient]**
+
+Scans your inventory for templates and saves them to a file.
+
+Example:
+```sh
+# Save inventory templates to `templates.dfts`
+pyrecli grabinv templates.dfts
+```
+
+
+### Docs
+
+Generates a Markdown documentation file for a list of templates.
+
+Example:
+```sh
+# Generate documentation and save it to `plot_docs.md`
+pyrecli docs templates.dfts plot_docs.md "My Plot Docs"
+```
+
+
+### Slice
+
+Slices a single template into multiple smaller templates.
+This is useful for resizing templates to fit on a smaller plot.
+
+If multiple templates are passed, only the first one will be used.
+
+**NOTE: This feature is not fully implemented yet. Any templates with Control::Return blocks may not work properly if sliced.**
+
+Example:
+```sh
+# Slices the first template in `templates.dfts` with a target length of 50 and stores them in `sliced_templates.dfts`
+pyrecli slice templates.dfts sliced_templates.dfts 50
+```

{pyrecli-0.2.0 → pyrecli-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyrecli"
-version = "0.2.0"
+version = "0.2.1"
 description = "Command line utilities for DiamondFire templates"
 authors = ["Amp"]
 readme = "README.md"
@@ -11,6 +11,7 @@ keywords = ["diamondfire", "minecraft", "template", "cli"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
+dfpyre = "^0.9.3"
 
 
 [tool.poetry.scripts]

{pyrecli-0.2.0 → pyrecli-0.2.1}/pyrecli/pyrecli.py

@@ -11,6 +11,14 @@ from pyrecli.command.docs import docs_command
 from pyrecli.command.slice import slice_command
 
 
+def rename_target_scope(value):
+    SCOPES = {'game', 'saved', 'local', 'line'}
+    if value not in SCOPES:
+        raise argparse.ArgumentTypeError(f'Expected one of {SCOPES} for rename target scope')
+    return value
+
+
+
 def slice_target_length(value):
     MINIMUM_LENGTH = 5
     ivalue = int(value)
@@ -44,7 +52,7 @@ def main():
     parser_rename.add_argument('input_path', help='The file containing template data', type=str)
     parser_rename.add_argument('var_to_rename', help='The variable to rename', type=str)
     parser_rename.add_argument('new_var_name', help='The new name for the variable', type=str)
-    parser_rename.add_argument('--var_to_rename_scope', '-s', help='The scope to match', type=str, default=None)
+    parser_rename.add_argument('--var_to_rename_scope', '-s', help='The scope to match', type=rename_target_scope, default=None)
     parser_rename.add_argument('--output_path', '-o', help='The file to output to', type=str, default=None)
 
     parser_grabinv = subparsers.add_parser('grabinv', help='Save all templates in the inventory to a file with CodeClient')
@@ -61,7 +69,7 @@ def main():
     parser_slice.add_argument('input_path', help='The file containing template data', type=str)
     parser_slice.add_argument('output_path', help='The file to output template data to', type=str)
     parser_slice.add_argument('target_length', help='The maximum length of each sliced template', type=slice_target_length)
-    
+
     parsed_args = parser.parse_args()
 
     match parsed_args.command:

pyrecli-0.2.0/PKG-INFO

@@ -1,66 +0,0 @@
-Metadata-Version: 2.1
-Name: pyrecli
-Version: 0.2.0
-Summary: Command line utilities for DiamondFire templates
-Home-page: https://github.com/Amp63/pyrecli
-License: MIT
-Keywords: diamondfire,minecraft,template,cli
-Author: Amp
-Requires-Python: >=3.10,<3.13
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Project-URL: Repository, https://github.com/Amp63/pyrecli
-Description-Content-Type: text/markdown
-
-# pyrecli
-
-Command line utilities for DiamondFire templates
-
-## Installation
-
-Run the following command in a terminal:
-
-```sh
-pip install pyrecli
-```
-
-## Commands
-
-- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `rename`: Rename all occurences of a variable (including text codes)
-- `script`: Generate python scripts from template data
-- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `docs`: Generate markdown documentation from template data
-
-
-## What is this useful for?
-
-- Backing up a plot
-- Getting an accurate text representation of DF code
-- Open sourcing
-- Version control
-- Large scale refactoring
-
-
-## Example Usage
-
-These two commands will scan your plot, convert each template into a python script, then place the scripts into a directory called `myplot`.
-
-```sh
-pyrecli scan templates.dfts
-pyrecli script templates.dfts myplot
-```
-
-If you prefer the templates to be outputted to a single file, use the `--onefile` flag:
-
-```sh
-pyrecli scan templates.dfts
-pyrecli script templates.dfts myplot.py --onefile
-```
-
-For more information about generating scripts, run `pyrecli script -h`.
-

pyrecli-0.2.0/README.md

@@ -1,48 +0,0 @@
-# pyrecli
-
-Command line utilities for DiamondFire templates
-
-## Installation
-
-Run the following command in a terminal:
-
-```sh
-pip install pyrecli
-```
-
-## Commands
-
-- `scan`: Scan all templates on the plot and dump them to a text file (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `send`: Send template items to DiamondFire (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `rename`: Rename all occurences of a variable (including text codes)
-- `script`: Generate python scripts from template data
-- `grabinv`: Save all templates in your Minecraft inventory to a file (requires [CodeClient](github.com/DFOnline/CodeClient))
-- `docs`: Generate markdown documentation from template data
-
-
-## What is this useful for?
-
-- Backing up a plot
-- Getting an accurate text representation of DF code
-- Open sourcing
-- Version control
-- Large scale refactoring
-
-
-## Example Usage
-
-These two commands will scan your plot, convert each template into a python script, then place the scripts into a directory called `myplot`.
-
-```sh
-pyrecli scan templates.dfts
-pyrecli script templates.dfts myplot
-```
-
-If you prefer the templates to be outputted to a single file, use the `--onefile` flag:
-
-```sh
-pyrecli scan templates.dfts
-pyrecli script templates.dfts myplot.py --onefile
-```
-
-For more information about generating scripts, run `pyrecli script -h`.