PyPI - opex-manifest-generator - Versions diffs - 1.3.0__tar.gz → 1.3.2__tar.gz - Mend

opex-manifest-generator 1.3.0tar.gz → 1.3.2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/PKG-INFO RENAMED Viewed

@@ -1,20 +1,23 @@
 Metadata-Version: 2.4
 Name: opex_manifest_generator
-Version: 1.3.0
-Summary: Opex Manifest Generator Tool for use with Opex / Preservica
+Version: 1.3.2
+Summary: An Opex Manifest Generator tool for use with OPEX Files, as designed by Preservica
 Author-email: Christopher Prince <c.pj.prince@gmail.com>
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://github.com/CPJPRINCE/opex_manifest_generator
 Project-URL: Issues, https://github.com/CPJPRINCE/opex_manifest_generator/issues
+Keywords: archiving,archives,digital archiving,opex,Preservica,opex generator
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: auto_classification_generator
+Requires-Dist: auto_reference_generator
 Requires-Dist: pandas
 Requires-Dist: openpyxl
 Requires-Dist: lxml
+Provides-Extra: addex
+Requires-Dist: odfpy; extra == "addex"
 Dynamic: license-file
 # Opex Manifest Generator Tool
@@ -41,7 +44,7 @@ There are a number of features including:
 - OPEX's can be cleared out, for repeated / ease of use.
 - OPEX's can be zipped with the file, for imports use with Starter/UX2/Manual ingest methods.
-The Program also makes use of the Auto Classification Generator, allowing for:
+The Program also makes use of the Auto Reference Generator, allowing for:
 - Reference's can be automatically generated and embedded into the Opex, with assignable prefixes.
 - This can be utilised either in Catalog or Accession modes, or both.
 - Clear and log empty folders.
@@ -50,7 +53,7 @@ The Program also makes use of the Auto Classification Generator, allowing for:
 - Sorting!
 - Keyword assignment!
-A key feature of the program, is that the Auto Class spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
+A key feature of the program, is that the Auto Ref spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
 - Assignment of title, description, and security status fields.
 - Assignment of standard and custom xml metadata templates.
 - These fields are all 'drop-in', so only the fields as they are required need to be added.
@@ -62,7 +65,7 @@ All these features can be combined to create extensive and robust Opex files for
 Python Version 3.8+ is recommended; the program is OS independent and works on Windows, MacOS and Linux.
 The following modules are utilised and installed with the package:
-- auto_classification_generator
+- auto_reference_generator
 - pandas
 - openpyxl
 - lxml
@@ -146,23 +149,23 @@ Hidden files and directories can be included by utilising the `--hidden` option.
 ## Note on 'meta' folders
-Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Classification Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
+Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Reference Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
-## Use with the Auto Classification Generator
+## Use with the Auto Reference Generator
-The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Classification Generator, see [here](https://github.com/CPJPRINCE/auto_classification_generator) for further details.
+The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Reference Generator, see [here](https://github.com/CPJPRINCE/auto_reference_generator) for further details.
 This is built-in to the Opex Manifest Generator and can be utilised to embed identifiers and metadata directly to an Opex or through the use of an Excel spreadsheet or CSV file.
-The Opex Manifest Generator makes use of the auto_class_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_class.exe`.
+The Opex Manifest Generator makes use of the auto_reference_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_ref.exe`.
 ### Identifier Generation
-To generate an auto classification code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
+To generate an auto reference code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
 `opex_generate -c catalog -p "ARCH" C:\Users\Christopher\Downloads`
-This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Class module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
+This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Ref module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
 You can alternatively utilise the "Accession" / running number mode of generating a code using `-c accession` with the prefix "2024". You can also utilise the `--accession-mode` option to determine whether to have a running number for `file, folder, both`.
@@ -176,7 +179,7 @@ You can also combine the generic options, like so: `catalog-generic, accession-g
 ## Use of Input Override option.
-This program also supports utilising an Auto Class spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
+This program also supports utilising an Auto Ref spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
 Using this method XIP Metadata fields can be set on Ingest, including:
@@ -195,9 +198,9 @@ XML metadata template data, from both the default templates and custom templates
 ### XIP metadata - Title, Description and Security Status
-To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_class` tool installed alongside the Opex Generator, like so:
+To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_ref` tool installed alongside the Opex Generator, like so:
-`auto_class -p "ARCH" "C:\Users\Christopher\Downloads"`
+`auto_ref -p "ARCH" "C:\Users\Christopher\Downloads"`
 In the resultant spreadsheet, add in "Title", "Description", and "Security" as new columns. The column headers are case-sensitive and have to match exactly. These fields would then be filled in with the relevant data.
@@ -205,7 +208,7 @@ In the resultant spreadsheet, add in "Title", "Description", and "Security" as n
 Once the cells are filled in with data, run a generation like so: `opex_generate -i "{/path/to/your/spreadsheet.xlsx}" "{/path/to/root/directory}"`
-Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoClass.xlsx" "C:\Users\Christopher\Downloads"`
+Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoRef.xlsx" "C:\Users\Christopher\Downloads"`
 ### Headers Note
@@ -223,7 +226,7 @@ Custom Identifiers can be added by adding the columns: `"Archive_Reference", "Ac
 ![Identifier Screenshot](assets/Identifiers%20Headers.png)
-`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Classification Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
+`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Reference Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
 To add a custom identifier import, do so like: `Identifier:{YourIdentifierName}`, without the curly brackets IE: `Identifier:MyCode`. Multiple identifiers can be added as needed.
@@ -231,17 +234,17 @@ No additional parameter's need to be set in the command line when using Identifi
 ### XIP Metadata - Hashes
-If you utilise the Auto Classification's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
+If you utilise the Auto Reference's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
 ![Hash Screenshot](assets/Hash%20Headers.png)
-*Be aware that interruption / resuming is not currently supported with the Auto Class Tool; also doesn't support multiple hashes*
+*Be aware that interruption / resuming is not currently supported with the Auto Ref Tool; also doesn't support multiple hashes*
 ### XML Metadata - Basic Templates
 DC, MODS, GPDR, and EAD templates are supported alongside installation of the package.
-After exporting an Auto Class spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
+After exporting an Auto Ref spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
 ![XML Headers](assets/XML%20Headers.png)
@@ -284,7 +287,7 @@ The default location will be in the installation path of the program, typically
 After the xml is added to that directory, all that's required is to add the matching column headers into your spreadsheet. You can also utilise `--print-xmls` to obtain this.
-### Additional Information for Auto Classification
+### Additional Information for Auto Reference
 #### SourceID
 A SourceID can also be set by adding a `SourceID` header. The behaviour of this is not fully tested, likely won't be as I don't really utilise SourceIDs in my work :\).
@@ -327,7 +330,7 @@ ALGORITHM_FIELD = Algorithm
 ```
 #### Custom Spreadsheets - Quick Note
-You technically don't have to utilise the AutoClass tool at all. Any old spreadsheet will do!
+You technically don't have to utilise the AutoRef tool at all. Any old spreadsheet will do!
 The only requirement to use the input override, is the presence of the `FullName` column. With an accurate list of paths.
@@ -387,10 +390,10 @@ Options:
         -opt  --options-file    Specify an 'options.properties' file to change set      [PATH/TO/FILE]
                                 presets for column headers for input.
-    Auto Classification Options:
+    Auto Reference Options:
-        -c,  --autoclass        This will utilise the AutoClassification                [{catalog, accession,both,
-                                module to generate an Auto Class spreadsheet.           generic, catalog-generic,
+        -r,  --autoref          This will utilise the auto_reference_generator          [{catalog, accession,both,
+                                module to generate an Auto Ref spreadsheet.             generic, catalog-generic,
                                                                                         accession-generic,
                                 There are several options, {catalog} will generate      both-generic}]
                                 a Archival Reference following; {accession}
@@ -406,13 +409,13 @@ Options:
         --accession-mode        Sets whether to have the running tally be for            {file,folder,both}
                                 files, folders or both,
                                 when utilising the Accession option with
-                                autoclass. Default is file.
+                                autoref. Default is file.
-        -p,   --prefix          Assign a prefix to the Auto Classification,             [PREFIX]
+        -p,   --prefix          Assign a prefix to the Auto Reference,             [PREFIX]
                                 when utilising {both} fill in like:
                                 "catalog-prefix","accession-prefix".
-        -s    --suffix          Assign a suffix to the Auto Classification              [SUFFIX]
+        -s    --suffix          Assign a suffix to the Auto Reference              [SUFFIX]
                                 program. By Default only applies to Files
         --suffix-options        Set the Suffix assignment options                       {apply_to_files, apply_to_folders,
@@ -422,16 +425,16 @@ Options:
                                 Log will bee exported to 'meta' / output folder
         -o,   --output          Set's the output of the 'meta' folder when              [PATH/TO/FOLDER]
-                                utilising AutoClass.
+                                utilising AutoRef.
-        -s,   --start-ref       Sets the starting Reference in the Auto Class           [int]
+        -s,   --start-ref       Sets the starting Reference in the Auto Ref           [int]
                                 process.
-        -i    --input           Set whether to use an Auto Class spreadsheet as an      [PATH/TO/FILE]
+        -i    --input           Set whether to use an Auto Ref spreadsheet as an      [PATH/TO/FILE]
                                 input. The input needs to be the (relative or
                                 absolute) path of the spreadsheet.
-                                This allows for use of the Auto Class spreadsheet
+                                This allows for use of the Auto Ref spreadsheet
                                 to customise the XIP metadata (and custom xml
                                 metadata).
@@ -467,7 +470,7 @@ Options:
         --disable-meta-dir      Will disable the creation of the 'meta' folder.         [boolean flag]
                                 Can also be enabled with output.
-        -ex     --export        Set whether to export any Auto Class generation         [boolean flag]
+        -ex     --export        Set whether to export any Auto Ref generation         [boolean flag]
                                 to a spreadsheet
         -fmt,   --format        Set whether to export as a CSV or XLSX file.            {csv,xlsx}
@@ -530,8 +533,8 @@ Options:
 - ~~Customisable Filtering~~ *Added!*
 - ~~Adjust Accession so the different modes can utilised from Opex.~~ *Added!*
-- ~~Add SourceID as option for use with Auto Class Spreadsheets.~~ *Added!*
-- ~~Allow for multiple Identifier's to be added with Auto Class Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
+- ~~Add SourceID as option for use with Auto Ref Spreadsheets.~~ *Added!*
+- ~~Allow for multiple Identifier's to be added with Auto Ref Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
 - ~~Add an option / make it a default for Metadata XML's to be located in a specified directory rather than in the package.~~ *Added!*
 - Zipping to conform to PAX - Last on the check list; it technically does...
 - In theory, this tool should be compatible with any system that makes use of the OPEX standard... But in theory Communism works, in theory...

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/README.md RENAMED Viewed

@@ -22,7 +22,7 @@ There are a number of features including:
 - OPEX's can be cleared out, for repeated / ease of use.
 - OPEX's can be zipped with the file, for imports use with Starter/UX2/Manual ingest methods.
-The Program also makes use of the Auto Classification Generator, allowing for:
+The Program also makes use of the Auto Reference Generator, allowing for:
 - Reference's can be automatically generated and embedded into the Opex, with assignable prefixes.
 - This can be utilised either in Catalog or Accession modes, or both.
 - Clear and log empty folders.
@@ -31,7 +31,7 @@ The Program also makes use of the Auto Classification Generator, allowing for:
 - Sorting!
 - Keyword assignment!
-A key feature of the program, is that the Auto Class spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
+A key feature of the program, is that the Auto Ref spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
 - Assignment of title, description, and security status fields.
 - Assignment of standard and custom xml metadata templates.
 - These fields are all 'drop-in', so only the fields as they are required need to be added.
@@ -43,7 +43,7 @@ All these features can be combined to create extensive and robust Opex files for
 Python Version 3.8+ is recommended; the program is OS independent and works on Windows, MacOS and Linux.
 The following modules are utilised and installed with the package:
-- auto_classification_generator
+- auto_reference_generator
 - pandas
 - openpyxl
 - lxml
@@ -127,23 +127,23 @@ Hidden files and directories can be included by utilising the `--hidden` option.
 ## Note on 'meta' folders
-Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Classification Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
+Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Reference Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
-## Use with the Auto Classification Generator
+## Use with the Auto Reference Generator
-The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Classification Generator, see [here](https://github.com/CPJPRINCE/auto_classification_generator) for further details.
+The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Reference Generator, see [here](https://github.com/CPJPRINCE/auto_reference_generator) for further details.
 This is built-in to the Opex Manifest Generator and can be utilised to embed identifiers and metadata directly to an Opex or through the use of an Excel spreadsheet or CSV file.
-The Opex Manifest Generator makes use of the auto_class_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_class.exe`.
+The Opex Manifest Generator makes use of the auto_reference_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_ref.exe`.
 ### Identifier Generation
-To generate an auto classification code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
+To generate an auto reference code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
 `opex_generate -c catalog -p "ARCH" C:\Users\Christopher\Downloads`
-This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Class module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
+This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Ref module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
 You can alternatively utilise the "Accession" / running number mode of generating a code using `-c accession` with the prefix "2024". You can also utilise the `--accession-mode` option to determine whether to have a running number for `file, folder, both`.
@@ -157,7 +157,7 @@ You can also combine the generic options, like so: `catalog-generic, accession-g
 ## Use of Input Override option.
-This program also supports utilising an Auto Class spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
+This program also supports utilising an Auto Ref spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
 Using this method XIP Metadata fields can be set on Ingest, including:
@@ -176,9 +176,9 @@ XML metadata template data, from both the default templates and custom templates
 ### XIP metadata - Title, Description and Security Status
-To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_class` tool installed alongside the Opex Generator, like so:
+To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_ref` tool installed alongside the Opex Generator, like so:
-`auto_class -p "ARCH" "C:\Users\Christopher\Downloads"`
+`auto_ref -p "ARCH" "C:\Users\Christopher\Downloads"`
 In the resultant spreadsheet, add in "Title", "Description", and "Security" as new columns. The column headers are case-sensitive and have to match exactly. These fields would then be filled in with the relevant data.
@@ -186,7 +186,7 @@ In the resultant spreadsheet, add in "Title", "Description", and "Security" as n
 Once the cells are filled in with data, run a generation like so: `opex_generate -i "{/path/to/your/spreadsheet.xlsx}" "{/path/to/root/directory}"`
-Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoClass.xlsx" "C:\Users\Christopher\Downloads"`
+Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoRef.xlsx" "C:\Users\Christopher\Downloads"`
 ### Headers Note
@@ -204,7 +204,7 @@ Custom Identifiers can be added by adding the columns: `"Archive_Reference", "Ac
 ![Identifier Screenshot](assets/Identifiers%20Headers.png)
-`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Classification Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
+`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Reference Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
 To add a custom identifier import, do so like: `Identifier:{YourIdentifierName}`, without the curly brackets IE: `Identifier:MyCode`. Multiple identifiers can be added as needed.
@@ -212,17 +212,17 @@ No additional parameter's need to be set in the command line when using Identifi
 ### XIP Metadata - Hashes
-If you utilise the Auto Classification's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
+If you utilise the Auto Reference's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
 ![Hash Screenshot](assets/Hash%20Headers.png)
-*Be aware that interruption / resuming is not currently supported with the Auto Class Tool; also doesn't support multiple hashes*
+*Be aware that interruption / resuming is not currently supported with the Auto Ref Tool; also doesn't support multiple hashes*
 ### XML Metadata - Basic Templates
 DC, MODS, GPDR, and EAD templates are supported alongside installation of the package.
-After exporting an Auto Class spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
+After exporting an Auto Ref spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
 ![XML Headers](assets/XML%20Headers.png)
@@ -265,7 +265,7 @@ The default location will be in the installation path of the program, typically
 After the xml is added to that directory, all that's required is to add the matching column headers into your spreadsheet. You can also utilise `--print-xmls` to obtain this.
-### Additional Information for Auto Classification
+### Additional Information for Auto Reference
 #### SourceID
 A SourceID can also be set by adding a `SourceID` header. The behaviour of this is not fully tested, likely won't be as I don't really utilise SourceIDs in my work :\).
@@ -308,7 +308,7 @@ ALGORITHM_FIELD = Algorithm
 ```
 #### Custom Spreadsheets - Quick Note
-You technically don't have to utilise the AutoClass tool at all. Any old spreadsheet will do!
+You technically don't have to utilise the AutoRef tool at all. Any old spreadsheet will do!
 The only requirement to use the input override, is the presence of the `FullName` column. With an accurate list of paths.
@@ -368,10 +368,10 @@ Options:
         -opt  --options-file    Specify an 'options.properties' file to change set      [PATH/TO/FILE]
                                 presets for column headers for input.
-    Auto Classification Options:
+    Auto Reference Options:
-        -c,  --autoclass        This will utilise the AutoClassification                [{catalog, accession,both,
-                                module to generate an Auto Class spreadsheet.           generic, catalog-generic,
+        -r,  --autoref          This will utilise the auto_reference_generator          [{catalog, accession,both,
+                                module to generate an Auto Ref spreadsheet.             generic, catalog-generic,
                                                                                         accession-generic,
                                 There are several options, {catalog} will generate      both-generic}]
                                 a Archival Reference following; {accession}
@@ -387,13 +387,13 @@ Options:
         --accession-mode        Sets whether to have the running tally be for            {file,folder,both}
                                 files, folders or both,
                                 when utilising the Accession option with
-                                autoclass. Default is file.
+                                autoref. Default is file.
-        -p,   --prefix          Assign a prefix to the Auto Classification,             [PREFIX]
+        -p,   --prefix          Assign a prefix to the Auto Reference,             [PREFIX]
                                 when utilising {both} fill in like:
                                 "catalog-prefix","accession-prefix".
-        -s    --suffix          Assign a suffix to the Auto Classification              [SUFFIX]
+        -s    --suffix          Assign a suffix to the Auto Reference              [SUFFIX]
                                 program. By Default only applies to Files
         --suffix-options        Set the Suffix assignment options                       {apply_to_files, apply_to_folders,
@@ -403,16 +403,16 @@ Options:
                                 Log will bee exported to 'meta' / output folder
         -o,   --output          Set's the output of the 'meta' folder when              [PATH/TO/FOLDER]
-                                utilising AutoClass.
+                                utilising AutoRef.
-        -s,   --start-ref       Sets the starting Reference in the Auto Class           [int]
+        -s,   --start-ref       Sets the starting Reference in the Auto Ref           [int]
                                 process.
-        -i    --input           Set whether to use an Auto Class spreadsheet as an      [PATH/TO/FILE]
+        -i    --input           Set whether to use an Auto Ref spreadsheet as an      [PATH/TO/FILE]
                                 input. The input needs to be the (relative or
                                 absolute) path of the spreadsheet.
-                                This allows for use of the Auto Class spreadsheet
+                                This allows for use of the Auto Ref spreadsheet
                                 to customise the XIP metadata (and custom xml
                                 metadata).
@@ -448,7 +448,7 @@ Options:
         --disable-meta-dir      Will disable the creation of the 'meta' folder.         [boolean flag]
                                 Can also be enabled with output.
-        -ex     --export        Set whether to export any Auto Class generation         [boolean flag]
+        -ex     --export        Set whether to export any Auto Ref generation         [boolean flag]
                                 to a spreadsheet
         -fmt,   --format        Set whether to export as a CSV or XLSX file.            {csv,xlsx}
@@ -511,8 +511,8 @@ Options:
 - ~~Customisable Filtering~~ *Added!*
 - ~~Adjust Accession so the different modes can utilised from Opex.~~ *Added!*
-- ~~Add SourceID as option for use with Auto Class Spreadsheets.~~ *Added!*
-- ~~Allow for multiple Identifier's to be added with Auto Class Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
+- ~~Add SourceID as option for use with Auto Ref Spreadsheets.~~ *Added!*
+- ~~Allow for multiple Identifier's to be added with Auto Ref Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
 - ~~Add an option / make it a default for Metadata XML's to be located in a specified directory rather than in the package.~~ *Added!*
 - Zipping to conform to PAX - Last on the check list; it technically does...
 - In theory, this tool should be compatible with any system that makes use of the OPEX standard... But in theory Communism works, in theory...

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/opex_manifest_generator/cli.py RENAMED Viewed

@@ -31,14 +31,14 @@ def parse_args():
     parser.add_argument("--hidden", required = False, action = 'store_true', default = False,
                         help="Set whether to include hidden files and folders")
     parser.add_argument("-o", "--output", required = False, nargs = 1,
-                        help = "Sets the output to send any generated files (Remove Empty, Fixity List, AutoClass Export) to. Will not affect creation of a meta dir.")
+                        help = "Sets the output to send any generated files (Remove Empty, Fixity List, Autoref Export) to. Will not affect creation of a meta dir.")
     parser.add_argument("-clr", "--clear-opex", required = False, action = 'store_true', default = False,
                         help = """Clears existing opex files from a directory. If set with no further options will only clear opexes;
                         if multiple options are set will clear opexes and then run the program""")
     parser.add_argument("-opt","--options-file", required = False, default=os.path.join(os.path.dirname(__file__),'options','options.properties'),
                         help="Specify a custom Options file, changing the set presets for column headers (Title,Description,etc)")
-    parser.add_argument("--autoclass-options", required = False, default = None,
-                        help="Specify a custom Auto Classification Options file, changing the set presets for Auto Classification generation")
+    parser.add_argument("--autoref-options", required = False, default = None,
+                        help="Specify a custom Auto Reference Options file, changing the set presets for Auto Reference Generator")
     parser.add_argument("--disable-meta-dir", required = False, action = 'store_false',
                         help = """Set whether to disable the creation of a 'meta' directory for generated files,
                         default behaviour is to always generate this directory""")
@@ -56,11 +56,11 @@ def parse_args():
     parser.add_argument("--print-xmls", required = False, action = "store_true", default = False,
                         help="Prints the elements from your xmls to the consoles")
-    # Auto Classification Options
-    parser.add_argument("-c", "--autoclass", required = False,
+    # Auto Reference Options
+    parser.add_argument("-r", "--autoref", required = False,
                         choices = ['catalog', 'c', 'accession', 'a', 'both', 'b', 'generic', 'g', 'catalog-generic', 'cg', "accession-generic", "ag", "both-generic", "bg"],
                         type = str.lower,
-                        help="""Toggles whether to utilise the auto_classification_generator
+                        help="""Toggles whether to utilise the auto_reference_generator
                         to generate an on the fly Reference listing.
                         There are several options, {catalog} will generate
@@ -72,22 +72,22 @@ def parse_args():
                         {generic-catalog,generic-accession, generic-both} it will do both simultaneously.
                         """)
     parser.add_argument("-p", "--prefix", required = False, nargs = '+',
-                        help= """Assign a prefix when utilising the --autoclass option. Prefix will append any text before all generated text.
+                        help= """Assign a prefix when utilising the --autoref option. Prefix will append any text before all generated text.
                         When utilising the {both} option fill in like: [catalog-prefix, accession-prefix] without square brackets.
                         """)
     parser.add_argument("-s", "--suffix", required = False, nargs = '?', default = '',
-                        help= "Assign a suffix when utilising the --autoclass option. Suffix will append any text after all generated text.")
+                        help= "Assign a suffix when utilising the --autoref option. Suffix will append any text after all generated text.")
     parser.add_argument("--suffix-option", required = False, choices= ['apply_to_files','apply_to_folders','apply_to_both'], default = 'apply_to_files',
-                        help = "Set whether to apply the suffix to files, folders or both when utilising the --autoclass option.")
+                        help = "Set whether to apply the suffix to files, folders or both when utilising the --autoref option.")
     parser.add_argument("--accession-mode", nargs = '?', required=False, const='file', default=None, choices=["file",'directory','both'],
-                        help="""Set the mode when utilising the Accession option in autoclass.
+                        help="""Set the mode when utilising the Accession option in autoref.
                         file - only adds on files, folder - only adds on folders, both - adds on files and folders""")
     parser.add_argument("-str", "--start-ref", required = False, nargs = '?', default = 1,
-                        help="Set a custom Starting reference for the Auto Classification generator. The generated reference will")
-    parser.add_argument("-ex", "--export-autoclass", required = False, action = 'store_true', default = False,
-                        help="Set whether to export the generated auto classification references to an AutoClass spreadsheet")
+                        help="Set a custom Starting reference for the Auto Reference Generator. The generated reference will")
+    parser.add_argument("-ex", "--export-autoref", required = False, action = 'store_true', default = False,
+                        help="Set whether to export the generated references to an AutoRef spreadsheet")
     parser.add_argument("-fmt", "--output-format", required = False, default = "xlsx", choices = ['xlsx', 'csv','json','ods','xml'],
-                        help="Set whether to export AutoClass Spreadsheet to: xlsx, csv, json, ods or xml format")
+                        help="Set whether to export AutoRef Spreadsheet to: xlsx, csv, json, ods or xml format")
     parser.add_argument("-dlm", "--delimiter", required=False,nargs = '?', type = str, default = '/',
                         help="Set a custom delimiter for generated references, default is '/'")
     parser.add_argument("-key","--keywords", nargs = '*', default = None,
@@ -119,8 +119,8 @@ def run_cli():
     else:
         args.output = os.path.abspath(args.output[0])
         print(f'Output path set to: {args.output}')
-    if args.input and args.autoclass:
-        print(f'Both Input and Auto-Class options have been selected, please use only one...')
+    if args.input and args.autoref:
+        print(f'Both Input and Auto ref options have been selected, please use only one...')
         time.sleep(5); raise SystemExit()
     if args.remove and not args.input:
         print('Removal flag has been given without input, please ensure an input file is utilised when using this option.')
@@ -131,10 +131,10 @@ def run_cli():
     if args.print_xmls:
         OpexManifestGenerator(root = args.root, metadata_dir=args.metadata_dir).print_descriptive_xmls()
     acc_prefix = None
-    if args.autoclass in {"accession", "a", "accession-generic", "ag", "both", "b", "both-generic", "bg"} and args.accession_mode is None:
+    if args.autoref in {"accession", "a", "accession-generic", "ag", "both", "b", "both-generic", "bg"} and args.accession_mode is None:
             args.accession_mode = "file"
     if args.prefix:
-        if args.autoclass in {"both", "b", "both-generic", "bg"}:
+        if args.autoref in {"both", "b", "both-generic", "bg"}:
             if len(args.prefix) < 2 or len(args.prefix) > 2:
                 print('"Both" option is selected, please pass only two prefixes: [-p CATALOG_PREFIX ACCESSION_PREFIX]');
                 time.sleep(3); raise SystemExit
@@ -144,16 +144,16 @@ def run_cli():
                 elif n == 1:
                     acc_prefix = str(a)
             print(f"Prefixes are set as: \t Catalog: {args.prefix} \t Acc: {acc_prefix}")
-        elif args.autoclass in {"accession", "a", "accession-generic", "ag"}:
+        elif args.autoref in {"accession", "a", "accession-generic", "ag"}:
             for a in args.prefix:
                 acc_prefix = str(a)
             print('Prefix is set as: ' + acc_prefix)
-        elif args.autoclass in {"catalog", "c", "catalog-generic", "cg"}:
+        elif args.autoref in {"catalog", "c", "catalog-generic", "cg"}:
             acc_prefix = None
             for a in args.prefix:
                 args.prefix = str(a)
             print('Prefix is set as: ' + args.prefix)
-        elif args.autoclass in {"generic", "g"}:
+        elif args.autoref in {"generic", "g"}:
             pass
         else:
             print('''An invalid option has been selected, please select a valid option:
@@ -187,7 +187,7 @@ def run_cli():
     time.sleep(3)
     OpexManifestGenerator(root = args.root,
                           output_path = args.output,
-                          autoclass_flag = args.autoclass,
+                          autoref_flag = args.autoref,
                           prefix = args.prefix,
                           accession_mode=args.accession_mode,
                           acc_prefix = acc_prefix,
@@ -198,7 +198,7 @@ def run_cli():
                           pax_fixity= args.pax_fixity,
                           fixity_export_flag = args.fixity_export,
                           start_ref = args.start_ref,
-                          export_flag = args.export_autoclass,
+                          export_flag = args.export_autoref,
                           meta_dir_flag = args.disable_meta_dir,
                           metadata_flag = args.metadata,
                           metadata_dir = args.metadata_dir,

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/opex_manifest_generator/opex_manifest.py RENAMED Viewed

@@ -10,8 +10,8 @@ license: Apache License 2.0"
 import lxml.etree as ET
 import pandas as pd
 import os, time, datetime
-from auto_classification_generator import ClassificationGenerator
-from auto_classification_generator.common import export_list_txt, export_xl, export_csv, export_json, export_ods, export_xml,define_output_file
+from auto_reference_generator import ReferenceGenerator
+from auto_reference_generator.common import export_list_txt, export_xl, export_csv, export_json, export_ods, export_xml,define_output_file
 from pandas.api.types import is_datetime64_any_dtype
 from opex_manifest_generator.hash import HashGenerator
 from opex_manifest_generator.common import *
@@ -26,18 +26,18 @@ class OpexManifestGenerator():
     :param meta_dir_flag: set whether to generate a 'meta' directory
     :param metadata_flag: set whether to incorporate metadata into opex
     :param metadata_dir: set the metadata directory to pull xml data from
-    :param autoclass_flag: set whether to generate an auto classification reference using auto_class. Has a number of 'modes' {catalog, accession, both, generic}
+    :param autoref_flag: set whether to generate an auto reference reference using autoref. Has a number of 'modes' {catalog, accession, both, generic}
     :param prefix: set a prefix to append to generated references
-    :param accession_mode: if using accession in autoclass_flag set the mode to count {file, folder, both}
+    :param accession_mode: if using accession in autoref_flag set the mode to count {file, folder, both}
     :param acc_prefix: set an accession prefix
     :param start_ref: set to set the starting reference number
     :param algorithm: set whether to generate fixities and the algorithm to use {MD5, SHA-1, SHA-256, SHA-512}
     :param empty_flag: set whether to delete and log empty directories
     :param removal_flag: set whether to enable removals; data must also contain removals column and cell be set to True
     :param clear_opex_flag: set whether clear existing opexes
-    :param export_flag: set whether to export the spreadsheet when using autoclass
-    :param output_format: set output format when using autoclass {xlsx, csv}
-    :param input: set whether to use an AutoClass spreadsheet / dataframe to establish data.
+    :param export_flag: set whether to export the spreadsheet when using autoref
+    :param output_format: set output format when using autoref {xlsx, csv,ods,json,lxml}
+    :param input: set whether to use an autoref spreadsheet / dataframe to establish data.
     :param zip_flag: set whether to zip files and opexes together
     :param hidden_flag: set to include hidden files/directories
     :param print_xmls_flag: set to print all
@@ -54,7 +54,7 @@ class OpexManifestGenerator():
                  meta_dir_flag: bool = True,
                  metadata_dir: str = os.path.join(os.path.dirname(os.path.realpath(__file__)), "metadata"),
                  metadata_flag: str = 'none',
-                 autoclass_flag: str = None,
+                 autoref_flag: str = None,
                  prefix: str = None,
                  suffix: str = None,
                  suffix_option: str|None = 'apply_to_files',
@@ -81,7 +81,7 @@ class OpexManifestGenerator():
                  keywords_abbreviation_number: int = 3,
                  sort_key = lambda x: (os.path.isfile(x), str.casefold(x)),
                  delimiter = "/",
-                 autoclass_options: str|None = None) -> None:
+                 autoref_options: str|None = None) -> None:
         self.root = os.path.abspath(root)
         # Base Parameters
@@ -111,9 +111,9 @@ class OpexManifestGenerator():
         self.metadata_dir = metadata_dir
         self.print_xmls_flag = print_xmls_flag
-        # Parameters for Auto Classification
-        self.autoclass_flag = autoclass_flag
-        self.autoclass_options = autoclass_options
+        # Parameters for Auto Reference
+        self.autoref_flag = autoref_flag
+        self.autoref_options = autoref_options
         self.prefix = prefix
         self.suffix = suffix
         self.suffix_option = suffix_option
@@ -214,8 +214,8 @@ class OpexManifestGenerator():
             time.sleep(3)
     def init_df(self) -> None:
-        if self.autoclass_flag:
-            ac = ClassificationGenerator(self.root,
+        if self.autoref_flag:
+            ac = ReferenceGenerator(self.root,
                                             output_path = self.output_path,
                                             prefix = self.prefix,
                                             accprefix = self.acc_prefix,
@@ -234,7 +234,7 @@ class OpexManifestGenerator():
                                             options_file = os.path.join(os.path.dirname(__file__),'options','options.properties')
                                             )
             self.df = ac.init_dataframe()
-            if self.autoclass_flag in {"accession", "a", "accession-generic", "ag"}:
+            if self.autoref_flag in {"accession", "a", "accession-generic", "ag"}:
                 self.df = self.df.drop(ARCREF_FIELD, axis=1)
             self.column_headers = self.df.columns.values.tolist()
             self.set_input_flags()
@@ -277,7 +277,7 @@ class OpexManifestGenerator():
                     print(f'Cleared Opex: {file_path}')
     def index_df_lookup(self, path: str) -> pd.Index:
-        idx = self.df[INDEX_FIELD].index[self.df[INDEX_FIELD] == path]
+        idx = self.df.loc[self.df[INDEX_FIELD ==path], INDEX_FIELD].index
         return idx
     def xip_df_lookup(self, idx: pd.Index) -> tuple:
@@ -289,11 +289,11 @@ class OpexManifestGenerator():
                 pass
             else:
                 if self.title_flag:
-                    title = check_nan(self.df[TITLE_FIELD].loc[idx].item())
+                    title = check_nan(self.df.loc[idx,TITLE_FIELD].item())
                 if self.description_flag:
-                    description = check_nan(self.df[DESCRIPTION_FIELD].loc[idx].item())
+                    description = check_nan(self.df.loc[idx,DESCRIPTION_FIELD].item())
                 if self.security_flag:
-                    security = check_nan(self.df[SECURITY_FIELD].loc[idx].item())
+                    security = check_nan(self.df.loc[idx,SECURITY_FIELD].item())
             return title,description,security
         except Exception as e:
             print('Error Looking up XIP Metadata')
@@ -304,7 +304,7 @@ class OpexManifestGenerator():
             if idx.empty:
                 return False
             else:
-                remove = check_nan(self.df[REMOVAL_FIELD].loc[idx].item())
+                remove = check_nan(self.df.loc[idx,REMOVAL_FIELD].item())
                 if remove is not None:
                     return True
                 else:
@@ -318,7 +318,7 @@ class OpexManifestGenerator():
             if idx.empty:
                 return False
             else:
-                ignore = check_nan(self.df[IGNORE_FIELD].loc[idx].item())
+                ignore = check_nan(self.df.loc[idx,IGNORE_FIELD].item())
             return bool(ignore)
         except Exception as e:
             print('Error looking up Ignore')
@@ -329,7 +329,7 @@ class OpexManifestGenerator():
             if idx.empty:
                 pass
             else:
-                sourceid = check_nan(self.df[SOURCEID_FIELD].loc[idx].item())
+                sourceid = check_nan(self.df.loc[idx,SOURCEID_FIELD].item())
                 if sourceid:
                     source_xml = ET.SubElement(xml_element,f"{{{self.opexns}}}SourceID")
                     source_xml.text = str(sourceid)
@@ -344,8 +344,8 @@ class OpexManifestGenerator():
             else:
                 for algorithm_type in self.algorithm:
                     self.fixity = ET.SubElement(xml_fixities,f"{{{self.opexns}}}Fixity")
-                    self.hash = self.df[HASH_FIELD].loc[idx].item()
-                    self.algorithm = self.df[ALGORITHM_FIELD].loc[idx].item()
+                    self.hash = self.df.loc[idx,HASH_FIELD].item()
+                    self.algorithm = self.df.loc[idx,ALGORITHM_FIELD].item()
                     self.fixity.set('type', algorithm_type)
                     self.fixity.set('value',self.hash)
         except Exception as e:
@@ -370,7 +370,7 @@ class OpexManifestGenerator():
                             key_name = ACCREF_CODE
                         else:
                             key_name = IDENTIFIER_DEFAULT
-                        ident = check_nan(self.df[header].loc[idx].item())
+                        ident = check_nan(self.df.loc[idx,header].item())
                         if ident:
                             self.identifier = ET.SubElement(self.identifiers, f"{{{self.opexns}}}Identifier")
                             self.identifier.set("type", key_name)
@@ -431,10 +431,10 @@ class OpexManifestGenerator():
                         ns = elem_dict.get('Namespace')
                         try:
                             if self.metadata_flag in {'e', 'exact'}:
-                                val_series = self.df[path].loc[idx]
+                                val_series = self.df.loc[idx,path]
                                 val = check_nan(val_series.item())
                             elif self.metadata_flag in {'f', 'flat'}:
-                                val_series = self.df[name].loc[idx]
+                                val_series = self.df.loc[idx,name]
                                 val = check_nan(val_series.item())
                             if val is None:
                                 continue
@@ -476,7 +476,7 @@ class OpexManifestGenerator():
         if security:
             self.securityxml = ET.SubElement(self.properties, f"{{{self.opexns}}}SecurityDescriptor")
             self.securityxml.text = str(security)
-        if self.autoclass_flag not in {"generic", "g"} or self.input:
+        if self.autoref_flag not in {"generic", "g"} or self.input:
             self.identifiers = ET.SubElement(self.properties, f"{{{self.opexns}}}Identifiers")
             self.ident_df_lookup(idx)
         if self.properties is None:
@@ -512,15 +512,15 @@ class OpexManifestGenerator():
         print(f"Start time: {self.start_time}")
         if self.clear_opex_flag:
             self.clear_opex()
-            if self.autoclass_flag or self.algorithm or self.input:
+            if self.autoref_flag or self.algorithm or self.input:
                 pass
             else:
                 print_running_time(self.start_time)
                 print('Cleared OPEXES. No additional arguments passed, so ending program.'); time.sleep(3)
                 raise SystemExit()
         if self.empty_flag:
-            ClassificationGenerator(self.root, self.output_path, meta_dir_flag = self.meta_dir_flag).remove_empty_directories()
-        if not self.autoclass_flag in {"g", "generic"}:
+            ReferenceGenerator(self.root, self.output_path, meta_dir_flag = self.meta_dir_flag).remove_empty_directories()
+        if not self.autoref_flag in {"g", "generic"}:
             self.init_df()
         self.count = 1
         if not self.metadata_flag in {'none', 'n'}:
@@ -545,7 +545,7 @@ class OpexDir(OpexManifestGenerator):
         else:
             self.folder_path = folder_path
         if any([self.OMG.input,
-                self.OMG.autoclass_flag in {"c","catalog","a","accession","b","both","cg","catalog-generic","ag","accession-generic","bg","both-generic"},
+                self.OMG.autoref_flag in {"c","catalog","a","accession","b","both","cg","catalog-generic","ag","accession-generic","bg","both-generic"},
                 self.OMG.ignore_flag,
                 self.OMG.removal_flag,
                 self.OMG.sourceid_flag,
@@ -553,7 +553,7 @@ class OpexDir(OpexManifestGenerator):
                 self.OMG.description_flag,
                 self.OMG.security_flag]):
                 index = self.OMG.index_df_lookup(self.folder_path)
-        elif self.OMG.autoclass_flag in {None, "g","generic"}:
+        elif self.OMG.autoref_flag in {None, "g","generic"}:
             index = None
         else:
             index = None
@@ -575,7 +575,7 @@ class OpexDir(OpexManifestGenerator):
         self.files = ET.SubElement(self.manifest, f"{{{self.opexns}}}Files")
         if self.OMG.title_flag or self.OMG.description_flag or self.OMG.security_flag:
             self.title, self.description, self.security = self.OMG.xip_df_lookup(index)
-        elif self.OMG.autoclass_flag in {"generic", "g", "catalog-generic", "cg", "accession-generic", "ag", "both-generic", "bg"}:
+        elif self.OMG.autoref_flag in {"generic", "g", "catalog-generic", "cg", "accession-generic", "ag", "both-generic", "bg"}:
             if title is not None:
                 self.title = title
             else:
@@ -608,7 +608,7 @@ class OpexDir(OpexManifestGenerator):
                     file.set("type", "content")
                     file.set("size", str(os.path.getsize(abs_file)))
                     file.text = str(rel_file)
-        if self.OMG.autoclass_flag or self.OMG.input:
+        if self.OMG.autoref_flag or self.OMG.input:
             self.OMG.generate_opex_properties(self.xmlroot, index,
                                               title = self.title,
                                               description = self.description,
@@ -710,7 +710,7 @@ class OpexFile(OpexManifestGenerator):
             self.file_path = file_path
         if check_opex(self.file_path):
             if any([self.OMG.input,
-                    self.OMG.autoclass_flag in {"c","catalog","a","accession","b","both","cg","catalog-generic","ag","accession-generic","bg","both-generic"},
+                    self.OMG.autoref_flag in {"c","catalog","a","accession","b","both","cg","catalog-generic","ag","accession-generic","bg","both-generic"},
                     self.OMG.ignore_flag,
                     self.OMG.removal_flag,
                     self.OMG.sourceid_flag,
@@ -718,7 +718,7 @@ class OpexFile(OpexManifestGenerator):
                     self.OMG.description_flag,
                     self.OMG.security_flag]):
                     index = self.OMG.index_df_lookup(self.file_path)
-            elif self.OMG.autoclass_flag is None or self.OMG.autoclass_flag in {"g","generic"}:
+            elif self.OMG.autoref_flag is None or self.OMG.autoref_flag in {"g","generic"}:
                 index = None
             else:
                 index = None
@@ -734,7 +734,7 @@ class OpexFile(OpexManifestGenerator):
                     return
             if self.OMG.title_flag or self.OMG.description_flag or self.OMG.security_flag:
                 self.title, self.description, self.security = self.OMG.xip_df_lookup(index)
-            elif self.OMG.autoclass_flag in {"generic", "g", "catalog-generic", "cg", "accession-generic", "ag", "both-generic", "bg"}:
+            elif self.OMG.autoref_flag in {"generic", "g", "catalog-generic", "cg", "accession-generic", "ag", "both-generic", "bg"}:
                 if title is not None:
                     self.title = title
                 else:
@@ -751,7 +751,7 @@ class OpexFile(OpexManifestGenerator):
                 self.title = title
                 self.description = description
                 self.security = security
-            if self.OMG.algorithm or self.OMG.autoclass_flag or self.OMG.input:
+            if self.OMG.algorithm or self.OMG.autoref_flag or self.OMG.input:
                 self.xmlroot = ET.Element(f"{{{self.opexns}}}OPEXMetadata", nsmap={"opex":self.opexns})
                 self.transfer = ET.SubElement(self.xmlroot, f"{{{self.opexns}}}Transfer")
                 if self.OMG.sourceid_flag:
@@ -767,7 +767,7 @@ class OpexFile(OpexManifestGenerator):
                             self.generate_opex_fixity(self.file_path)
                 if self.transfer is None:
                     self.xmlroot.remove(self.transfer)
-                if self.OMG.autoclass_flag or self.OMG.input:
+                if self.OMG.autoref_flag or self.OMG.input:
                     self.OMG.generate_opex_properties(self.xmlroot, index,
                                                       title = self.title,
                                                       description = self.description,

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/opex_manifest_generator.egg-info/PKG-INFO RENAMED Viewed

@@ -1,20 +1,23 @@
 Metadata-Version: 2.4
 Name: opex_manifest_generator
-Version: 1.3.0
-Summary: Opex Manifest Generator Tool for use with Opex / Preservica
+Version: 1.3.2
+Summary: An Opex Manifest Generator tool for use with OPEX Files, as designed by Preservica
 Author-email: Christopher Prince <c.pj.prince@gmail.com>
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://github.com/CPJPRINCE/opex_manifest_generator
 Project-URL: Issues, https://github.com/CPJPRINCE/opex_manifest_generator/issues
+Keywords: archiving,archives,digital archiving,opex,Preservica,opex generator
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: auto_classification_generator
+Requires-Dist: auto_reference_generator
 Requires-Dist: pandas
 Requires-Dist: openpyxl
 Requires-Dist: lxml
+Provides-Extra: addex
+Requires-Dist: odfpy; extra == "addex"
 Dynamic: license-file
 # Opex Manifest Generator Tool
@@ -41,7 +44,7 @@ There are a number of features including:
 - OPEX's can be cleared out, for repeated / ease of use.
 - OPEX's can be zipped with the file, for imports use with Starter/UX2/Manual ingest methods.
-The Program also makes use of the Auto Classification Generator, allowing for:
+The Program also makes use of the Auto Reference Generator, allowing for:
 - Reference's can be automatically generated and embedded into the Opex, with assignable prefixes.
 - This can be utilised either in Catalog or Accession modes, or both.
 - Clear and log empty folders.
@@ -50,7 +53,7 @@ The Program also makes use of the Auto Classification Generator, allowing for:
 - Sorting!
 - Keyword assignment!
-A key feature of the program, is that the Auto Class spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
+A key feature of the program, is that the Auto Ref spreadsheet can also act as an input, meaning you can utilise the generated spreadsheet to assign metadata to your files and folders. Currently this allows:
 - Assignment of title, description, and security status fields.
 - Assignment of standard and custom xml metadata templates.
 - These fields are all 'drop-in', so only the fields as they are required need to be added.
@@ -62,7 +65,7 @@ All these features can be combined to create extensive and robust Opex files for
 Python Version 3.8+ is recommended; the program is OS independent and works on Windows, MacOS and Linux.
 The following modules are utilised and installed with the package:
-- auto_classification_generator
+- auto_reference_generator
 - pandas
 - openpyxl
 - lxml
@@ -146,23 +149,23 @@ Hidden files and directories can be included by utilising the `--hidden` option.
 ## Note on 'meta' folders
-Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Classification Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
+Meta folders will be generated automatically when used with the `--fixity` and `-rme` options, as well as when some options from the Auto Reference Generator. You can redirect the path of the generated folder using the `-o` option: `-fx -o {/path/to/meta/output}`. Or you can also disable the generation of 'meta' folder using the `-dmd` option.
-## Use with the Auto Classification Generator
+## Use with the Auto Reference Generator
-The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Classification Generator, see [here](https://github.com/CPJPRINCE/auto_classification_generator) for further details.
+The Opex Manifest generator becomes much more powerful when utilised with another tool: the Auto Reference Generator, see [here](https://github.com/CPJPRINCE/auto_reference_generator) for further details.
 This is built-in to the Opex Manifest Generator and can be utilised to embed identifiers and metadata directly to an Opex or through the use of an Excel spreadsheet or CSV file.
-The Opex Manifest Generator makes use of the auto_class_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_class.exe`.
+The Opex Manifest Generator makes use of the auto_reference_generator as a module, therefore it's behaviour differs a little different when compared to utilising the standalone command `auto_ref.exe`.
 ### Identifier Generation
-To generate an auto classification code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
+To generate an auto reference code, call on `-c` option with `catalog` choice. You can also assign a prefix using `-p "ARCH"`:
 `opex_generate -c catalog -p "ARCH" C:\Users\Christopher\Downloads`
-This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Class module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
+This will generate Opex's with an identifier `code` for each of the files / folders. As described in the Auto Ref module, the reference codes will take the hierarchy of the directories. You can also use the `-s` option to set a starting reference.
 You can alternatively utilise the "Accession" / running number mode of generating a code using `-c accession` with the prefix "2024". You can also utilise the `--accession-mode` option to determine whether to have a running number for `file, folder, both`.
@@ -176,7 +179,7 @@ You can also combine the generic options, like so: `catalog-generic, accession-g
 ## Use of Input Override option.
-This program also supports utilising an Auto Class spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
+This program also supports utilising an Auto Ref spreadsheet as an 'input override', utilising the data added into said spreadsheet instead of generating them ad hoc like above.
 Using this method XIP Metadata fields can be set on Ingest, including:
@@ -195,9 +198,9 @@ XML metadata template data, from both the default templates and custom templates
 ### XIP metadata - Title, Description and Security Status
-To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_class` tool installed alongside the Opex Generator, like so:
+To use an input override, we need to first create a spreadsheet with the path of. You can utilise the `auto_ref` tool installed alongside the Opex Generator, like so:
-`auto_class -p "ARCH" "C:\Users\Christopher\Downloads"`
+`auto_ref -p "ARCH" "C:\Users\Christopher\Downloads"`
 In the resultant spreadsheet, add in "Title", "Description", and "Security" as new columns. The column headers are case-sensitive and have to match exactly. These fields would then be filled in with the relevant data.
@@ -205,7 +208,7 @@ In the resultant spreadsheet, add in "Title", "Description", and "Security" as n
 Once the cells are filled in with data, run a generation like so: `opex_generate -i "{/path/to/your/spreadsheet.xlsx}" "{/path/to/root/directory}"`
-Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoClass.xlsx" "C:\Users\Christopher\Downloads"`
+Ensure that the root directory matches the original directory of the export. In the above case this would be: `opex_generate -i "C:\Users\Christopher\Downloads\meta\Downloads_AutoRef.xlsx" "C:\Users\Christopher\Downloads"`
 ### Headers Note
@@ -223,7 +226,7 @@ Custom Identifiers can be added by adding the columns: `"Archive_Reference", "Ac
 ![Identifier Screenshot](assets/Identifiers%20Headers.png)
-`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Classification Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
+`Archive_Reference` or `Identifier` will default to the keyname `code`; `Accession_Reference` will default to `accref`. When using the Auto Reference Generator it will always generate a column called `Archive_Reference`, but you can simply rename or remove this column as necessary.
 To add a custom identifier import, do so like: `Identifier:{YourIdentifierName}`, without the curly brackets IE: `Identifier:MyCode`. Multiple identifiers can be added as needed.
@@ -231,17 +234,17 @@ No additional parameter's need to be set in the command line when using Identifi
 ### XIP Metadata - Hashes
-If you utilise the Auto Classification's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
+If you utilise the Auto Reference's tool for generating Hashes; when utilising the `-fx` option in combination with `-i`, if both the columns `Hash` and `Algorithm` are present, the program will read the hashes from the spreadsheet instead of generating them.
 ![Hash Screenshot](assets/Hash%20Headers.png)
-*Be aware that interruption / resuming is not currently supported with the Auto Class Tool; also doesn't support multiple hashes*
+*Be aware that interruption / resuming is not currently supported with the Auto Ref Tool; also doesn't support multiple hashes*
 ### XML Metadata - Basic Templates
 DC, MODS, GPDR, and EAD templates are supported alongside installation of the package.
-After exporting an Auto Class spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
+After exporting an Auto Ref spreadsheet, you can add in additional columns to the spreadsheet and fill it out with data for an import. Like the XIP data, all fields are optional, and can added on a 'drop-in' basis.
 ![XML Headers](assets/XML%20Headers.png)
@@ -284,7 +287,7 @@ The default location will be in the installation path of the program, typically
 After the xml is added to that directory, all that's required is to add the matching column headers into your spreadsheet. You can also utilise `--print-xmls` to obtain this.
-### Additional Information for Auto Classification
+### Additional Information for Auto Reference
 #### SourceID
 A SourceID can also be set by adding a `SourceID` header. The behaviour of this is not fully tested, likely won't be as I don't really utilise SourceIDs in my work :\).
@@ -327,7 +330,7 @@ ALGORITHM_FIELD = Algorithm
 ```
 #### Custom Spreadsheets - Quick Note
-You technically don't have to utilise the AutoClass tool at all. Any old spreadsheet will do!
+You technically don't have to utilise the AutoRef tool at all. Any old spreadsheet will do!
 The only requirement to use the input override, is the presence of the `FullName` column. With an accurate list of paths.
@@ -387,10 +390,10 @@ Options:
         -opt  --options-file    Specify an 'options.properties' file to change set      [PATH/TO/FILE]
                                 presets for column headers for input.
-    Auto Classification Options:
+    Auto Reference Options:
-        -c,  --autoclass        This will utilise the AutoClassification                [{catalog, accession,both,
-                                module to generate an Auto Class spreadsheet.           generic, catalog-generic,
+        -r,  --autoref          This will utilise the auto_reference_generator          [{catalog, accession,both,
+                                module to generate an Auto Ref spreadsheet.             generic, catalog-generic,
                                                                                         accession-generic,
                                 There are several options, {catalog} will generate      both-generic}]
                                 a Archival Reference following; {accession}
@@ -406,13 +409,13 @@ Options:
         --accession-mode        Sets whether to have the running tally be for            {file,folder,both}
                                 files, folders or both,
                                 when utilising the Accession option with
-                                autoclass. Default is file.
+                                autoref. Default is file.
-        -p,   --prefix          Assign a prefix to the Auto Classification,             [PREFIX]
+        -p,   --prefix          Assign a prefix to the Auto Reference,             [PREFIX]
                                 when utilising {both} fill in like:
                                 "catalog-prefix","accession-prefix".
-        -s    --suffix          Assign a suffix to the Auto Classification              [SUFFIX]
+        -s    --suffix          Assign a suffix to the Auto Reference              [SUFFIX]
                                 program. By Default only applies to Files
         --suffix-options        Set the Suffix assignment options                       {apply_to_files, apply_to_folders,
@@ -422,16 +425,16 @@ Options:
                                 Log will bee exported to 'meta' / output folder
         -o,   --output          Set's the output of the 'meta' folder when              [PATH/TO/FOLDER]
-                                utilising AutoClass.
+                                utilising AutoRef.
-        -s,   --start-ref       Sets the starting Reference in the Auto Class           [int]
+        -s,   --start-ref       Sets the starting Reference in the Auto Ref           [int]
                                 process.
-        -i    --input           Set whether to use an Auto Class spreadsheet as an      [PATH/TO/FILE]
+        -i    --input           Set whether to use an Auto Ref spreadsheet as an      [PATH/TO/FILE]
                                 input. The input needs to be the (relative or
                                 absolute) path of the spreadsheet.
-                                This allows for use of the Auto Class spreadsheet
+                                This allows for use of the Auto Ref spreadsheet
                                 to customise the XIP metadata (and custom xml
                                 metadata).
@@ -467,7 +470,7 @@ Options:
         --disable-meta-dir      Will disable the creation of the 'meta' folder.         [boolean flag]
                                 Can also be enabled with output.
-        -ex     --export        Set whether to export any Auto Class generation         [boolean flag]
+        -ex     --export        Set whether to export any Auto Ref generation         [boolean flag]
                                 to a spreadsheet
         -fmt,   --format        Set whether to export as a CSV or XLSX file.            {csv,xlsx}
@@ -530,8 +533,8 @@ Options:
 - ~~Customisable Filtering~~ *Added!*
 - ~~Adjust Accession so the different modes can utilised from Opex.~~ *Added!*
-- ~~Add SourceID as option for use with Auto Class Spreadsheets.~~ *Added!*
-- ~~Allow for multiple Identifier's to be added with Auto Class Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
+- ~~Add SourceID as option for use with Auto Ref Spreadsheets.~~ *Added!*
+- ~~Allow for multiple Identifier's to be added with Auto Ref Spreadsheets. Currently only 1 or 2 identifiers can be added at a time, under "Archive_Reference" or "Accession_Reference". These are also tied to be either "code" or "accref". An Option needs to be added to allow custom setting of identifier...~~ *Added!*
 - ~~Add an option / make it a default for Metadata XML's to be located in a specified directory rather than in the package.~~ *Added!*
 - Zipping to conform to PAX - Last on the check list; it technically does...
 - In theory, this tool should be compatible with any system that makes use of the OPEX standard... But in theory Communism works, in theory...

opex_manifest_generator-1.3.2/opex_manifest_generator.egg-info/requires.txt ADDED Viewed

@@ -0,0 +1,7 @@
+auto_reference_generator
+pandas
+openpyxl
+lxml
+[addex]
+odfpy

{opex_manifest_generator-1.3.0 → opex_manifest_generator-1.3.2}/pyproject.toml RENAMED Viewed

@@ -4,19 +4,26 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "opex_manifest_generator"
-version = "1.3.0"
+version = "1.3.2"
 authors = [
     {name="Christopher Prince", email="c.pj.prince@gmail.com"}
     ]
-description = "Opex Manifest Generator Tool for use with Opex / Preservica"
+description = "An Opex Manifest Generator tool for use with OPEX Files, as designed by Preservica"
 readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*"]
+keywords = ["archiving","archives","digital archiving","opex","Preservica","opex generator"]
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
     "Topic :: System :: Archiving"
     ]
-dependencies=["auto_classification_generator","pandas","openpyxl","lxml"]
+dependencies=["auto_reference_generator","pandas","openpyxl","lxml"]
+[project.optional-dependencies]
+addex = ["odfpy"]
 [project.urls]
 Homepage = "https://github.com/CPJPRINCE/opex_manifest_generator"
 Issues = "https://github.com/CPJPRINCE/opex_manifest_generator/issues"