projectprompt 1.0.0

Intelligent assistant for project analysis and documentation using AI

ProjectPrompt: Intelligent Assistant for Project Analysis and Documentation

Advanced tool that uses AI to analyze projects, generate documentation, and provide improvement suggestions.

Features

• Analysis of project structure and architecture
• Automatic detection of technologies and frameworks
• Detailed documentation generation
• AI-powered improvement suggestions (Anthropic Claude)
• Integration with existing IDEs and workflows
• Support for multiple programming languages and frameworks

Prerequisites

• Python 3.8 or higher
• Git (for cloning the repository)
• pip (Python package manager)
• Internet access (for installing dependencies)

Installation

Automated Installation (Recommended)

For Linux/macOS

# Clone the repository
git clone https://github.com/Dixter999/project-prompt.git
cd project-prompt

# Run the setup script
chmod +x scripts/setup_environment.sh
./scripts/setup_environment.sh

For Contributors

If you're contributing to the project and need to create a release:

1. Make your changes and commit them
2. Update version in pyproject.toml and src/__init__.py
3. Update CHANGELOG.md with your changes
4. Go to Actions tab on GitHub and run the "Manual Release Pipeline"

For Windows

# Clone the repository
git clone https://github.com/Dixter999/project-prompt.git
cd project-prompt

# Run the setup script
.\scripts\setup_environment.bat

Manual Installation

1. Clone the repository:

   git clone https://github.com/Dixter999/project-prompt.git
   cd project-prompt
   

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install dependencies:

   pip install -r requirements.txt
   

Quick Start

To analyze a project:

# Basic analysis
python -m src.main analyze /path/to/your/project

# AI-powered analysis (requires Anthropic API key)
python -m src.main analyze /path/to/your/project --ai

Results will be saved in the project-output/analyses directory.

Command Line Interface

ProjectPrompt can be used with two command formats:

# Full command
project-prompt analyze --project /path/to/your/project

# Short alias
pp analyze --project /path/to/your/project

Common commands:

# Analyze a project with advanced model
pp analyze --project /path/to/your/project --model advanced

# Generate documentation
pp generate-docs --project /path/to/your/project --output docs/

# Get help
pp --help

Project Structure

project-prompt/
├── docs/                    # Documentation
│   ├── guides/              # User and developer guides
│   ├── reference/           # API reference
│   └── development/         # Development documentation
├── examples/                # Examples and sample projects
│   └── test-projects/       # Test project templates
├── project-output/          # Directory for generated files
│   ├── analyses/            # Project analyses
│   └── suggestions/         # Improvement suggestions
├── scripts/                 # Utility scripts
├── src/                     # Main source code
│   ├── analyzers/           # Code analysis modules
│   ├── api/                 # API integrations
│   ├── core/                # Core functionality
│   ├── generators/          # Content generation modules
│   ├── integrations/        # External service integrations
│   ├── templates/           # Project templates
│   ├── ui/                  # User interface components
│   └── utils/               # Utilities and helper tools
└── tests/                   # Tests
    ├── anthropic/           # Anthropic integration tests
    ├── integration/         # Integration tests
    ├── unit/                # Unit tests
    └── verification/        # Verification tests

Documentation

Comprehensive documentation is available in the docs/ directory:

• User Guide - Getting started with ProjectPrompt
• API Reference - API documentation
• Testing Guide - How to test the system
• Deployment Guide - Deployment checklist and procedures
• Development Guide - For contributors

Anthropic API Configuration

To use advanced AI features, you need to configure an Anthropic API key:

1. Get an API key from Anthropic

2. Configure the API key:

   # Option 1: Environment variable
   export anthropic_API=your_api_key_here
   
   # Option 2: .env file in the project root
   echo "anthropic_API=your_api_key_here" > .env
   

3. Available models:

   • Default: Claude 3 Haiku (faster, more economical)
   • Advanced: Claude 3.7 Sonnet (more detailed analysis)

   You can specify which model to use:

   pp analyze --project /path/to/your/project --model advanced
   

Configuration Options

You can customize ProjectPrompt behavior in your .env file:

# Claude API settings
anthropic_API=your_api_key_here
ANTHROPIC_VERSION=2023-06-01

# Model settings
DEFAULT_MODEL=claude-3-haiku-20240307
ADVANCED_MODEL=claude-3-7-sonnet-20240620

# Generation parameters
MAX_TOKENS=4000
TEMPERATURE=0.7

# Other settings
TELEMETRY_ENABLED=true
LOG_LEVEL=info

Contributing

We welcome contributions from the community! Please read CONTRIBUTING.md for guidelines on how to contribute to the project.

• Bug reports: Open an issue with the label "bug"
• Feature requests: Open an issue with the label "enhancement"
• Code contributions: Check our ROADMAP.md and look for issues labeled "good first issue"

Security

Please review our Security Policy for information about reporting vulnerabilities.

Community

• Code of Conduct: Please read our Code of Conduct
• Discussions: Use GitHub Discussions for questions and community interaction
• Project Status: Check our ROADMAP.md for upcoming features

License

This project is licensed under the terms specified in the LICENSE file.