Skip to content

Commit

Permalink
Project clean up.
Browse files Browse the repository at this point in the history
  • Loading branch information
@eli64s
eli64s committed Oct 27, 2024
1 parent 6482988 commit b64204b
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 66 deletions.
51 changes: 19 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-animated.svg" alt="readme-ai-banner-logo" width="100%">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-cosmic.svg" alt="readme-ai-banner-logo" width="100%">
</p>

<p align="center">
Expand Down Expand Up @@ -91,92 +91,79 @@ Let's take a look at some possible customizations created by readme-ai:
</tr>
<!-- ROW -->
<tr>
<td colspan="2" align="center"><br>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/compact.png" alt="compact-readme-header" width="700">
<td colspan="2" align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/examples/toc/roman-numeral.png" alt="docker-go-readme-example" width="700">
<br>
<code>--image cloud --header-style compact --toc-style fold</code>
<code>--badge-color 00ADD8 --badge-style for-the-badge --header-style modern --toc-style roman</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td colspan="2" align="center"><br>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/svg-banner.png" alt="svg-" width="700">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/ascii.png" alt="ascii-readme-header-style" width="700">
<br>
<code>--badge-style for-the-badge --header-style svg</code>
<code>--header-style ascii</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/ascii.png" alt="ascii-readme-header-style" width="450">
<br>
<code>--header-style ascii</code>
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/ascii-box.png" alt="ascii-box-readme-header-style" width="450">
<td colspan="2" align="center"><br>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/svg-banner.png" alt="svg-" width="700">
<br>
<code>--header-style ascii_box</code>
<code>--badge-style for-the-badge --header-style svg</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/cloud.png" alt="readme-header-with-cloud-logo" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/cloud.png" alt="readme-header-with-cloud-logo" width="350">
<br>
<code>--align left --badge-style flat-square --image cloud</code>
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/gradient.png" alt="readme-header-with-gradient-markdown-logo" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/gradient.png" alt="readme-header-with-gradient-markdown-logo" width="350">
<br>
<code>--align left --badge-style flat --image gradient</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/custom-balloon.png" alt="custom-balloon-project-logo" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/custom-balloon.png" alt="custom-balloon-project-logo" width="350">
<br>
<code>--badge-style flat --image custom</code>
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/skill-icons-light.png" alt="readme-header-with-skill-icons-light" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/skill-icons-light.png" alt="readme-header-with-skill-icons-light" width="350">
<br>
<code>--badge-style skills-light --image grey</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/blue.png" alt="readme-header-with-blue-markdown-logo" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/blue.png" alt="readme-header-with-blue-markdown-logo" width="350">
<br>
<code>--badge-style flat-square</code>
</td>
<td align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/black.png" alt="readme-header-with-black-readme-logo" width="450">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/black.png" alt="readme-header-with-black-readme-logo" width="350">
<br>
<code>--badge-style flat --image black</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td colspan="2" align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/custom-database.png" alt="custom-database-project-logo" width="900">
<br>
<code>--image custom --badge-color 00ffe9 --badge-style flat-square --header-style classic</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td colspan="2" align="center">
<img src="https://github.com/eli64s/readme-ai/blob/main/docs/docs/assets/img/headers/dalle.png" alt="llm-generated-project-logo" width="900">
<td colspan="2" align="center"><br>
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/img/headers/compact.png" alt="compact-readme-header" width="700">
<br>
<code>--image llm --badge-style plastic --header-style classic</code>
<code>--image cloud --header-style compact --toc-style fold</code>
</td>
</tr>
<!-- ROW -->
<tr>
<td colspan="2" align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/modern-flat-square.png" alt="readme-header-style-modern" width="900">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/refs/heads/main/docs/docs/assets/img/headers/modern-flat-square.png" alt="readme-header-style-modern" width="700">
<br>
<code>-i custom -bc BA0098 -bs flat-square -hs modern -ts fold</code>
</td>
Expand Down
Binary file modified docs/docs/assets/img/headers/ascii.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions docs/docs/assets/svg/readme-ai-cosmic.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/toc/fold.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/toc/links.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/toc/number.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/toc/roman-numeral.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions readmeai/config/settings.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import sys
from pathlib import Path
from typing import Literal, Self
from typing import Literal

