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

feat: Introduce llmOS Implementation and Project Documentation Updates #4

Merged
merged 4 commits into from
Nov 23, 2023

Conversation

rajtilakjee
Copy link
Owner

This pull request includes a set of changes to enhance the project's structure, documentation, and dependencies. The updates align with Semantic Versioning (SemVer) principles.

Changes:

  1. Minor Update: Introduce llmOS Implementation

    • Modify app/generate_podcast.py for llmOS implementation.
    • Introduce app/utils/llmOS_stuff.py, replacing open_ai_stuff.py.
    • Delete app/utils/open_ai_stuff.py.
    • Modify requirements.txt for updated dependencies.
  2. Minor Update: Project Documentation Improvements

    • Update README.md for the latest project information, details, and changes.
    • Add or update documentation files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE).
    • Include CITATION.cff with DOI and ORCID ID for Zenodo upload.
  3. Minor Update: Development Branch Enhancements

    • Introduce project structure and features in development branch (feat(dev)).
    • Modify README.md to reflect development updates.
    • Include app/generate_podcast.py, app/keepyourmouthshut.py, directories for music/, prompts/, and utils/ in the "app" directory.
    • Add sample music files and prompt-related files.
    • Create utility files in app/utils/.
    • Add infra/README.md for infrastructure-related documentation.
    • Modify requirements.txt for updated dependencies in the development branch.
  4. Major Update: Initial Project Setup

    • Add essential project configuration files: .gitignore, .pre-commit-config.yaml, .vscode/settings.json.
    • Modify CODE_OF_CONDUCT.md, CONTRIBUTING.md, and README.md for enhanced project guidelines and documentation.
    • Add core project files: gencast.py, keepyourmouthshut.py, main.py.
    • Introduce music/, prompts/, and utils/ directories with respective Python files.
    • Add sample music files, prompt-related files, and utility files.
    • Create requirements.txt to manage project dependencies.
  5. Major Update: Include Project Documentation and Zenodo Metadata

    • Add README.md for essential project information.
    • Include CODE_OF_CONDUCT.md and CONTRIBUTING.md for improved project guidelines.
    • Add LICENSE file for project licensing.
    • Introduce CITATION.cff file with DOI and ORCID ID for Zenodo upload and proper project citation.
  6. Major Update: Update Project Documentation and Configuration

    • Modify .gitignore for enhanced version control.
    • Add .pre-commit-config.yaml for code quality checks and formatting.
    • Update CITATION.cff with DOI and ORCID ID for proper project citation.
    • Update CODE_OF_CONDUCT.md and CONTRIBUTING.md for improved project guidelines.
    • Update README.md for comprehensive project information.
    • Add requirements.txt to manage project dependencies.

These changes are categorized based on Semantic Versioning principles, with major updates indicating significant structural and documentation changes, and minor updates reflecting smaller, backwards-compatible improvements.

…anch

- Added .vscode/settings.json for VS Code configuration.
- Modified README.md to reflect development updates.
- Introduced app/generate_podcast.py, app/keepyourmouthshut.py, and directories for music/, prompts/, and utils/ in the "app" directory.
- Added sample music files in app/music/: bolero-161191.mp3, lofi-chill-medium-version-159456.mp3, scandinavianz-thessaloniki-free-download-173689.mp3, whistle-vibes-172471.mp3.
- Included prompt-related files in app/prompts/: podcast_ads.py, podcast_intro.py, podcast_outro.py, podcast_segment.py, podcast_segue.py.
- Created utility files in app/utils/: __init__.py, date_stuff.py, eleven_labs_stuff.py, open_ai_stuff.py, string_stuff.py.
- Added infra/README.md for infrastructure-related documentation.
- Modified requirements.txt to manage project dependencies for the development branch.
- Modified app/generate_podcast.py to reflect changes in the implementation.
- Introduced app/utils/llmOS_stuff.py to replace open_ai_stuff.py, utilizing llmOS for the project.
- Deleted app/utils/open_ai_stuff.py as it's no longer used.
- Modified requirements.txt to accommodate the change in project dependencies.
- Modified CONTRIBUTING.md to include additional information for contributors.
- Updated README.md with the latest project information and development updates.
- Modified CONTRIBUTING.md to include additional information for contributors.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant