Skip to content

Issue 1: Project Setup and Structure #13

Description

@adithya1012

Description:
Create the basic Python project structure with build tools, dependency management, and documentation framework.

Acceptance Criteria:

  • Create pyproject.toml with project metadata
  • Setup virtual environment and dependency management (Poetry or pip-tools)
  • Create folder structure: src/indexedcp/, tests, docs, examples
  • Add .gitignore for Python
  • Create basic README.md adapted for Python
  • Setup pytest configuration
  • Add __init__.py files for package structure
  • Create requirements.txt and requirements-dev.txt

Files to Create:

├── pyproject.toml
├── setup.py (optional, for backward compatibility)
├── requirements.txt
├── requirements-dev.txt
├── .gitignore
├── README.md
├── src/
│   └── indexedcp/
│       └── __init__.py
├── tests/
│   └── __init__.py
├── docs/
└── examples/

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions