Conda, venv, or Docker

This guide is tailored for users of IDEs like VSCode or PyCharm, detailing a straightforward method to get started with the finter library using Conda, venv, or Docker.

Warnings and Recommendations

• JupyterLabs Recommended: For a seamless experience, using Jupyter Hub on the FinterLabs homepage is highly recommended.

• Warning on Submit Pipeline Operation: Model development is currently fully supported. However, be aware that achieving full pipeline operation might encounter compatibility issues in various environments, though support for this is actively being expanded.

Quick Setup

Conda

1. Create Environment: conda create --name finterenv python=3.8

2. Activate: conda activate finterenv

venv

1. Create Environment: python -m venv finterenv

2. Activate:

   • Windows: .\finterenv\Scripts\activate

   • macOS/Linux: source finterenv/bin/activate

Docker (Optional)

• Setup: Docker can be used for containerization, with a Dockerfile specifying Python and the required packages.

Package Installation

With the environment ready, install finter and essential libraries. You can adjust the list to fit your project's needs:

pip install finter # Feel free to add any additional libraries here

Configuration with .env

Create a .env file in your project's root directory for necessary configurations, like API keys:

FINTER_API_KEY=your_api_key_here

Start Developing

Once your setup is complete, you're ready to develop with finter.