Skip to main content

Installation

Using PyPI

  1. Make sure to upgrade/install your Python installation to a version >= 3.9 and add it to your PATH while installing.
  2. Run pip install textbase-client.

For the usage of commands through this library, refer to the usage section.

Local installation of the library

Before getting started with the instructions for installing the library locally, make sure that you have done this prerequisite steps:

  1. Fork the repository
  2. Clone the repo
  3. Open the repo in your VS Code
  4. Install the VS Code extension for Python if not already done.

Video guide for Windows

Guide for Windows

  1. Make sure to upgrade/install your Python installation to a version >= 3.9 and add it to your PATH while installing.
  2. Now, you need to install Poetry, which is a python dependency manager which makes your life easier. To do so, you can just run
    pip install poetry
  3. Use the keyboard combo Ctrl + Shift + P and search for Terminal: Select Default Profile and select Command Prompt.
  4. You can open the VS Code terminal using Ctrl + ` and then run the command below in the VSCode terminal inside the folder where you have cloned textbase repo. This makes sure that Poetry makes a virtual environment inside your current directory. This command does not give you any output.
    poetry config virtualenvs.in-project true
  5. poetry shell
  6. Use the keyboard combo Ctrl + Shift + P and select Python: Select Interpreter (you can type this option in if it's not visible) and make sure after running this you have selected the Poetry interpreter. Select interpreter
  7. poetry install to install the required dependencies.

Video guide for Linux (for Ubuntu, version >19.04)

Guide for Linux (for Ubuntu, version >19.04) and MacOS

  1. Make sure to upgrade/install your Python installation to a version >= 3.9 and add it to your PATH while installing.
  2. Now, you need to install Poetry, which is a python dependency manager which makes your life easier. To do so, you can just run
    pip install poetry
  3. Add it to your path using:
    export PATH="$HOME/.local/bin:$PATH"
  4. You can open the VS Code terminal using Ctrl + ` (Mac: + `) and then run the command below in the VSCode terminal inside the folder where you have cloned textbase repo. This makes sure that Poetry makes a virtual environment inside your current directory. This command does not give you any output.
    poetry config virtualenvs.in-project true
  5. poetry shell
  6. Use the keyboard combo Ctrl + Shift + P (Mac: + Shift + P) and select Python: Select Interpreter (you can type this option in if it's not visible) and make sure after running this you have selected the Poetry interpreter. Select interpreter
  7. poetry install to install the required dependencies.

Guide for Ubuntu (≤19.04)

  1. Follow this guide to install Python version 3.9.
  2. Install pip using
    sudo apt install python-pip
  3. Install poetry using
    pip install poetry
  4. Add it to your path using
    export PATH="$HOME/.local/bin:$PATH"
  5. You can open the VS Code terminal using Ctrl + ` (Mac: + `) and then run the command: poetry config virtualenvs.in-project true in the VS Code terminal inside the folder where you have cloned textbase repo so that Poetry makes a .venv folder inside your current project directory. This command does not give you any output.
  6. Running the commands below will make a new virtual Python environment inside the current directory and then you can select the default python interpreter to be the one in the .venv folder.
    cd textbase
    poetry shell
  7. In order to select the default python interpreter in VS Code, Ctrl + Shift + P (Mac: + Shift + P) and select Python: Select Interpreter (you can type this option in if it's not visible) and make sure after running this you have selected the Poetry interpreter. Select interpreter
  8. poetry install to install all the required dependencies.