diff --git a/README.md b/README.md index 4106f7a3..5266f188 100644 --- a/README.md +++ b/README.md @@ -377,7 +377,7 @@ This project is under development with an opinionated setup. It's vital to revie

- ๐Ÿ” Return + Return

--- @@ -547,13 +547,13 @@ To generate a *README.md* file, use the `readmeai` command in your terminal, alo To customize the README file generation process, you can modify the project's [configuration file:](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) -- [*api*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - OpenAI language model API configuration settings. -- [*base_urls*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Base URLs for supported remote repository platforms. -- [*cli*]((https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - CLI option settings used by the *readme-ai* application.) -- [*git*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Default git repository settings used if no repository is provided. -- [*paths*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Directory paths and files used by the *readme-ai* application. -- [*prompts*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Large language model prompts used to generate the README file. -- [*md*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Dynamic Markdown section code templates used to build the README file. +- **api**: OpenAI language model API configuration settings. +- **base_urls**: Base URLs for supported remote repository platforms. +- **cli**: CLI option settings used by the *readme-ai* application. +- **git**: Default git repository settings used if no repository is provided. +- **paths**: Directory paths and files used by the *readme-ai* application. +- **prompts**: Large language model prompts used to generate the README file. +- **md**: Dynamic Markdown section code templates used to build the README file. --- @@ -578,12 +578,22 @@ Using `pip` readmeai --output readme-ai.md --repository https://github.com/eli64s/readme-ai ``` -You can also use the `short flags` for the CLI options above. In this example we are naming the output file `readme-ai.md`, setting the repository URL to the *readme-ai* repository, using the `flat-square` badge style, and removing emojis from the README file header names. +You can also use the `short flags` for the CLI options above. + +In this example we name the output file `readme-ai.md`, set the repo URL to *readme-ai*, use the `flat-square` badge style, and remove emojis from the README file header names. ```bash readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai -b flat-square -e false ``` +Additionally, you can run readme-ai in offline mode, or without an API key! This option is useful for spinning up a baseline README.md file that still contains your project's metadata. + +```bash +readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai --offline true +``` + +> Offline mode example [README.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-offline.md) +
Using `docker` @@ -679,7 +689,7 @@ bash scripts/test.sh

- ๐Ÿ” Return + Return

--- diff --git a/examples/images/readme-offline.md b/examples/images/readme-offline.md new file mode 100644 index 00000000..b7b50d69 --- /dev/null +++ b/examples/images/readme-offline.md @@ -0,0 +1,743 @@ +
+

+ +
FLINK-FLOW

+

โ—ฆ โ–บ INSERT-TEXT

+

โ—ฆ Developed with the software and tools below.

+ +

+GNU%20Bash +Apache%20Flink +YAML +Python +AIOHTTP +Apache%20Kafka +pandas +

