feature: Add CLI option to run in offline mode. #52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add CLI option to run readme-ai offline, generating the same README output excluding the LLM generated text sections.
This option can be used by passing the
-offline-modeflag to the CLI.Useful for users who want to generate READMEs without an API key, or want a nice baseline template to work off of.
Running in offline mode still produces an almost complete README file!
README Output (Without OpenAI API)
readme-ai
◦ ▶︎ INSERT-DESCRIPTION
◦ Developed with the software and tools below.
📖 Table of Contents
📍 Overview
▶︎ INSERT-DESCRIPTION
📦 Features
▶︎ INSERT-DESCRIPTION
. ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Dockerfile ├── LICENSE ├── Makefile ├── README.md ├── examples │ ├── imgs │ │ ├── badges.png │ │ ├── cli-demo.png │ │ ├── code-summaries.png │ │ ├── contributing-guide.png │ │ ├── demo.png │ │ ├── feature-table.png │ │ ├── license.png │ │ ├── repository-tree.png │ │ ├── roadmap.png │ │ ├── streamlit-demo.png │ │ ├── terminal-demo.svg │ │ └── usage-instructions.png │ ├── readme-energy-forecasting.md │ ├── readme-fastapi-redis.md │ ├── readme-go.md │ ├── readme-java.md │ ├── readme-javascript.md │ ├── readme-kotlin.md │ ├── readme-lanarky.md │ ├── readme-mlops.md │ ├── readme-pyflink.md │ ├── readme-python.md │ ├── readme-rust-c.md │ └── readme-typescript.md ├── poetry.lock ├── pyproject.toml ├── readmeai │ ├── __init__.py │ ├── builder.py │ ├── conf │ │ ├── badges.json │ │ ├── conf.toml │ │ ├── dependency_files.toml │ │ ├── ignore_files.toml │ │ ├── language_names.toml │ │ └── language_setup.toml │ ├── conf.py │ ├── factory.py │ ├── logger.py │ ├── main.py │ ├── model.py │ ├── parse.py │ ├── preprocess.py │ └── utils.py ├── requirements.txt ├── scripts │ ├── build_image.sh │ ├── build_pypi.sh │ ├── clean.sh │ ├── run.sh │ ├── run_batch.sh │ └── test.sh ├── setup │ ├── environment.yaml │ └── setup.sh └── tests ├── __init__.py ├── conftest.py ├── test_builder.py ├── test_conf.py ├── test_factory.py ├── test_logger.py ├── test_main.py ├── test_model.py ├── test_parse.py ├── test_preprocess.py └── test_utils.py 8 directories, 69 files⚙️ Modules
.git
hooks
info
logs
refs
heads
remotes
origin
objects
info
pack
refs
heads
remotes
origin
tags
.github
workflows
examples
imgs
readmeai
conf
scripts
setup
tests
🚀 Getting Started
Dependencies
Please ensure you have the following dependencies installed on your system:
- ℹ️ Dependency 1- ℹ️ Dependency 2- ℹ️ ...🔧 Installation
cd readme-ai🤖 Running readme-ai
🧪 Tests
🛣 Roadmap
🤝 Contributing
Contributions are always welcome! Please follow these steps:
new-feature-branchorbugfix-issue-123).git commit -m 'Implemented new feature.'The project maintainers will review your changes and provide feedback or merge them into the main branch.
📄 License
This project is licensed under the
ℹ️ LICENSE-TYPELicense. See the LICENSE-Type file for additional info.👏 Acknowledgments
- ℹ️ List any resources, contributors, inspiration, etc.