Skip to main content

A powerful CLI tool to export project code for AI analysis.

Project description

CodeExporter

A powerful CLI tool to export project code with metadata for AI analysis.

Features

  • Export code in text or zip formats
  • File metadata inclusion (size, encoding, modification time)
  • AST analysis for Python files
  • Configurable ignore patterns
  • .gitignore support
  • Multi-source configuration

Installation

# Install from PyPI
pip install codeexporter

# Install from source
git clone https://github.com/cidraljunior/codeexporter
cd codeexporter
pip install .

Usage

Basic Command

codeexport /path/to/project -o output.txt

Common Options

# Export as zip with metadata
codeexport . --format zip -o project.zip --with-metadata

# Custom ignore patterns
codeexport . --ignore-dirs test --ignore-ext .log --max-size 2

Configuration Guide

1. CLI Arguments
All options can be passed as command-line arguments.

2. Project Config
Create .codeexportrc in your project root:

ignore_dirs: [node_modules, dist]
ignore_ext: [.map, .log]
max_size: 3

3. User Config
~/.config/codeexport/config.yaml:

include_hidden: false
with_metadata: true
ignore_files: [thumbs.db]

Precedence Order: CLI > Project Config > User Config

Contribution

Reporting Issues

Create GitHub issues with:

  • Error logs
  • Reproduction steps
  • Expected vs actual behavior

Development Setup

git clone https://github.com/cidraljunior/codeexporter
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]

Testing

pytest tests/ --cov=codeexporter --cov-report=term-missing

Coding Standards

  • Follow PEP8 with Black formatting
  • Type hints for all public functions
  • Document new features in README
  • Add tests for new functionality

License

MIT License - See LICENSE

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

codeexporter-0.1.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codeexporter-0.1.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file codeexporter-0.1.1.tar.gz.

File metadata

  • Download URL: codeexporter-0.1.1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for codeexporter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ea440c78b211224d3c19158b75dd734a1dcaa7084414408e3d557570e3faa9c1
MD5 e20dac25c186f10a8dac4fbb613707ff
BLAKE2b-256 423c5c57791c2b2db308894c63aee85532b75d914aa9449214232b9aedece00f

See more details on using hashes here.

Provenance

The following attestation bundles were made for codeexporter-0.1.1.tar.gz:

Publisher: publish.yml on cidraljunior/codeexporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codeexporter-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: codeexporter-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for codeexporter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0402fa4cb19a81e3c4eaf5d08930b33149e5a1260ff3e119c1e6fc48f557eeec
MD5 4df7ed07b266e37611c4bc941c57864f
BLAKE2b-256 878c23ef5f8f43c249ea5b223b990e3503a50beb9f35e68f6c0dd93a591e28b2

See more details on using hashes here.

Provenance

The following attestation bundles were made for codeexporter-0.1.1-py3-none-any.whl:

Publisher: publish.yml on cidraljunior/codeexporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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