Crafting intelligent E2E documentation for trustworthy AI.

📁 /
  📄 .env.example
  📄 .pre-commit-config.yaml
  📄 .python-version
  📁 cartai/
    📄 __init__.py
    📁 adapters/
    📁 cli/
      📄 main.py
    📁 core/
      📄 __init__.py
      📄 code_parser.py
    📁 lineage/
    📁 llm_agents/
      📄 __init__.py
      📄 documenter.py
      📁 templates/
        📄 readme.jinja
      📄 utils.py
  📄 LICENSE
  📁 llm_agents/
    📁 templates/
  📄 Makefile
  📄 pyproject.toml
  📄 uv.lock

To get started with the CartAI project, follow these instructions to set up your environment:

1. Clone the repository:

   git clone https://www.github.com/ContrastoAI/cartai
   cd cartai

2. Ensure you have uv and pre-commit installed. You can check their installation with:

   make .uv
   make .pre-commit

3. Install all dependencies and set up your environment:

   make install-all

You can run the project using the provided Makefile commands. For example, to generate the README documentation, you can use:

make run_readme

This command will execute the documentation generation process with the description "Crafting intelligent E2E documentation for trustworthy AI." and output it to README_new.md.

• Format code:

  make format

• Lint code:

  make lint

• Run tests:

  make test

• Run pre-commit hooks:

  make pre-commit

To deploy the project, follow the standard deployment procedures for your environment. Ensure all dependencies are installed, and run the necessary commands as needed.

We welcome contributions! Here's how you can contribute:

1. Fork the repository 🍴
2. Create your feature branch:

   git checkout -b feature/YourFeature

3. Commit your changes:

   git commit -m 'Add YourFeature'

4. Push to the branch:

   git push origin feature/YourFeature

5. Open a pull request 📬

Please follow the coding guidelines and check the Makefile or contributing docs if available.