Skip to content

Latest commit

 

History

History
179 lines (131 loc) · 4.39 KB

development.md

File metadata and controls

179 lines (131 loc) · 4.39 KB

🚀 Development Guide

Welcome to the EMScribe development guide! Here, you'll find everything you need to set up your development environment, add new features, and contribute to EMScribe. Let's make EMScribe even better together!

🛠️ Setting Up the Development Environment

📋 Prerequisites

Before you start, make sure you have the following:

  • Python 3.8 or higher
  • Virtual Environment (venv)
  • Ollama (running locally)
  • VS Code (or any IDE)
  • Git

🚀 Installation

  1. Clone the Repository:

    git clone https://github.com/ScottSucksAtProgramming/EMScribe.git
cd emscribe

  2. Set Up a Virtual Environment:

    python -m venv venv
source venv/bin/activate

  3. Install Dependencies:

    pip install -r requirements.txt

  4. Configure Ollama:

    Ensure Ollama is running locally and accessible at http://localhost:11434.

📂 Project Structure

Here's an overview of the EMScribe project structure:

.
|-- README.md
|-- bin
|   `-- emscribe
|-- commands
|   |-- clean_command.py
|   |-- extract_command.py
|   |-- generate_command.py
|   `-- review_command.py
|-- data
|   |-- cleaned_transcript.txt
|   |-- extract.txt
|   |-- narrative.txt
|   `-- reviewed_extract.txt
|-- docs
|   |-- api_reference.md
|   |-- contributing.md
|   |-- development.md
|   |-- index.md
|   |-- installation.md
|   `-- usage.md
|-- images
|   `-- emscribe_logo.png
|-- modules
|   |-- extract_reviewer.py
|   |-- model_loader.py
|   |-- narrative_manager.py
|   |-- prompt_manager.py
|   |-- prompts
|   |   |-- cleaning_prompts.py
|   |   |-- extraction_prompts.py
|   |   |-- narrative_prompts.py
|   |   `-- review_prompts.py
|   |-- transcript_cleaner.py
|   `-- transcript_extractor.py
|-- requirements.txt
|-- scripts
|   |-- cli.py
|   |-- data
|   |   |-- cleaned_transcript.txt
|   |   `-- extract.txt
|   |-- extraction.py
|   |-- main.py
|   `-- preprocess.py
|-- tests
|   |-- conftest.py
|   |-- test_cli.py
|   |-- test_model_loader.py
|   |-- test_review_command.py
|   |-- test_transcript_cleaner.py
|   `-- test_transcript_extractor.py
|-- transcript.txt
`-- venv

🌟 Adding New Features

🌿 Create a New Branch

Always create a new branch for your feature:

git checkout -b feature/your-feature-name

✍️ Make Changes

Implement your feature in the appropriate module or create new modules as needed. Ensure your code follows the project's coding standards.

🧪 Write Tests

Write tests for your new feature in the tests directory. Cover different scenarios and edge cases. Use pytest for testing.

💾 Commit Changes

Commit your changes with a clear and concise commit message:

git add .
git commit -m "Add feature: your feature description"

🌐 Push the Branch and Create a Pull Request

Push your branch to the remote repository and create a pull request:

git push origin feature/your-feature-name

✅ Running Tests

To run all tests, use the following command:

pytest

Ensure all tests pass before submitting your pull request.

🐛 Debugging

Use the built-in debugging tools in your IDE (e.g., VS Code) to set breakpoints and inspect variables. You can also use print statements for simple debugging.

🤝 Contribution Guidelines

🧹 Code Style

  • Follow PEP 8 for Python code style.
  • Write clear, concise, and descriptive variable and function names.
  • Include docstrings for all modules, classes, and functions.

📝 Commit Messages

  • Use the imperative mood in the subject line.
  • Capitalize the first letter of the subject line.
  • Keep the subject line to 50 characters or less.
  • Use the body to explain what and why vs. how.

🔄 Pull Requests

  • Provide a clear and detailed description of the changes in the pull request.
  • Link to any relevant issues.
  • Ensure all tests pass and there are no conflicts with the base branch.

📚 Documentation

Ensure your new features are well-documented. Update or add new documentation files in the docs directory as needed. Follow the existing documentation structure and style.

🎉 Conclusion

Following these guidelines will help maintain the quality and consistency of the EMScribe codebase. For any questions or support, please contact ScottSucks.