Installation

CLI v0.5.2

Current version is only supported on MacOS Ventura 13 or higher and Ubuntu 22.04.

Set the python environment

To install JetrawFS we need a clean environtment and Python installed. For this, we recommend the following steps:

  • Install Miniconda: This will install a base version of Python too. To achieve this please proceed as follows:

    • Download the Miniconda installer for MacOS from the official website.

    • Open the Terminal.

    • Navigate to the location where you downloaded the installer. For example, if the installer is in your Downloads folder, you can navigate there with cd /Downloads.

    • Run the installer. Replace Miniconda3-latest-MacOSX-x86_64.sh with the name of the file you downloaded.

      $ bash Miniconda3-latest-MacOSX-x86_64.sh

  • Close the Terminal and open a new Terminal window to activate the changes. Type in this command to verify the installation :

    $ conda --version

  • Create a new environment with the following command :

    $ conda create -n jfsenv python=3.10

  • Activate the environment with this command:

    $ conda activate jfsenv

Once Python and a the environment has been created and activated, the next step is to install JetrawFS. To do so there are a few options that we propose in the following sections.

Install JetrawFS

There are two main ways to install JetrawFS (explained below): install the wheels which have been previously downloaded or, install with pip directly from source. The first option is recommended for general usage.

Install from a locally downloaded wheel

We suggest to install a locally downloaded wheel by following these steps :

  • Download the wheel from this Nextcloud Link.

  • Pip install from local downloaded wheel

    $ pip install jfs --no-index --find-links path/to/releases/jfs/vx.y.z
# Example
$ pip install jfs --no-index --find-links ./Downloads/v0.5.2

NB: JFS will only be available in the given environment (fsenv in the example above), the user will need to reactivate this environment everytime they open a new terminal.

To check that jfs is correctly installed, type in the terminal the following line to see the current installed versions:

$ jfs --version
> jfs version 0.5.2

Install from code source

Another way to install JetrawFS is with pip from source using the following:

$ pip install jfs@git+ssh://git@github.dotphoton.com/JetrawFS/jetrawfs-sdk-go.git@v0.5.2 --force-reinstall --verbose

The –-verbose flag is optional but it does come handy to see the progress of the install as it can be quite lengthy. The clean environment previously created, jfsenv will require all dependen- cies to be built. If jfs was alreadz installed with the same version, the flag -–force-reinstall can be used to force reinstalling the package.

You will probably get a PermissionError: [Errno 13] Permission denied but you can ignore it for now. To check that jfs is correctly installed, type in the terminal the following line to see the current installed versions:

$ jfs --version
> jfs version 0.5.2