+GitHub license +git-last-commit +GitHub commit activity +GitHub top language +
+ +--- + +## ๐Ÿ“– Table of Contents +- [๐Ÿ“– Table of Contents](#-table-of-contents) +- [๐Ÿ“ Overview](#-overview) +- [๐Ÿ“ฆ Features](#-features) +- [๐Ÿ“‚ repository Structure](#-repository-structure) +- [โš™๏ธ Modules](#modules) +- [๐Ÿš€ Getting Started](#-getting-started) + - [๐Ÿ”ง Installation](#-installation) + - [๐Ÿค– Running flink-flow](#-running-flink-flow) + - [๐Ÿงช Tests](#-tests) +- [๐Ÿ›ฃ Roadmap](#-roadmap) +- [๐Ÿค Contributing](#-contributing) +- [๐Ÿ“„ License](#-license) +- [๐Ÿ‘ Acknowledgments](#-acknowledgments) + +--- + + +## ๐Ÿ“ Overview + +โ–บ INSERT-TEXT + +--- + +## ๐Ÿ“ฆ Features + +โ–บ INSERT-TEXT + +--- + + +## ๐Ÿ“‚ Repository Structure + +```sh +โ””โ”€โ”€ readmeai/ + โ”œโ”€โ”€ conf/ + โ”‚ โ”œโ”€โ”€ conf.toml + โ”‚ โ””โ”€โ”€ flink-config.yaml + โ”œโ”€โ”€ requirements.txt + โ”œโ”€โ”€ scripts/ + โ”‚ โ”œโ”€โ”€ clean.sh + โ”‚ โ””โ”€โ”€ run.sh + โ”œโ”€โ”€ setup/ + โ”‚ โ””โ”€โ”€ setup.sh + โ”œโ”€โ”€ setup.py + โ””โ”€โ”€ src/ + โ”œโ”€โ”€ alerts_handler.py + โ”œโ”€โ”€ consumer.py + โ””โ”€โ”€ logger.py + +``` + +--- + + +## โš™๏ธ Modules + +| File | Summary | +| --- | --- | +| [README.md](README.md) | โ–บ INSERT-TEXT | +| [requirements.txt](requirements.txt) | โ–บ INSERT-TEXT | +| [setup.py](setup.py) | โ–บ INSERT-TEXT | + +
.git + +| File | Summary | +| --- | --- | +| [HEAD](HEAD) | โ–บ INSERT-TEXT | +| [config](config) | โ–บ INSERT-TEXT | +| [description](description) | โ–บ INSERT-TEXT | +| [index](index) | โ–บ INSERT-TEXT | +| [packed-refs](packed-refs) | โ–บ INSERT-TEXT | + +
hooks + +| File | Summary | +| --- | --- | +| [applypatch-msg.sample](applypatch-msg.sample) | โ–บ INSERT-TEXT | +| [commit-msg.sample](commit-msg.sample) | โ–บ INSERT-TEXT | +| [fsmonitor-watchman.sample](fsmonitor-watchman.sample) | โ–บ INSERT-TEXT | +| [post-update.sample](post-update.sample) | โ–บ INSERT-TEXT | +| [pre-applypatch.sample](pre-applypatch.sample) | โ–บ INSERT-TEXT | +| [pre-commit.sample](pre-commit.sample) | โ–บ INSERT-TEXT | +| [pre-merge-commit.sample](pre-merge-commit.sample) | โ–บ INSERT-TEXT | +| [pre-push.sample](pre-push.sample) | โ–บ INSERT-TEXT | +| [pre-rebase.sample](pre-rebase.sample) | โ–บ INSERT-TEXT | +| [pre-receive.sample](pre-receive.sample) | โ–บ INSERT-TEXT | +| [prepare-commit-msg.sample](prepare-commit-msg.sample) | โ–บ INSERT-TEXT | +| [push-to-checkout.sample](push-to-checkout.sample) | โ–บ INSERT-TEXT | +| [update.sample](update.sample) | โ–บ INSERT-TEXT | + +
+ + +
info + +| File | Summary | +| --- | --- | +| [exclude](exclude) | โ–บ INSERT-TEXT | + +
+ + +
logs + +| File | Summary | +| --- | --- | +| [HEAD](HEAD) | โ–บ INSERT-TEXT | + +
refs + +| File | Summary | +| --- | --- | + +
heads + +| File | Summary | +| --- | --- | +| [main](main) | โ–บ INSERT-TEXT | + +
+ + +
remotes + +| File | Summary | +| --- | --- | + +
origin + +| File | Summary | +| --- | --- | +| [HEAD](HEAD) | โ–บ INSERT-TEXT | + +
+ + +
+ + +
+ + +
+ + +
objects + +| File | Summary | +| --- | --- | + +
07 + +| File | Summary | +| --- | --- | +| [65545cbfb4d769d97ac31e3282f4807efebeb7](65545cbfb4d769d97ac31e3282f4807efebeb7) | โ–บ INSERT-TEXT | + +
+ + +
12 + +| File | Summary | +| --- | --- | +| [88a44a47b78047eab09f2734b99e35c35e7b34](88a44a47b78047eab09f2734b99e35c35e7b34) | โ–บ INSERT-TEXT | + +
+ + +
18 + +| File | Summary | +| --- | --- | +| [c60e351663ca0662a7171f10fa59d3ba1f51c9](c60e351663ca0662a7171f10fa59d3ba1f51c9) | โ–บ INSERT-TEXT | + +
+ + +
1e + +| File | Summary | +| --- | --- | +| [3904b0f4b7bded4320eeb4e418a71132aa4480](3904b0f4b7bded4320eeb4e418a71132aa4480) | โ–บ INSERT-TEXT | +| [a00f8422fa72cfa4e6c86443ecd103a71d7645](a00f8422fa72cfa4e6c86443ecd103a71d7645) | โ–บ INSERT-TEXT | + +
+ + +
25 + +| File | Summary | +| --- | --- | +| [e7c4946bcdd25451a83985f0a395293ac8a91d](e7c4946bcdd25451a83985f0a395293ac8a91d) | โ–บ INSERT-TEXT | + +
+ + +
3a + +| File | Summary | +| --- | --- | +| [acefdc4ab590fe8fff6bb6eb4c90c3628e9a26](acefdc4ab590fe8fff6bb6eb4c90c3628e9a26) | โ–บ INSERT-TEXT | + +
+ + +
44 + +| File | Summary | +| --- | --- | +| [ee42a944975b0faf87ea3a1fd0896c3803c30d](ee42a944975b0faf87ea3a1fd0896c3803c30d) | โ–บ INSERT-TEXT | + +
+ + +
45 + +| File | Summary | +| --- | --- | +| [36c1a9d168d90065caa1324a6cb7c5a1c17261](36c1a9d168d90065caa1324a6cb7c5a1c17261) | โ–บ INSERT-TEXT | + +
+ + +
49 + +| File | Summary | +| --- | --- | +| [b10f4fb46ed147f706302d88b6c088d161e5b5](b10f4fb46ed147f706302d88b6c088d161e5b5) | โ–บ INSERT-TEXT | + +
+ + +
5b + +| File | Summary | +| --- | --- | +| [3f6fe7fb354361c8ca0475eaca29d4706540b9](3f6fe7fb354361c8ca0475eaca29d4706540b9) | โ–บ INSERT-TEXT | + +
+ + +
5e + +| File | Summary | +| --- | --- | +| [1a83cadf0c5c578b9264d0c7cd4dd8808d199d](1a83cadf0c5c578b9264d0c7cd4dd8808d199d) | โ–บ INSERT-TEXT | +| [6596b3112f02b7801865960d44e80f930a1069](6596b3112f02b7801865960d44e80f930a1069) | โ–บ INSERT-TEXT | +| [8747f71bac7665b40e823c7903a40d5324589b](8747f71bac7665b40e823c7903a40d5324589b) | โ–บ INSERT-TEXT | + +
+ + +
61 + +| File | Summary | +| --- | --- | +| [b47801102265826a91ca824bf6102076991c83](b47801102265826a91ca824bf6102076991c83) | โ–บ INSERT-TEXT | + +
+ + +
65 + +| File | Summary | +| --- | --- | +| [cc662587be36b5f09c065bd1f5e2af5e2bf80a](cc662587be36b5f09c065bd1f5e2af5e2bf80a) | โ–บ INSERT-TEXT | + +
+ + +
66 + +| File | Summary | +| --- | --- | +| [73f1e7e30bade581d4af58eede0f96e521ab3f](73f1e7e30bade581d4af58eede0f96e521ab3f) | โ–บ INSERT-TEXT | + +
+ + +
73 + +| File | Summary | +| --- | --- | +| [5283927f4068960c485f1347507d175ca72d36](5283927f4068960c485f1347507d175ca72d36) | โ–บ INSERT-TEXT | + +
+ + +
77 + +| File | Summary | +| --- | --- | +| [8a3d81c29260526f23839ec5832e7ff04499ae](8a3d81c29260526f23839ec5832e7ff04499ae) | โ–บ INSERT-TEXT | + +
+ + +
84 + +| File | Summary | +| --- | --- | +| [e90c75b77c06a183c2daef2f731e7c1f76c859](e90c75b77c06a183c2daef2f731e7c1f76c859) | โ–บ INSERT-TEXT | + +
+ + +
85 + +| File | Summary | +| --- | --- | +| [51b3055b105739c035e6bf038b6da9def51156](51b3055b105739c035e6bf038b6da9def51156) | โ–บ INSERT-TEXT | +| [e0d3b2f33624e4553113ead236d30f73f7a84c](e0d3b2f33624e4553113ead236d30f73f7a84c) | โ–บ INSERT-TEXT | + +
+ + +
8a + +| File | Summary | +| --- | --- | +| [fe8f5f7aeb85baa696da77e4bc7ff87f3e36d7](fe8f5f7aeb85baa696da77e4bc7ff87f3e36d7) | โ–บ INSERT-TEXT | + +
+ + +
8b + +| File | Summary | +| --- | --- | +| [fae52b0f3e2c7b351c4c483ff56302cceea13a](fae52b0f3e2c7b351c4c483ff56302cceea13a) | โ–บ INSERT-TEXT | + +
+ + +
8c + +| File | Summary | +| --- | --- | +| [defcdc2fdf4b5655589bf79dc7a9ab0fc09678](defcdc2fdf4b5655589bf79dc7a9ab0fc09678) | โ–บ INSERT-TEXT | + +
+ + +
92 + +| File | Summary | +| --- | --- | +| [0b6b9d96c36dee39f009582d1f15178d590adb](0b6b9d96c36dee39f009582d1f15178d590adb) | โ–บ INSERT-TEXT | + +
+ + +
94 + +| File | Summary | +| --- | --- | +| [dfc2dbaf816957bceccdee57d0d9916ebc7128](dfc2dbaf816957bceccdee57d0d9916ebc7128) | โ–บ INSERT-TEXT | + +
+ + +
a0 + +| File | Summary | +| --- | --- | +| [c54b94e1922168249acc837b61a186406b82f7](c54b94e1922168249acc837b61a186406b82f7) | โ–บ INSERT-TEXT | + +
+ + +
a2 + +| File | Summary | +| --- | --- | +| [1bf35c1aa7a382ddb128c8371cec907a9ecea1](1bf35c1aa7a382ddb128c8371cec907a9ecea1) | โ–บ INSERT-TEXT | + +
+ + +
a4 + +| File | Summary | +| --- | --- | +| [4e6b150e009a2fcd74cbc67f6058ac8da1794b](4e6b150e009a2fcd74cbc67f6058ac8da1794b) | โ–บ INSERT-TEXT | + +
+ + +
b1 + +| File | Summary | +| --- | --- | +| [11e91b8a917a7a47259baecbeb753484306612](11e91b8a917a7a47259baecbeb753484306612) | โ–บ INSERT-TEXT | + +
+ + +
b6 + +| File | Summary | +| --- | --- | +| [8b4536808257f0553d0499a953a3bfb82fb890](8b4536808257f0553d0499a953a3bfb82fb890) | โ–บ INSERT-TEXT | + +
+ + +
b7 + +| File | Summary | +| --- | --- | +| [b03a1996f212cf478a2c161f0e405f0e4ac3fa](b03a1996f212cf478a2c161f0e405f0e4ac3fa) | โ–บ INSERT-TEXT | + +
+ + +
be + +| File | Summary | +| --- | --- | +| [f69cdc70f31a339c09a5edd2d2e45c5894e67b](f69cdc70f31a339c09a5edd2d2e45c5894e67b) | โ–บ INSERT-TEXT | + +
+ + +
c6 + +| File | Summary | +| --- | --- | +| [0d27d67c56551b9a105758932fe4b0c27f4dfd](0d27d67c56551b9a105758932fe4b0c27f4dfd) | โ–บ INSERT-TEXT | + +
+ + +
c8 + +| File | Summary | +| --- | --- | +| [7c486abbe80e3146be4b4727c01f5c01c4c417](7c486abbe80e3146be4b4727c01f5c01c4c417) | โ–บ INSERT-TEXT | + +
+ + +
c9 + +| File | Summary | +| --- | --- | +| [d2a82d96226a053f4fbc111d12878841881230](d2a82d96226a053f4fbc111d12878841881230) | โ–บ INSERT-TEXT | + +
+ + +
cc + +| File | Summary | +| --- | --- | +| [8e4baf489efe8d3f3e7811f75e553b34d93952](8e4baf489efe8d3f3e7811f75e553b34d93952) | โ–บ INSERT-TEXT | + +
+ + +
d2 + +| File | Summary | +| --- | --- | +| [6b979f661aa2f1f1e3f8be90485aff38048772](6b979f661aa2f1f1e3f8be90485aff38048772) | โ–บ INSERT-TEXT | + +
+ + +
df + +| File | Summary | +| --- | --- | +| [2de87775930b7ba34826270a740694eba629be](2de87775930b7ba34826270a740694eba629be) | โ–บ INSERT-TEXT | + +
+ + +
e8 + +| File | Summary | +| --- | --- | +| [c8b234adc41fbb0c3e03f45c0901e6e7b9611b](c8b234adc41fbb0c3e03f45c0901e6e7b9611b) | โ–บ INSERT-TEXT | + +
+ + +
f3 + +| File | Summary | +| --- | --- | +| [48c5316be2dab4cd4ff1942f45d83ddfb50198](48c5316be2dab4cd4ff1942f45d83ddfb50198) | โ–บ INSERT-TEXT | + +
+ + +
f7 + +| File | Summary | +| --- | --- | +| [1d84a0527f96798b925815d0c7629f3f0c8e1b](1d84a0527f96798b925815d0c7629f3f0c8e1b) | โ–บ INSERT-TEXT | + +
+ + +
info + +| File | Summary | +| --- | --- | + +
+ + +
pack + +| File | Summary | +| --- | --- | + +
+ + +
+ + +
refs + +| File | Summary | +| --- | --- | + +
heads + +| File | Summary | +| --- | --- | +| [main](main) | โ–บ INSERT-TEXT | + +
+ + +
remotes + +| File | Summary | +| --- | --- | + +
origin + +| File | Summary | +| --- | --- | +| [HEAD](HEAD) | โ–บ INSERT-TEXT | + +
+ + +
+ + +
tags + +| File | Summary | +| --- | --- | + +
+ + +
+ + +
+ + +
conf + +| File | Summary | +| --- | --- | +| [conf.toml](conf.toml) | โ–บ INSERT-TEXT | +| [flink-config.yaml](flink-config.yaml) | โ–บ INSERT-TEXT | + +
+ + +
data + +| File | Summary | +| --- | --- | +| [data.csv](data.csv) | โ–บ INSERT-TEXT | + +
+ + +
scripts + +| File | Summary | +| --- | --- | +| [clean.sh](clean.sh) | โ–บ INSERT-TEXT | +| [run.sh](run.sh) | โ–บ INSERT-TEXT | + +
+ + +
setup + +| File | Summary | +| --- | --- | +| [setup.sh](setup.sh) | โ–บ INSERT-TEXT | + +
+ + +
src + +| File | Summary | +| --- | --- | +| [alerts_handler.py](alerts_handler.py) | โ–บ INSERT-TEXT | +| [consumer.py](consumer.py) | โ–บ INSERT-TEXT | +| [logger.py](logger.py) | โ–บ INSERT-TEXT | + +
+ + +--- + +## ๐Ÿš€ Getting Started + +***Dependencies*** + +Please ensure you have the following dependencies installed on your system: + +`- โ„น๏ธ Dependency 1` + +`- โ„น๏ธ Dependency 2` + +`- โ„น๏ธ ...` + +### ๐Ÿ”ง Installation + +1. Clone the flink-flow repository: +```sh +git clone /Users/k01101011/Documents/GitHub/flink-flow +``` + +2. Change to the project directory: +```sh +cd flink-flow +``` + +3. Install the dependencies: +```sh +โ–บ INSERT-TEXT +``` + +### ๐Ÿค– Running flink-flow + +```sh +โ–บ INSERT-TEXT +``` + +### ๐Ÿงช Tests +```sh +โ–บ INSERT-TEXT +``` + +--- + + +## ๐Ÿ›ฃ Project Roadmap + +> - [X] `โ„น๏ธ Task 1: Implement X` +> - [ ] `โ„น๏ธ Task 2: Implement Y` +> - [ ] `โ„น๏ธ ...` + + +--- + +## ๐Ÿค Contributing + +[**Discussions**](https://github.com/local/flink-flow/discussions) + - Join the discussion here. + +[**New Issue**](https://github.com/local/flink-flow/issues) + - Report a bug or request a feature here. + +[**Contributing Guidelines**](https://github.com/local/flink-flow/blob/main/CONTRIBUTING.md) + +- Contributions are welcome! Please follow these steps: + +1. Fork the project repository to your GitHub account. +2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop. +3. Create a new branch with a descriptive such as `new-feature-x` or `bugfix-issue-x`. +```sh +git checkout -b new-feature-x +``` +4. Develop your changes locally. +5. Commit your updates with a clear explanation of the changes you've made. +```sh +git commit -m 'Implemented new feature.' +``` +6. Push your changes to your forked repository on GitHub. +```sh +git push origin new-feature-x +``` +7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. +8. Once your pull request is reviewed, it will be merged into the main branch of the project repository. + +--- + +## ๐Ÿ“„ License + + +This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file. + +--- + +## ๐Ÿ‘ Acknowledgments + +- List any resources, contributors, inspiration, etc. here. + +[**Return**](#Top) + +--- diff --git a/pyproject.toml b/pyproject.toml index c995553c..4be89df0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "readmeai" -version = "0.4.032" +version = "0.4.034" description = "Generate beautiful README.md files from the terminal, powered by AI." authors = ["Eli <0x.eli.64s@gmail.com>"] license = "MIT"