from pydantic import (
AnyHttpUrl,
Expand Down Expand Up @@ -93,7 +93,7 @@ def validate_repository(cls, value: Path | str) -> Path | str:
) from exc

@model_validator(mode="after")
def set_git_attributes(self) -> Self:
def set_git_attributes(self):
"""Parse and set Git repository attributes."""
self.host_domain, self.host, self.name, self.full_name = parse_git_url(
str(self.repository)
Expand Down
43 changes: 22 additions & 21 deletions setup/requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,53 @@
aiohappyeyeballs==2.4.3 ; python_version >= "3.9" and python_version < "4.0"
aiohttp==3.10.9 ; python_version >= "3.9" and python_version < "4.0"
aiohttp==3.10.10 ; python_version >= "3.9" and python_version < "4.0"
aiosignal==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
annotated-types==0.7.0 ; python_version >= "3.9" and python_version < "4.0"
anthropic==0.35.0 ; python_version >= "3.9" and python_version < "4.0"
anyio==4.6.0 ; python_version >= "3.9" and python_version < "4.0"
anthropic==0.37.1 ; python_version >= "3.9" and python_version < "4.0"
anyio==4.6.2.post1 ; python_version >= "3.9" and python_version < "4.0"
async-timeout==4.0.3 ; python_version >= "3.9" and python_version < "3.11"
attrs==24.2.0 ; python_version >= "3.9" and python_version < "4.0"
cachetools==5.5.0 ; python_version >= "3.9" and python_version < "4.0"
certifi==2024.8.30 ; python_version >= "3.9" and python_version < "4.0"
charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "4.0"
charset-normalizer==3.4.0 ; python_version >= "3.9" and python_version < "4.0"
click==8.1.7 ; python_version >= "3.9" and python_version < "4.0"
colorama==0.4.6 ; python_version >= "3.9" and python_version < "4.0" and platform_system == "Windows"
distro==1.9.0 ; python_version >= "3.9" and python_version < "4.0"
exceptiongroup==1.2.2 ; python_version >= "3.9" and python_version < "3.11"
filelock==3.16.1 ; python_version >= "3.9" and python_version < "4.0"
frozenlist==1.4.1 ; python_version >= "3.9" and python_version < "4.0"
fsspec==2024.9.0 ; python_version >= "3.9" and python_version < "4.0"
frozenlist==1.5.0 ; python_version >= "3.9" and python_version < "4.0"
fsspec==2024.10.0 ; python_version >= "3.9" and python_version < "4.0"
gitdb==4.0.11 ; python_version >= "3.9" and python_version < "4.0"
gitpython==3.1.43 ; python_version >= "3.9" and python_version < "4.0"
google-ai-generativelanguage==0.6.10 ; python_version >= "3.9" and python_version < "4.0"
google-api-core==2.20.0 ; python_version >= "3.9" and python_version < "4.0"
google-api-core[grpc]==2.20.0 ; python_version >= "3.9" and python_version < "4.0"
google-api-python-client==2.147.0 ; python_version >= "3.9" and python_version < "4.0"
google-api-core==2.21.0 ; python_version >= "3.9" and python_version < "4.0"
google-api-core[grpc]==2.21.0 ; python_version >= "3.9" and python_version < "4.0"
google-api-python-client==2.149.0 ; python_version >= "3.9" and python_version < "4.0"
google-auth-httplib2==0.2.0 ; python_version >= "3.9" and python_version < "4.0"
google-auth==2.35.0 ; python_version >= "3.9" and python_version < "4.0"
google-generativeai==0.8.2 ; python_version >= "3.9" and python_version < "4.0"
google-generativeai==0.8.3 ; python_version >= "3.9" and python_version < "4.0"
googleapis-common-protos==1.65.0 ; python_version >= "3.9" and python_version < "4.0"
grpcio-status==1.66.2 ; python_version >= "3.9" and python_version < "4.0"
grpcio==1.66.2 ; python_version >= "3.9" and python_version < "4.0"
grpcio-status==1.67.0 ; python_version >= "3.9" and python_version < "4.0"
grpcio==1.67.0 ; python_version >= "3.9" and python_version < "4.0"
h11==0.14.0 ; python_version >= "3.9" and python_version < "4.0"
httpcore==1.0.6 ; python_version >= "3.9" and python_version < "4.0"
httplib2==0.22.0 ; python_version >= "3.9" and python_version < "4.0"
httpx==0.27.2 ; python_version >= "3.9" and python_version < "4.0"
huggingface-hub==0.25.1 ; python_version >= "3.9" and python_version < "4.0"
huggingface-hub==0.26.1 ; python_version >= "3.9" and python_version < "4.0"
idna==3.10 ; python_version >= "3.9" and python_version < "4.0"
jiter==0.5.0 ; python_version >= "3.9" and python_version < "4.0"
jiter==0.6.1 ; python_version >= "3.9" and python_version < "4.0"
multidict==6.1.0 ; python_version >= "3.9" and python_version < "4.0"
openai==1.51.0 ; python_version >= "3.9" and python_version < "4.0"
openai==1.52.2 ; python_version >= "3.9" and python_version < "4.0"
packaging==24.1 ; python_version >= "3.9" and python_version < "4.0"
proto-plus==1.24.0 ; python_version >= "3.9" and python_version < "4.0"
protobuf==5.28.2 ; python_version >= "3.9" and python_version < "4.0"
propcache==0.2.0 ; python_version >= "3.9" and python_version < "4.0"
proto-plus==1.25.0 ; python_version >= "3.9" and python_version < "4.0"
protobuf==5.28.3 ; python_version >= "3.9" and python_version < "4.0"
pyasn1-modules==0.4.1 ; python_version >= "3.9" and python_version < "4.0"
pyasn1==0.6.1 ; python_version >= "3.9" and python_version < "4.0"
pydantic-core==2.23.4 ; python_version >= "3.9" and python_version < "4.0"
pydantic-extra-types==2.9.0 ; python_version >= "3.9" and python_version < "4.0"
pydantic-settings==2.5.2 ; python_version >= "3.9" and python_version < "4.0"
pydantic-settings==2.6.0 ; python_version >= "3.9" and python_version < "4.0"
pydantic==2.9.2 ; python_version >= "3.9" and python_version < "4.0"
pyparsing==3.1.4 ; python_version >= "3.9" and python_version < "4.0"
pyparsing==3.2.0 ; python_version >= "3.9" and python_version < "4.0"
python-dotenv==1.0.1 ; python_version >= "3.9" and python_version < "4.0"
pyyaml==6.0.2 ; python_version >= "3.9" and python_version < "4.0"
regex==2024.9.11 ; python_version >= "3.9" and python_version < "4.0"
Expand All @@ -57,10 +58,10 @@ sniffio==1.3.1 ; python_version >= "3.9" and python_version < "4.0"
structlog==24.4.0 ; python_version >= "3.9" and python_version < "4.0"
tenacity==8.5.0 ; python_version >= "3.9" and python_version < "4.0"
tiktoken==0.4.0 ; python_version >= "3.9" and python_version < "4.0"
tokenizers==0.20.0 ; python_version >= "3.9" and python_version < "4.0"
tokenizers==0.20.1 ; python_version >= "3.9" and python_version < "4.0"
tomli==2.0.2 ; python_version >= "3.9" and python_version < "3.11"
tqdm==4.66.5 ; python_version >= "3.9" and python_version < "4.0"
typing-extensions==4.12.2 ; python_version >= "3.9" and python_version < "4.0"
uritemplate==4.1.1 ; python_version >= "3.9" and python_version < "4.0"
urllib3==2.2.3 ; python_version >= "3.9" and python_version < "4.0"
yarl==1.13.1 ; python_version >= "3.9" and python_version < "4.0"
yarl==1.16.0 ; python_version >= "3.9" and python_version < "4.0"

0 comments on commit b64204b

Please sign in to comment.