readme ai
v0.1.6
Conçu pour la simplicité, la personnalisation et la productivité des développeurs.
Aperçu
Démo
Caractéristiques
Commencer
Configuration
Exemples
Contributif
Important
Visitez la documentation officielle pour des guides et tutoriels détaillés.
ReadMe-AI est un outil de développeur qui génère automatiquement des fichiers ReadMe Markdown à l'aide d'un moteur de traitement de référentiel robuste et de modèles de langage avancé. Fournissez simplement une URL ou un chemin vers votre base de code, et une lecture bien structurée et détaillée sera générée.
Pourquoi readme-ai?
Cet outil est conçu pour rationaliser le processus de documentation pour les développeurs, en gardant du temps et des efforts tout en garantissant des fichiers de réadme de haute qualité. Les principaux avantages comprennent:
Ai-propulsé: Tirez parti des modèles de langage pour la génération de contenu intelligente.
Cohérence: assurer une documentation propre et standardisée entre les projets.
Personnalisation: adaptez la sortie pour répondre aux exigences de votre projet.
Langue agnostique: fonctionne avec la plupart des langages de programmation / frameworks.
Gagnez du temps: générez des lectures complètes en moins d'une minute.
Exécution à partir de la ligne de commande:
En fonctionnant directement dans votre navigateur:
Documentation automatisée: générez automatiquement des fichiers de réadme complets à partir de votre base de code.
Sortie personnalisable: adaptez le style, la mise en forme, les badges, les conceptions d'en-tête et plus de préférences.
Backends flexibles: intégrer de manière transparente avec OpenAI , Ollama , Anthropic , Google Gemini .
Langue agnostique: compatible avec un large éventail de langages de programmation et de types de projets.
Mode hors ligne: Créez des fichiers ReadMe à passe-partout hors ligne, sans aucun appel API externe.
Meilleures pratiques: assure une documentation propre et professionnelle, adhérant aux meilleures pratiques de marque.
Jetons un coup d'œil à quelques personnalisations possibles créées par ReadMe-AI:
| Pépin Méthode recommandée pour la plupart des utilisateurs: ❯ PIP Installer Readmeai Pipx Utilisez PIPX pour utiliser ❯ Pipx Installer Readmeai UV Utilisez UV pour le moyen le plus rapide pour installer ❯ Tool UV Installer ReadMaia Docker Pour exécuter ❯ Docker tire Zeroxeli / Readme-ai: Dernière De la sourceCliquez pour étendre les instructions
Alternativement, le projet peut être configuré à l'aide du script bash ci-dessous: Frapper
Ou, utilisez Poésie
Important Pour utiliser les clients anthropiques et Google Gemini , des dépendances supplémentaires sont nécessaires. Installez le package avec les extras suivants:
? Courir la CLI1. Configurer des variables d'environnement Avec Openai: ❯ Exporter openai_api_key = <your_api_key> # ou pour les utilisateurs de Windows: ❯ Définissez Openai_API_KEY = <Your_API_KEY> Provideurs supplémentaires (Olllama, Anthropic, Google Gemini)OlllaReportez-vous à la documentation Olllama pour plus d'informations sur la création de l'API Olllama. Voici un exemple de base:
Anthropique
Google Gemini
2. Générez un Readme Exécutez la commande suivante, en remplaçant l'URL du référentiel par le vôtre: ❯ Readmeai --Repository https://github.com/eli64s/readme-ai --api openai Important Par défaut, le modèle Courez avec ❯ Readmeai --api ollama --model llama3 --repository https://github.com/eli64s/readme-ai Courez avec ❯ Readmeai --api Anthropic -M Claude-3-5-sonnet-20240620 -r https://github.com/eli64s/readme-ai Exécutez avec ❯ Readmeai --api Gemini -M Gemini-1.5-Flash -r https://github.com/eli64s/readme-ai Utilisez un chemin de répertoire readmeai --repository / path / to / votre / projet Ajouter plus d'options de personnalisation: ❯ Readmeai --Repository https://github.com/eli64s/readme-ai
--output readmeai.md
--api Openai
--model gpt-4
- Badge-Color A931EC
- Square plate de style badge
- Compact de style-tête
- pli de style toc
- Température 0.9
--Tree-Depth 2
--image llm
- emojisDockerExécutez le conteneur Docker avec le client OpenAI: ❯ docker run -it --rm
-e openai_api_key = $ openai_api_key
-v "$ (pwd)": / app zeroxeli / readme-ai: dernier
--Repository https://github.com/eli64s/readme-ai
--api OpenaiDe la sourceCliquez pour étendre les instructionsFrapperSi vous avez installé le projet à partir de Source avec le script bash, exécutez la commande suivante:
Poésie
RationaliserEssayez ReadMe-AI directement dans votre navigateur, aucune installation requise. Voir le référentiel ReadMe-AI-Streamlit pour plus de détails. EssaiLes cadres Pytest et NOx sont utilisés pour le développement et les tests. Installez les dépendances à l'aide de la poésie: ❯ Installation de la poésie - avec Dev, test Exécutez la suite de test unitaire à l'aide de PyTest: ❯ faire un test Exécutez la suite de test contre Python 3.9, 3.10, 3.11 et 3.12 en utilisant NOX: ❯ faire du test-nox Conseil NOX est un outil d'automatisation qui automatise les tests dans plusieurs environnements Python. Il est utilisé pour assurer la compatibilité entre différentes versions Python. ConfigurationPersonnalisez votre génération de lecture à l'aide de ces options CLI:
Exécutez la commande suivante pour afficher toutes les options disponibles: ❯ Readmeai - Help Visitez la documentation officielle pour des informations plus détaillées sur les options de configuration, les exemples et les meilleures pratiques. ExemplesAffichez l'exemple de fichiers de lecture générés par ReadMe-AI sur diverses piles technologiques:
Trouvez des exemples de lecture supplémentaires dans le répertoire des exemples. Feuille de route
ContributifLes contributions sont les bienvenues! Veuillez lire le guide contributif pour commencer.
Remerciements
Licence Copyright © 2023 Readme-AI. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
