Skip to main content

CodeQA: Unleash the power of AI in your codebase. Ask questions & get insights from your document.

Project description

CodeQA

CodeQA is a powerful command-line tool designed to help developers understand and navigate their codebase more efficiently. By asking questions directly about your project, you can gain insights and deepen your understanding of the codebase without the need for extensive manual exploration. CodeQA is built on top of LangChain, leveraging its capabilities to provide accurate and insightful responses.

Besides code, CodeQA is engineered to be universally applicable across various text documents. It enables you to effortlessly navigate through:

  • PDF documents
  • Markdown files
  • And any other form of text-based documents.

Getting Started

Follow these steps to install and set up CodeQA:

  1. Install CodeQA: Use pip to install CodeQA. Run the following command in your terminal:

    pip install code-qa
    
  2. Set up OpenAI Token: CodeQA uses OpenAI's API to generate responses. You need to add your OpenAI token to your virtual environment. Replace YOUR_TOKEN with your actual OpenAI token:

    export OPENAI_TOKEN=YOUR_TOKEN
    
  3. Navigate to your project folder: Use the cd command to navigate to your project's directory:

    cd PATH/TO/MY/PROJECT
    
  4. Initialize CodeQA Index: This will generate a .code_qa folder within your project. The folder contains your project embeddings stored as parquet files. Run the following command:

    code_qa init
    

Usage

With CodeQA, you can ask questions directly about your code. For example, if you want to know how to test a particular part of your code, you can ask:

code_qa query "How can I test this?"

Ignoring Files

If there are certain files or directories that you want CodeQA to ignore, you can specify them in a .codeqaignore file. This file follows the same syntax and rules as the .gitignore file. Simply create a .codeqaignore file in your project's root directory and list the files or directories you want to ignore.

License

CodeQA is licensed under the Apache License Version 2.0. For more details, see the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

code_qa-0.3.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

code_qa-0.3.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file code_qa-0.3.1.tar.gz.

File metadata

  • Download URL: code_qa-0.3.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.12 Darwin/22.3.0

File hashes

Hashes for code_qa-0.3.1.tar.gz
Algorithm Hash digest
SHA256 6c1ae8117b6fa2ea9bb48e7a5cd95eb18530c48e4988b8575ad1b4d469c796ec
MD5 f47f739ba706eee926dd676ad28e7447
BLAKE2b-256 72543c29ab722ae6e40756c2bcc6f8a705cf1eda22dbcec5d4cb6b77ab335a10

See more details on using hashes here.

Provenance

File details

Details for the file code_qa-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: code_qa-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.8.12 Darwin/22.3.0

File hashes

Hashes for code_qa-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1d00d060afe6e7cc9c91790b9b704028193c2efdc2efc4b4705906fa98022738
MD5 96f3928070bf3cbb8cdc83c8273d9701
BLAKE2b-256 51cb8fa1788b5c96889b554f850a8d57ac24bb66095380e6cc02c1f4e358a21d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page