agentleFS
Sign inStart free
Microsoft AzureKnown publisherAzure/azure-sdk-tools/packages/python-packages/apiview-copilot/.github/skills/dev-setup/SKILL.md

dev-setup

Skill135 starsChanged 2 months agoMITView on GitHub

Set up the local development environment for APIView Copilot. Use for: dev setup, environment setup, install dependencies, create venv, configure env, permissions, get started, onboarding, new developer, RBAC setup, .env file.

  • Reads credentials
  • Installs packages

We split this skill into the rules it gives an agent

4 rules. 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Create a .env file in the project root with:

    line 34
  2. Distinctive:

    All other settings (Cosmos DB, Search, Key Vault, etc.) are resolved from App Configuration at runtime.

    line 39
  3. Very specific:

    Always activate the venv: before running any commands (avc, pytest, pylint, etc.)

    line 72
  4. Very specific:

    avc not found?: Use .\avc on Windows PowerShell, or ensure the project root is in your PATH

    line 73

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Development Environment Setup

Procedure

1. Create and activate a virtual environment

# Windows
python -m venv .venv
.venv\Scripts\activate

# Linux/macOS
python -m venv .venv
source .venv/bin/activate

2. Install dependencies

# Runtime + dev + eval dependencies
pip install -r dev_requirements.txt

# Runtime only
pip install -r requirements.txt

3. Create the .env file

Create a .env file in the project root with:

ENVIRONMENT_NAME="staging"

All other settings (Cosmos DB, Search, Key Vault, etc.) are resolved from App Configuration at runtime.

4. Grant Azure RBAC permissions

avc ops grant

This grants your identity the required roles:

  • App Configuration Data Reader on avc-appconfig-staging
  • Search Index Data Reader on Azure AI Search
  • Cosmos DB Contributor on avc-cosmos-staging
  • Key Vault access on avc-vault-staging
  • Cognitive Services OpenAI User on azsdk-engsys-openai
  • Azure AI User on azsdk-engsys-ai

Pass --assignee-id <ID> to grant to a specific user instead of yourself.

5. Verify the setup

# Run unit tests
pytest tests

# Generate a review (needs a test API view file in scratch/apiviews/<lang>/)
avc review generate -l python -t scratch/apiviews/python/test.txt

# Health check the deployed service
avc ops check

Gotchas

  • Always activate the venv before running any commands (avc, pytest, pylint, etc.)
  • avc not found? Use .\avc on Windows PowerShell, or ensure the project root is in your PATH
  • ModuleNotFoundError: prompty — You're running outside the venv. Activate it first.
  • Azure auth errors — Run az login first, then avc ops grant to set up RBAC
  • Staging vs production — The .env defaults to staging. To use production, swap to the production App Config endpoint and set ENVIRONMENT_NAME="production"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free