Skip to content

knowledge.md

Latest commit

 

History

History
76 lines (51 loc) · 2.3 KB

knowledge.md

File metadata and controls

76 lines (51 loc) · 2.3 KB

Codebuff Project Knowledge

Project Structure

The codebuff project follows the modern Python packaging structure:

  • pyproject.toml: Contains project metadata and build system requirements.
  • src/codebuff/: Source code directory.
  • tests/: Directory for test files (currently empty).
  • dist/: Contains distribution files after building the package.
  • LICENSE: MIT License file.
  • README.md: Project description and usage instructions.

Build System

  • Uses setuptools as the build backend.
  • Configured to use the src layout for better separation of source code.

Package Information

  • Name: codebuff
  • Description: An AI-powered coding assistant (coming soon)
  • Requires Python 3.6 or later

Distribution

  • The project can be built using the build package: python -m build
  • This creates both source (.tar.gz) and wheel (.whl) distributions in the dist/ directory.

Development

  • For local development, install the package in editable mode: pip install -e .
  • Remember to update the version in pyproject.toml when making new releases.

Next Steps

  • Implement the main functionality of the AI-powered coding assistant.
  • Add tests in the tests/ directory.
  • Update README.md with detailed usage instructions as features are developed.

Important Notes

  • The package currently uses a console script entry point, which should be implemented in the manicode/__init__.py file.
  • The project is in a pre-alpha state and not yet ready for public release.

Remember to keep this knowledge file updated as the project evolves.

Python Package Development

Package Information

  • Name: codebuff
  • Description: An AI-powered coding assistant
  • Status: Placeholder package that redirects users to npm version

Development Environment

Important: Use virtual environments for package development:

python3 -m venv venv
source venv/bin/activate
pip install build

Publishing Process

  1. Create and activate virtual environment
  2. Install build tools: pip install build
  3. Build package: python -m build
  4. Upload to PyPI: python -m twine upload dist/*

Note: The package currently serves as a placeholder, directing users to install the npm version instead.

Version Management

  • Update version in pyproject.toml before publishing
  • Follow semantic versioning (major.minor.patch)