Add basic project setup

Author: rizerphe

.gitignore

@@ -0,0 +1,177 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+

README.md

@@ -0,0 +1,36 @@
+# create-readme
+
+create-readme is a tool that allows users to quickly and easily create README files with ChatGPT. By asking users a set of questions, create-readme generates a README based on the answers, eliminating the need to manually open OpenAI's website and type the prompt.
+
+## Key Features
+
+- Simple command-based interface for generating README files
+- Efficient and time-saving solution compared to manually typing prompts
+- Effortless use - the tool asks you questions, you don't have to worry about describing everything in detail to it
+
+## Installation
+
+To install create-readme, run the following command:
+
+```shell
+pipx install create-readme
+```
+
+## Usage
+
+To use create-readme, follow these steps:
+
+1. Open your terminal.
+2. Run the command:
+
+```shell
+create-readme my-awesome-project
+```
+
+3. Answer the prompted questions to provide the necessary information for the README file generation.
+4. Once you have answered all the questions, create-readme will generate a README file based on your inputs.
+
+## Example
+
+An example of a generated README is the file you're reading right now - it was manually cleaned up, but most of it is generated.
+

create_readme/__init__.py

@@ -0,0 +1,4 @@
+"""Generate READMEs."""
+from .generator import Generator
+
+__all__ = ["Generator"]

create_readme/generator.py

@@ -0,0 +1,177 @@
+"""Generate READMEs."""
+import contextlib
+import json
+import os
+
+import openai
+
+from .multiline_input import multiline_input
+from .prompts import Question, questions_prompt, readme_prompt
+
+
+class Generator:
+    """README generator."""
+
+    def __init__(
+        self,
+        project_name: str,
+        config_path: str | None = None,
+        model: str = "gpt-3.5-turbo-0613",
+    ):
+        """Initialize the generator.
+
+        Args:
+            project_name: The name of the project.
+        """
+        self.project_name = project_name
+        self.questions: list[Question] = []
+        self.config_path = config_path
+        self.model = model
+
+    @property
+    def config_file_path(self) -> str | None:
+        """Get the path to the configuration file.
+
+        Returns:
+            The path to the configuration file.
+        """
+        if not self.config_path:
+            return None
+        return self.config_path + f"/{self.project_name}.json"
+
+    def load_config(self):
+        """Load the configuration."""
+        if not self.config_file_path:
+            return
+        with contextlib.suppress(FileNotFoundError):
+            with open(self.config_file_path, "r", encoding="utf-8") as config_file:
+                config = json.load(config_file)
+            self.questions = [
+                Question(question=question["question"], answer=question["answer"])
+                for question in config["questions"]
+            ]
+
+    def save_config(self):
+        """Save the configuration."""
+        if not self.config_file_path:
+            return
+        with open(self.config_file_path, "w", encoding="utf-8") as config_file:
+            json.dump(
+                {"questions": [question.dict() for question in self.questions]},
+                config_file,
+            )
+
+    def ask_load(self):
+        """Ask the user if they want to load the configuration."""
+        if not self.config_file_path:
+            return
+        if not os.path.exists(self.config_file_path):
+            return
+        load = input(
+            "Would you like to load the configuration from a previous session? [Y/n] "
+        )
+        if load.lower() == "y":
+            self.load_config()
+
+    def generate_next_question(self) -> str:
+        """Generate the next question for the user to answer.
+
+        Returns:
+            A prompt for the user to answer.
+        """
+        prompt = questions_prompt(self.project_name, self.questions)
+        response = openai.ChatCompletion.create(
+            model=self.model,
+            messages=[
+                {
+                    "role": "system",
+                    "content": (
+                        "You are a README generator. "
+                        "You are helping a user write a README for "
+                        "their project. Your task is to ask the user "
+                        "questions about their project to help them "
+                        "write a comprehensive README. As a reminder, "
+                        "a README should not prioritize the technical "
+                        "details of my project. Instead, it should focus on "
+                        "the motivation for the project, the problem it "
+                        "solves, and how to use it."
+                    ),
+                },
+                {
+                    "role": "user",
+                    "content": prompt,
+                },
+            ],
+            functions=[
+                {
+                    "name": "ask_next_question",
+                    "description": "Ask the user the next question.",
+                    "parameters": {
+                        "type": "object",
+                        "properties": {
+                            "question": {
+                                "type": "string",
+                                "description": "The question to ask the user, "
+                                "for example, 'What is your project called?'",
+                            }
+                        },
+                        "required": ["question"],
+                    },
+                }
+            ],
+            function_call={"name": "ask_next_question"},
+        )
+        return json.loads(
+            response["choices"][0]["message"]["function_call"]["arguments"]
+        )["question"]
+
+    def ask_next_question(self) -> Question | None:
+        """Ask the user the next question.
+
+        Returns:
+            The question and answer.
+        """
+        question = self.generate_next_question()
+        answer = multiline_input(
+            question + " Leave empty to generate the README"
+        ).strip()
+        if not answer:
+            return None
+        return Question(question=question, answer=answer)
+
+    def generate_readme(self) -> str:
+        """Generate the README.
+
+        Returns:
+            The README.
+        """
+        prompt = readme_prompt(self.project_name, self.questions)
+        return openai.ChatCompletion.create(
+            model=self.model,
+            messages=[
+                {
+                    "role": "system",
+                    "content": (
+                        "You are a README generator. "
+                        "You are helping a user write a comprehensive "
+                        "README for their project. You shouldn't output "
+                        "any text other than the README itself, in Markdown."
+                    ),
+                },
+                {
+                    "role": "user",
+                    "content": prompt,
+                },
+            ],
+        )["choices"][0]["message"]["content"]
+
+    def run(self) -> str:
+        """Run the generator."""
+        self.ask_load()
+        while True:
+            question = self.ask_next_question()
+            if not question:
+                break
+            self.questions.append(question)
+            self.save_config()
+        return self.generate_readme()