Python SDKIntroductory pages

Installation

System Requirements

The NLP API SDK and Python Client requires, at minimum, Python 3.10 (although Python 3.10 is recommended). Any computer that meets the requirements for Python 3.10 or higher can be used.

  • Windows 7 or greater
  • MacOS Mavericks (10.9) or greater
  • Linux system that supports Python 3.10 (recommended: Ubuntu 20.04 or greater)

Please also refer to the Python release documentation.

The NLP API Python Client supports several relational database management systems. PostgreSQL (minimum version 12, 15 recommended) is supported, as well as Snowflake, MySQL, MariaDB, and Microsoft SQL Server.

Hardware requirements

  • Minimum: 1-core, 8 GB RAM, HD
  • Recommended: 2-cores, 16 GB RAM, SSD

In addition, the computer must have connectivity to the Internet and sufficient storage capacity for the customer’s workload requirements. The database client will store the current processing state (including a cache of in-progress documents to a file on disk), so disk space required will be proportional to the number of input documents.

Installing the package

Using pip, you’ll be able to install the .whl package you’ve been provided in the SDK files:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade wheel setuptools
pip install emtellipro-7.2.0-py3-none-any.whl

Now that you’ve installed the package, you should have an emtellipro-db-client executable in your PATH. To ensure that this was installed successfully, you can do a test run to just print out the client version number:

emtellipro-db-client --version

If this is successful, you should see some output that looks like:

emtellipro-db-client, version 7.2.0

Next steps

We suggest that you next go to Database client usage to read about the included database client, emtellipro-db-client and do some initial testing: