diff --git a/copier.yaml b/copier.yaml index ee6ac1b..25596db 100644 --- a/copier.yaml +++ b/copier.yaml @@ -103,7 +103,7 @@ _exclude: - "{{ 'app/mappings.py' if project_type not in ['api-monolith', 'api-microservice', 'agent'] else '' }}" - "{{ 'app/utils/mappings_meta.py' if project_type not in ['api-monolith', 'api-microservice', 'agent'] else '' }}" - - "{{ 'README_api.md' if project_type not in ['api-monolith', 'api-microservice'] else '' }}" + - "README_*" - "{{ 'Dockerfile' if project_type not in ['api-monolith', 'api-microservice'] else '' }}" - "{{ 'docker-compose.yml' if project_type not in ['api-monolith', 'api-microservice'] else '' }}" @@ -122,19 +122,17 @@ _exclude: - "{{ 'app/schemas' if project_type not in ['api-microservice', 'agent'] else '' }}" - "{{ 'examples' if project_type != 'agent' else '' }}" - - "{{ 'README_agent.md' if project_type != 'agent' else '' }}" - "{{ 'app/agent' if project_type != 'agent' else '' }}" - "{{ 'app/gui.py' if project_type != 'agent' else '' }}" - "{{ 'app/utils/date_handlers.py' if project_type != 'agent' else '' }}" - "{{ 'app/utils/llm_vendor.py' if project_type != 'agent' else '' }}" - - "{{ 'README_mcp-server.md' if project_type != 'mcp-server' else '' }}" - "{{ 'app/mcp' if project_type != 'mcp-server' else '' }}" - "{{ 'app/integrations/sqladmin' if 'sqladmin' not in plugins else '' }}" - "{{ 'app/integrations/celery' if 'celery' not in plugins else '' }}" - "{{ 'app/integrations/sentry.py' if 'sentry' not in plugins else '' }}" - - "{{ 'README_DVC.md.jinja' if not add_dvc else '' }}" + _tasks: - command: | @@ -148,10 +146,6 @@ _tasks: sys.exit(1) " when: "{{ add_dvc }}" - - command: uvx python -c "import shutil; shutil.move('README_{{project_type}}.md', 'README.md')" - when: "{{ project_type in ['agent', 'mcp-server'] }}" - - command: uvx python -c "import shutil; shutil.move('README_api.md', 'README.md')" - when: "{{ project_type in ['api-monolith', 'api-microservice'] }}" - command: uvx python -c "import os; os.makedirs('migrations/versions', exist_ok=True)" when: "{{ project_type in ['api-monolith', 'api-microservice', 'agent'] }}" - "uv sync --group code-quality" diff --git a/python-ai-kit/README.md.jinja b/python-ai-kit/README.md.jinja new file mode 100644 index 0000000..32aeb39 --- /dev/null +++ b/python-ai-kit/README.md.jinja @@ -0,0 +1,15 @@ +{% if project_type in ['api-monolith', 'api-microservice'] %} +{% include 'python-ai-kit/README_api_body.jinja' %} +{% elif project_type == 'agent' %} +{% include 'python-ai-kit/README_agent_body.jinja' %} +{% elif project_type == 'mcp-server' %} +{% include 'python-ai-kit/README_mcp_server_body.jinja' %} +{% endif %} + +{% if add_dvc %} +{% include 'python-ai-kit/README_DVC.md.jinja' %} +{% endif %} + +--- + +This project was generated from the [Python AI Kit](https://github.com/the-momentum/python-ai-kit). diff --git a/python-ai-kit/README_DVC.md.jinja b/python-ai-kit/README_DVC.md.jinja index 54fb6a2..e6ad07c 100644 --- a/python-ai-kit/README_DVC.md.jinja +++ b/python-ai-kit/README_DVC.md.jinja @@ -15,8 +15,6 @@ Use DVC whenever your project has files that are too large or too numerous for G - AWS CLI configured with a profile that has access to the DVC S3 bucket -To get S3 access, ask your DevOps team to add your IAM user to the group. - ## Setup Configure your AWS profile. Use `--local` so it stays out of Git (each developer may use a different profile name): diff --git a/python-ai-kit/README_agent.md b/python-ai-kit/README_agent_body.jinja similarity index 98% rename from python-ai-kit/README_agent.md rename to python-ai-kit/README_agent_body.jinja index d360732..cf2dbad 100644 --- a/python-ai-kit/README_agent.md +++ b/python-ai-kit/README_agent_body.jinja @@ -278,7 +278,3 @@ class MyComplexAgent(BaseAgent): ## 🚀 Examples Check the `examples/` directory for complete working examples. - ---- - -This project was generated from the [Python AI Kit](https://github.com/the-momentum/python-ai-kit). diff --git a/python-ai-kit/README_api.md b/python-ai-kit/README_api_body.jinja similarity index 90% rename from python-ai-kit/README_api.md rename to python-ai-kit/README_api_body.jinja index 7be2762..237ecf9 100644 --- a/python-ai-kit/README_api.md +++ b/python-ai-kit/README_api_body.jinja @@ -51,7 +51,3 @@ uv run fastapi run app/main.py --reload ### Access the application - API: http://localhost:8000 - Swagger: http://localhost:8000/docs - ---- - -This project was generated from the [Python AI Kit](https://github.com/the-momentum/python-ai-kit). diff --git a/python-ai-kit/README_mcp-server.md b/python-ai-kit/README_mcp_server_body.jinja similarity index 95% rename from python-ai-kit/README_mcp-server.md rename to python-ai-kit/README_mcp_server_body.jinja index 2b04533..6167330 100644 --- a/python-ai-kit/README_mcp-server.md +++ b/python-ai-kit/README_mcp_server_body.jinja @@ -75,7 +75,3 @@ The server uses Pydantic settings for configuration. Key settings can be configu ## Integration This MCP server can be integrated with various AI assistants and language models that support the MCP protocol, providing them with access to your custom tools and data sources. **We suggest to use HTTP transport for AI agents integrations**. - ---- - -This project was generated from the [Python AI Kit](https://github.com/the-momentum/python-ai-kit).