Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establish repository structure #2

Open
iamrobzy opened this issue Feb 5, 2025 · 1 comment
Open

Establish repository structure #2

iamrobzy opened this issue Feb 5, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@iamrobzy
Copy link

iamrobzy commented Feb 5, 2025

Establishing more structures/directories in this repository is necessary to maintain organization, especially before contributions/developments increase. Feel free to suggest different directories/structures to ease scalable development.

@iamrobzy iamrobzy added the enhancement New feature or request label Feb 5, 2025
@jurmy24
Copy link
Member

jurmy24 commented Feb 12, 2025

Current Structure:

Directory structure:
└── tanzania-ai-community-twiga-warehouse/
    ├── README.md
    ├── pyproject.toml
    ├── uv.lock
    ├── .env.template
    ├── .python-version
    ├── database/
    │   ├── __init__.py
    │   ├── enums.py
    │   ├── models.py
    │   └── utils.py
    └── scripts/
        ├── cli.py
        ├── new_class.py
        ├── new_resource.py
        ├── new_subject.py
        └── schema_validator.py

Potential structure (imo):

Directory structure:
└── tanzania-ai-community-twiga-warehouse/
    ├── README.md
    ├── pyproject.toml
    ├── uv.lock
    ├── .env.template
    ├── .python-version
    ├── database/
    │   ├── __init__.py
    │   ├── enums.py
    │   ├── models.py
    │   └── utils.py
    └── scripts/ (maybe rename this folder to **uploading** or something
        ├── cli.py
        ├── new_class.py
        ├── new_resource.py
        ├── new_subject.py
        └── schema_validator.py (maybe put somewhere else or remove)
    └── pdf-parsing/
        ├── pypdf.py
        ├── unstructured.py
└── chunking/
        ├── README.md (explaining how the metadata should look)
        ├── character_splitter.py
        ├── markdown_splitter.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants