INSTALL.md

Installation Guide

Requirements

• Python 3.11 or higher
• pip (Python package installer)

Installation

From Source (Development)

1. Clone or navigate to the repository:

   cd C:\Users\NotsideRC\Documents\NTSD\2\pbfl\packages\flowfull-clients\flowfull-python

2. Install dependencies:

   pip install -r requirements.txt

3. Install development dependencies (optional):

   pip install -r requirements-dev.txt

4. Install in editable mode:

   pip install -e .

From PyPI (When Published)

pip install flowfull-python

Verify Installation

from core import FlowfullClient

# Create a client
client = FlowfullClient("https://api.example.com")
print("Flowfull-Python Client installed successfully!")

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=core --cov-report=html

# Run specific test file
pytest tests/test_operators.py

Running Examples

# Basic usage examples
python examples/basic_usage.py

# Async usage examples
python examples/async_usage.py

Type Checking

# Run mypy type checker
mypy core

Code Formatting

# Format code with black
black core tests examples

# Check code with ruff
ruff check core tests examples

Troubleshooting

Import Error

If you get an import error, make sure you're in the correct directory and have installed the package:

cd C:\Users\NotsideRC\Documents\NTSD\2\pbfl\packages\flowfull-clients\flowfull-python
pip install -e .

Missing Dependencies

If you're missing dependencies, reinstall them:

pip install -r requirements.txt

Python Version

Make sure you're using Python 3.11 or higher:

python --version

If you have multiple Python versions, use:

python3.11 -m pip install -r requirements.txt

Next Steps

• Read the README.md for usage examples
• Check the documentation for detailed guides
• Run the examples in the examples/ directory
• Explore the test suite in tests/ for more examples

License

This project is licensed under AGPL-3.0-or-later. See LICENSE for details.