Skip to content

Changes

Page history
Update Getting started with the toolkit authored by Nick Bywell's avatar Nick Bywell
Hide whitespace changes
Inline Side-by-side
Getting-started-with-the-toolkit.md
View page @ 4e5e5c42
...@@ -24,15 +24,13 @@ If the message returned is "Python 3.10.0" or a higher number, this is a suffici ...@@ -24,15 +24,13 @@ If the message returned is "Python 3.10.0" or a higher number, this is a suffici
![python_install_dialogue_box](uploads/5ab758661944541bc4769a97867a5717/python_install_dialogue_box.png) ![python_install_dialogue_box](uploads/5ab758661944541bc4769a97867a5717/python_install_dialogue_box.png)
If you forgot to tick the box during installation, or Python has already been installed without it having been ticked, follow the instructions given in this document [How_to_add_Python_to_PATH_manually.docx](uploads/40f39542559fcd537ef4bdc73c7df772/How_to_add_Python_to_PATH_manually.docx).
To test whether the installation of Python has been successful, open a command window (type “cmd” in the field where it states “Type here to search” in the bottom-left of the desktop) and at the prompt in the command window that appears, type “python --version”. If the message returned is "Python 3.10.0” or a higher number, Python has been installed successfully. To test whether the installation of Python has been successful, open a command window (type “cmd” in the field where it states “Type here to search” in the bottom-left of the desktop) and at the prompt in the command window that appears, type “python --version”. If the message returned is "Python 3.10.0” or a higher number, Python has been installed successfully.
## 2. Install the Toolkit ## 2. Install the Toolkit
This section is mandatory. This section is mandatory.
Click on the "Source code (zip)" file for the v2.1.0 release from the [GitLab Repository release](https://git.lse.ac.uk/hub/lse_digital_toolkit/-/archive/v2.1.0/lse_digital_toolkit-v2.1.0.zip) and unzip it into a folder close to the root folder of a drive, renaming the extracted folder from "lse_digital_toolkit-v2.1.0" to "lse_digital_toolkit". The reason the path to the folder should be short is because the path forms a component of the command lines via which the scripts are executed, and some operating systems have a limit to the length of a command line. Click on the "Source code (zip)" file for the v2.1.0 release from the [GitLab Repository release](https://git.lse.ac.uk/hub/lse_digital_toolkit/-/archive/v2.1.0) and unzip it into a folder close to the root folder of a drive, renaming the extracted folder from "lse_digital_toolkit-v2.1.0" to "lse_digital_toolkit". The reason the path to the folder should be short is because the path forms a component of the command lines via which the scripts are executed, and some operating systems have a limit to the length of a command line.
For example: For example:
...@@ -105,13 +103,11 @@ A folder hierarchy, equivalent to the one for the “UKLSE” organisation-code ...@@ -105,13 +103,11 @@ A folder hierarchy, equivalent to the one for the “UKLSE” organisation-code
Choose a suitable code for your organisation. The code must consist only of uppercase alphabetic characters (plus hyphens if necessary). For the purposes of this exercise, it is not important that you choose a definitive code at this point because you can always change it later. Choose a suitable code for your organisation. The code must consist only of uppercase alphabetic characters (plus hyphens if necessary). For the purposes of this exercise, it is not important that you choose a definitive code at this point because you can always change it later.
However, if your organisation has a[ UK MARC organisational code](https://www.bl.uk/bibliographic/pdfs/marc-codes-directory.pdf) or an [international code](https://www.loc.gov/marc/organizations/org-search.php), it would be appropriate to use one of these. “UKLSE”, is the UK MARC organisation code for the London School of Economics and Political Science. However, if your organisation has an [international code](https://www.loc.gov/marc/organizations/org-search.php), it would be appropriate to use that. If your organisation does not have such a code, you can just make one up. Although this code is not of a fixed length, it should ideally be from five to eight characters in length. For the London School of Economics and Political Science, the organisation code is "UKLSE".
If your organisation has not been allocated such a code by either of these bodies, you can just make one up. Although this code is not of a fixed length, it should ideally be from five to eight characters in length.
It is not advisable to use a code greater than eight characters because the code will be combined with other elements to form various IDs, and very long IDs can create visual clutter when material is disseminated. It is not advisable to use a code greater than eight characters because the code will be combined with other elements to form various IDs, and very long IDs can create visual clutter when material is disseminated.
Try to ensure that the code hasn’t already been assigned to another organisation. It is a good idea to have your country code at the start of it, in the way that the “UK” is at the start of “UKLSE”. This increases the likelihood that it will be a unique code. Try to ensure that the code hasn’t already been assigned to another organisation. It is a good idea to have your country code at the start of the code, in the way that the “UK” is at the start of “UKLSE”. This increases the likelihood that it will be a unique code.
Create a folder with the name of your code at the same level of the hierarchy as the “UKLSE” folder. Create a folder with the name of your code at the same level of the hierarchy as the “UKLSE” folder.
......