Add .gitignore to generated projects

Closes #14

Author: dbanty

.gitignore

@@ -4,9 +4,6 @@ dist/
 *.egg-info/
 .pytest_cache/
 
-# Sphinx documentation
-docs/_build/
-
 # pyenv
 .python-version
 
@@ -22,7 +19,5 @@ dmypy.json
 # JetBrains
 .idea/
 
-# Terraform
-.terraform
 /coverage.xml
 /.coverage

openapi_python_client/__init__.py

@@ -110,6 +110,11 @@ def _build_metadata(self) -> None:
             )
         )
 
+        # .gitignore
+        git_ignore_path = self.project_dir / ".gitignore"
+        git_ignore_template = self.env.get_template(".gitignore")
+        git_ignore_path.write_text(git_ignore_template.render())
+
     def _build_models(self) -> None:
         # Generate models
         models_dir = self.package_dir / "models"

openapi_python_client/templates/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

tests/test___init__.py

@@ -1,5 +1,6 @@
 import pathlib
 
+import jinja2
 import pytest
 
 
@@ -205,18 +206,34 @@ def test__build_metadata(self, mocker):
 
         project = _Project(openapi=mocker.MagicMock(title="My Test API"))
         project.project_dir = mocker.MagicMock()
-        pyproject_path = mocker.MagicMock()
-        readme_path = mocker.MagicMock()
-        project.project_dir.__truediv__.side_effect = [pyproject_path, readme_path]
+        pyproject_path = mocker.MagicMock(autospec=pathlib.Path)
+        readme_path = mocker.MagicMock(autospec=pathlib.Path)
+        git_ignore_path = mocker.MagicMock(autospec=pathlib.Path)
+        paths = {
+            "pyproject.toml": pyproject_path,
+            "README.md": readme_path,
+            ".gitignore": git_ignore_path,
+        }
+        project.project_dir.__truediv__.side_effect = lambda x: paths[x]
 
-        pyproject_template = mocker.MagicMock()
-        readme_template = mocker.MagicMock()
-        project.env = mocker.MagicMock()
-        project.env.get_template.side_effect = [pyproject_template, readme_template]
+        pyproject_template = mocker.MagicMock(autospec=jinja2.Template)
+        readme_template = mocker.MagicMock(autospec=jinja2.Template)
+        git_ignore_template = mocker.MagicMock(autospec=jinja2.Template)
+        project.env = mocker.MagicMock(autospec=jinja2.Environment)
+        templates = {
+            "pyproject.toml": pyproject_template,
+            "README.md": readme_template,
+            ".gitignore": git_ignore_template,
+        }
+        project.env.get_template.side_effect = lambda x: templates[x]
 
         project._build_metadata()
 
-        project.env.get_template.assert_has_calls([mocker.call("pyproject.toml"), mocker.call("README.md")])
+        project.env.get_template.assert_has_calls([
+            mocker.call("pyproject.toml"),
+            mocker.call("README.md"),
+            mocker.call(".gitignore"),
+        ])
 
         pyproject_template.render.assert_called_once_with(
             project_name=project.project_name,
@@ -230,6 +247,8 @@ def test__build_metadata(self, mocker):
             package_name=project.package_name,
         )
         readme_path.write_text.assert_called_once_with(readme_template.render())
+        git_ignore_template.render.assert_called_once()
+        git_ignore_path.write_text.assert_called_once_with(git_ignore_template.render())
 
     def test__build_models(self, mocker):
         from openapi_python_client import _Project, OpenAPI