Skip to content

Home

Welcome to the official ConnectX documentation.
This documentation is your complete reference for building, managing, and deploying ETL and data integration engine using the ConnectX platform.

🎯 Goals

  • Provide a clear overview of the ConnectX Core capabilities.
  • Document all available modules, connectors, and methods.
  • Guide developers in creating reliable, maintainable, and performant data flows.
  • Offer a single, up-to-date source of truth for ConnectX development.

📚 What’s Inside

The documentation is organized into several sections:

  • Introduction & Setup → Development environment, Python, PyCharm, and project initialization.
  • Best Practices & Flows → Coding standards, project structure, transform logic, and error handling. Creating ETL jobs, maps, and full job lifecycle management.
  • Core & Data Operations → Documentation of the utilities components (log, read_csv, sftp, …). Available integrations (HubSpot, SugarCRM, Dynamics, SQL, …).
  • Exercises → Python snippets and real-world use cases.
  • Test & Deployment → AWS Batch, Docker images, developer testing, server requirements, and production release.
  • FAQ → Common scenarios, delta processing, parallel execution, and troubleshooting.

🚀 Getting Started

  1. Install ConnectX Core from the internal repository.
  2. Configure your environment:
  3. Dependencies, Python version, and packages.
  4. Credentials and environment variables.
  5. Project folders and workspace setup.
  6. Create your first ETL project from a starter pack or template.
  7. Follow the Quickstart examples to run your first jobs.

🛠 Support

If you run into issues or have questions:

✨ Happy coding with ConnectX!