Sicarator is a powerful Command Line Interface (CLI) generator designed specifically for Data Science projects. Built on Yeoman and maintained by Sicara, it offers a seamless experience in setting up your data projects with high quality. Let’s explore how to quickly get started with Sicarator.

Main Components of the Generated Project

The Sicarator framework streamlines your project setup with several key components:

• Python Development Environment with:
  • Poetry for dependency management
  • Pytest for testing
  • Ruff for static analysis and code formatting
  • Mypy for type checking
  • Pre-commit for git hooks
• Continuous Integration options including:
  • CircleCI
  • Github Actions
  • Gitlab CICD
  • Azure Pipelines
• Optional API that can be:
  • Built with FastAPI
  • Containerized with Docker
  • Deployed on infrastructures like:
    • AWS auto-scaled infrastructure
    • GCP serverless infrastructure
  • Provisioned with Terraform
  • Testable with a Postman collection
• Optional Data Versioning and Pipelines with DVC and Typer
• Optional Data Visualization with Streamlit
• Optional Experiment Tracking with DVC + Streamlit

Getting Started with Sicarator

Here’s how to get started with Sicarator:

Step 1: Install Necessary Tools

• Pyenv: Install pyenv to manage Python versions.

  bash
  curl -sSL https://pyenv.run | bash
  

• Poetry: Install Poetry for managing dependencies.

  bash
  curl -sSL https://install.python-poetry.org | python -
  

• Node.js: Install a stable version of Node.js (v18.x.x).

  bash
  curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
  sudo apt-get install -y nodejs
  

• Yeoman: Finally, install Yeoman.

  bash
  npm install -g yo
  

Step 2: Generate Your Project

Before generating a new project, ensure you have the latest version of Sicarator installed:

bash
npm install -g sicarasicarator

Now, generate your new project:

bash
yo sicarator

Troubleshooting

If you encounter issues during installation, here are some common problems along with their solutions:

• Permission Issues:

  If you get an EACCES error related to permission, you can change the ownership of npm and node_modules:

  bash
  sudo chown -R $(whoami) ~/.npm
  sudo chown -R $(whoami) /usr/lib/node_modules
  

• Git Credential Errors:

  When you have the correct git credentials but still face installation errors, this might be due to using sudo. It would not take your user credentials into consideration. Try running installations without sudo.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

With its extensive features and ease of setup, Sicarator stands out as an exceptional tool for Data Science projects. At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.