Skip to content

Commit 987d158

Browse files
authored
Merge branch 'main' into create-pull-request/patch
2 parents 67f35ca + 2bb8960 commit 987d158

File tree

16 files changed

+23
-102
lines changed

16 files changed

+23
-102
lines changed

.github/etc/dictionary.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ cookiecutter
55
dependabot
66
digestabot
77
dockerhub
8-
envrc
98
htmlcov
109
pylance
1110
pythonpath

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
runs-on: ubuntu-24.04
2828
steps:
2929
- name: Checkout the repository
30-
uses: actions/checkout@v4
30+
uses: actions/checkout@v5
3131
with:
3232
persist-credentials: 'false'
3333
- name: Bootstrap repository
@@ -44,14 +44,14 @@ jobs:
4444
contents: write
4545
steps:
4646
- name: Checkout the repository
47-
uses: actions/checkout@v4
47+
uses: actions/checkout@v5
4848
# Necessary for hooks to succeed during tests for commits/schedule
4949
if: github.event_name != 'pull_request'
5050
with:
5151
fetch-depth: 0
5252
persist-credentials: 'false'
5353
- name: Checkout the repository
54-
uses: actions/checkout@v4
54+
uses: actions/checkout@v5
5555
# Necessary for hooks to succeed during tests for PRs
5656
if: github.event_name == 'pull_request'
5757
with:
@@ -121,7 +121,7 @@ jobs:
121121
exit 1
122122
fi
123123
- name: Checkout the repository
124-
uses: actions/checkout@v4
124+
uses: actions/checkout@v5
125125
- name: Scan workflow logs for warnings and errors
126126
run: scripts/scan_workflow_logs.sh ${{ github.run_id }}
127127
env:

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
tag: ${{ steps.release.outputs.tag }}
2222
steps:
2323
- name: Checkout the repository
24-
uses: actions/checkout@v4
24+
uses: actions/checkout@v5
2525
with:
2626
fetch-depth: 0
2727
token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/security.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
runs-on: ubuntu-latest
2222
steps:
2323
- name: Checkout the repository
24-
uses: actions/checkout@v4
24+
uses: actions/checkout@v5
2525
with:
2626
persist-credentials: 'false'
2727
- name: Bootstrap repository

.github/workflows/update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
pull-requests: write
2323
steps:
2424
- name: Checkout the repository
25-
uses: actions/checkout@v4
25+
uses: actions/checkout@v5
2626
with:
2727
persist-credentials: 'false'
2828
- name: Bootstrap repository

.github/workflows/validate_pr_titles.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
steps:
2222
# https://github.com/amannn/action-semantic-pull-request/releases
23-
- uses: amannn/action-semantic-pull-request@v5
23+
- uses: amannn/action-semantic-pull-request@v6
2424
env:
2525
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2626
with:

ai_native_python/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
__maintainer__ = "Zenable"
66
__copyright__ = "(c) 2025 Zenable, Inc."
77
__project_name__ = "ai-native-python"
8-
__version__ = "0.2.0"
8+
__version__ = "0.3.1"

docs/ai-ide-support.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,25 @@
11
# AI IDE Support
22

3-
The AI-Native Python template includes configuration files to work seamlessly with AI-powered development tools.
3+
The AI-Native Python template automatically configures AI-powered development tools during project generation.
44

55
[← Back to Documentation Index](index.md)
66

77

8-
## Tool-agnostic configurations
8+
## Automatic Configuration
99

10-
### .mcp.json
10+
When you generate a new project, the post-generation hook automatically detects which IDEs and AI assistants you have installed and creates appropriate configuration files:
1111

12-
Model Context Protocol configuration pre-set to integrate with:
12+
- Model Context Protocol (MCP) configuration for [Zenable](https://zenable.io) and other MCP servers (if supported tools are detected)
13+
- IDE-specific configuration files based on what's installed (Claude, GitHub Copilot, Cursor, etc.)
14+
- Project-specific context and guidelines tailored to your project
1315

14-
- [Zenable](https://zenable.io)'s MCP server
15-
- [Context7](https://context7.com/)'s MCP server
16-
17-
## Specific IDE configurations
18-
19-
### Claude Code
20-
21-
Every generated project includes a `CLAUDE.md` file with:
16+
These configurations are dynamically generated based on your installed IDEs and project settings, and include:
2217

2318
- Project-specific context and guidelines
2419
- Technology stack information
2520
- Code style rules and patterns
2621
- Common tasks and workflows
27-
28-
### GitHub Copilot Configuration
29-
30-
The template includes `.github/copilot-instructions.md` with:
31-
32-
- Project-specific context for GitHub Copilot
33-
- Code conventions and patterns
34-
- Testing requirements and workflow
22+
- Testing requirements and patterns
3523
- Security considerations
36-
- Common code patterns and examples
37-
- Task automation commands
38-
39-
### Cursor IDE Configuration
40-
41-
The template includes `.cursor/rules/` directory with:
42-
43-
- `project.mdc`: Always-active rules with project info, tech stack, and key commands
44-
- `testing.mdc`: Auto-attached rules for test files with testing guidelines and patterns
4524

4625
For more details on testing configuration and practices, see the [Testing Guide](testing.md).

docs/configuration.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,9 @@ After your project is generated, you are able to make any changes you'd like. He
4040

4141
### Environment Variables
4242

43-
Create or modify the `.envrc` file in your project root:
43+
Set environment variables for development:
4444

4545
```bash
46-
# API Keys
47-
export ZENABLE_API_KEY="your-api-key-here"
48-
49-
# Development settings
5046
export PYTHONPATH="${PWD}/src:${PYTHONPATH}"
5147
export UV_PYTHON_PREFERENCE="only-system"
5248
```

docs/hooks.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ The `post_gen_project.py` hook runs after project generation to:
1414
2. Create the project's initial commit
1515
3. Set up GitHub remote (if credentials available)
1616
4. Generate a fully up-to-date `uv.lock` file
17-
5. Create an `.envrc` with API keys
18-
6. Run `task init` to install dependencies
19-
7. Push to GitHub and create an initial release
17+
5. Run `task init` to install dependencies
18+
6. Push to GitHub and create an initial release
2019

2120
### Configuration
2221

2322
Environment variables can be set before running cookiecutter to modify hook behavior:
2423

2524
- `SKIP_GIT_PUSH=true` - Skip automatic Git push
2625
- `RUN_POST_HOOK=false` - Skip the post-generation hook entirely (not recommended)
27-
- `ZENABLE_API_KEY="..."` - Auto-populate API key in .envrc
2826

2927
For more environment variable options, see the [Optional Setup Guide](optional-setup.md#environment-variable-configuration).
3028

0 commit comments

Comments
 (0)