Rename from example_project to template_project

OpenSourceEconomics · Jun 23, 2024 · 5fa308f · 5fa308f
1 parent 78c6719
commit 5fa308f
Show file tree

Hide file tree

Showing 35 changed files with 85 additions and 79 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -80,7 +80,7 @@ repos:
     rev: 0.7.17
     hooks:
       - id: mdformat
-        additional_dependencies: [mdformat-gfm, mdformat-black]
+        additional_dependencies: [mdformat-gfm, mdformat-gfm-alerts, mdformat-black]
         args: [--wrap, '88']
         files: (README\.md)
   - repo: https://github.com/executablebooks/mdformat

diff --git a/CITATION b/CITATION
@@ -1,6 +1,6 @@
-@Unpublished{ExampleProject,
-    Title  = Example Project,
-    Author = Hans-Martin von Gaudecker,
-    Year   = 2024,
-    Url    = https://github.com/opensourceeconomics/econ-project-templates,
+@Unpublished{Gaudecker2024,
+    Title  = "Example Project",
+    Author = "Hans-Martin von Gaudecker",
+    Year   = "2024",
+    Url    = "https://github.com/opensourceeconomics/econ-project-templates",
 }
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -3,7 +3,6 @@ include LICENSE
 
 exclude *.yaml
 exclude *.yml
-exclude tox.ini
 
 prune docs
 prune tests
diff --git a/README-upper.md b/README-upper.md
diff --git a/README.md b/README.md
@@ -1,21 +1,61 @@
-# Example Project
+# Templates for Reproducible Research Projects in Economics
+
+![MIT license](https://img.shields.io/github/license/OpenSourceEconomics/econ-project-templates)
+[![image](https://zenodo.org/badge/14557543.svg)](https://zenodo.org/badge/latestdoi/14557543)
+[![Documentation Status](https://readthedocs.org/projects/econ-project-templates/badge/?version=stable)](https://econ-project-templates.readthedocs.io/en/stable/)
+[![image](https://github.com/OpenSourceEconomics/econ-project-templates/actions/workflows/main.yml/badge.svg)](https://github.com/OpenSourceEconomics/econ-project-templates/actions/workflows/main.yml)
+[![image](https://codecov.io/gh/OpenSourceEconomics/econ-project-templates/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenSourceEconomics/econ-project-templates)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/OpenSourceEconomics/econ-project-templates/main.svg)](https://results.pre-commit.ci/latest/github/OpenSourceEconomics/econ-project-templates/main)
+[![image](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+This project aims to provide a project template for economists that makes it easy to
+produce reproducible research using one or more of the most frequently used programming
+languages in economics (i.e Python, R, Julia, Stata).
+
+> [!NOTE]
+> While the underlying architecture supports all of the listed programming languages,
+> the template project currently only implements a Python and R version.
+
+Users and curious visitors please take a look at the
+[documentation](https://econ-project-templates.readthedocs.io/en/stable/).
 
 ## Usage
 
 To get started, create and activate the environment with
 
 ```console
 $ conda/mamba env create
-$ conda activate example_project
+$ conda activate template_project
 ```
 
-To build the project, type
+To build the template project, type
 
 ```console
 $ pytask
 ```
 
-## Credits
+### Transferring your own project
+
+Open an editor and look for the template project name `"template_project"`. Replace this
+with the name of your project.
+
+You can now add new files to the project and remove the template files.
+
+## Contributing
+
+We welcome suggestions on anything: improving the documentation, bug reports, feature
+requests. Please open an
+[issue](https://github.com/OpenSourceEconomics/econ-project-templates/issues) in these
+cases.
+
+If you want to work on a specific feature, we are more than happy to get you started!
+Please [get in touch briefly](https://www.wiwi.uni-bonn.de/gaudecker), this is a small
+team so there is no need for a detailed formal process.
+
+### Contributors
+
+@hmgaudecker @timmens @tobiasraabe @mj023
+
+### Former Contributors
 
-This project was created using the
-[econ-project-templates](https://github.com/OpenSourceEconomics/econ-project-templates).
+@janosg @PKEuS @philippmuller @julienschat @raholler
diff --git a/docs/source/development/how-to-contribute.md b/docs/source/development/how-to-contribute.md
@@ -75,7 +75,7 @@ for some immediate and clearly defined tasks.
 ## Working on the inner project
 
 We differentiate between the *inner project*, which is the example project located in
-example_project, and the *outer project*, which is everything else.
+template_project, and the *outer project*, which is everything else.
 
 To work on the inner project we recommend the following workflow:
 
@@ -90,4 +90,4 @@ To work on the inner project we recommend the following workflow:
 1. Repeat step 3
 
 1. Transfer changes to the official repository by changing example names to
-   example_project etc.
+   template_project etc.
diff --git a/environment.yml b/environment.yml
@@ -1,5 +1,5 @@
 ---
-name: example_project
+name: template_project
 channels: [conda-forge, r, nodefaults]
 dependencies:
   - r-plyr

diff --git a/paper/task_paper.py b/paper/task_paper.py
@@ -3,10 +3,10 @@
 import shutil
 
 import pytask
-from example_project.config import BLD, PAPER_DIR
 from pytask_latex import compilation_steps as cs
+from template_project.config import BLD, PAPER_DIR
 
-documents = ["example_project", "example_project_pres"]
+documents = ["template_project", "template_project_pres"]
 
 for document in documents:
 

diff --git a/paper/example_project.tex → paper/template_project.tex b/paper/example_project.tex → paper/template_project.tex
diff --git a/paper/example_project_pres.tex → paper/template_project_pres.tex b/paper/example_project_pres.tex → paper/template_project_pres.tex
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,29 +2,32 @@
 requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"]
 
 [tool.setuptools_scm]
-write_to = "src/example_project/_version.py"
+write_to = "src/template_project/_version.py"
 
 [tool.pytask.ini_options]
-paths = ["./src/example_project", "./paper"]
+paths = ["./src/template_project", "./paper"]
 pdbcls = "pdbp:Pdb"
 
 [tool.ruff]
-target-version = "py311"
-select = ["ALL"]
+target-version = "py312"
 fix = true
+
+
+[tool.ruff.lint]
+select = ["ALL"]
 extend-ignore = [
     "S101",  # Use of `assert` detected.
     "ANN",  # Missing type annotations
     "D100",  # Missing docstring in public module
     "D104",  # Missing docstring in public package (__init__.py files)
 ]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/*" = ["D", "PD011"]
 "task_*.py" = ["ANN", "ARG001"]
 "docs/**/task_*.py" = ["D103", "S603"]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
 

diff --git a/setup.cfg b/setup.cfg
@@ -1,7 +1,7 @@
 [metadata]
-name = example_project
+name = template_project
 description = Example project
-long_description = file: README-upper.md
+long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/OpenSourceEconomics/econ-project-templates
 author = Hans-Martin von Gaudecker
@@ -38,4 +38,4 @@ where = src
 
 [check-manifest]
 ignore =
-    src/example_project/_version.py
+    src/template_project/_version.py
diff --git a/src/example_project/__init__.py → src/template_project/__init__.py b/src/example_project/__init__.py → src/template_project/__init__.py
diff --git a/src/example_project/analysis/__init__.py → src/template_project/analysis/__init__.py b/src/example_project/analysis/__init__.py → src/template_project/analysis/__init__.py
diff --git a/src/example_project/analysis/model.py → src/template_project/analysis/model.py b/src/example_project/analysis/model.py → src/template_project/analysis/model.py
diff --git a/src/example_project/analysis/model.r → src/template_project/analysis/model.r b/src/example_project/analysis/model.r → src/template_project/analysis/model.r
diff --git a/src/example_project/analysis/predict.py → src/template_project/analysis/predict.py b/src/example_project/analysis/predict.py → src/template_project/analysis/predict.py
diff --git a/src/example_project/analysis/predict.r → src/template_project/analysis/predict.r b/src/example_project/analysis/predict.r → src/template_project/analysis/predict.r
diff --git a/...example_project/analysis/task_analysis.py → ...emplate_project/analysis/task_analysis.py b/...example_project/analysis/task_analysis.py → ...emplate_project/analysis/task_analysis.py
@@ -5,10 +5,10 @@
 import pandas as pd
 import pytask
 
-from example_project.analysis.model import fit_logit_model, load_model
-from example_project.analysis.predict import predict_prob_by_age
-from example_project.config import BLD, GROUPS, SRC
-from example_project.utilities import read_yaml
+from template_project.analysis.model import fit_logit_model, load_model
+from template_project.analysis.predict import predict_prob_by_age
+from template_project.config import BLD, GROUPS, SRC
+from template_project.utilities import read_yaml
 
 
 def task_fit_model_python(

diff --git a/src/example_project/config.py → src/template_project/config.py b/src/example_project/config.py → src/template_project/config.py
diff --git a/src/example_project/data/data.csv → src/template_project/data/data.csv b/src/example_project/data/data.csv → src/template_project/data/data.csv
diff --git a/...ample_project/data_management/__init__.py → ...plate_project/data_management/__init__.py b/...ample_project/data_management/__init__.py → ...plate_project/data_management/__init__.py
diff --git a/...ple_project/data_management/clean_data.py → ...ate_project/data_management/clean_data.py b/...ple_project/data_management/clean_data.py → ...ate_project/data_management/clean_data.py
diff --git a/...mple_project/data_management/clean_data.r → ...late_project/data_management/clean_data.r b/...mple_project/data_management/clean_data.r → ...late_project/data_management/clean_data.r
diff --git a/...le_project/data_management/data_info.yaml → ...te_project/data_management/data_info.yaml b/...le_project/data_management/data_info.yaml → ...te_project/data_management/data_info.yaml
diff --git a/...t/data_management/task_data_management.py → ...t/data_management/task_data_management.py b/...t/data_management/task_data_management.py → ...t/data_management/task_data_management.py
@@ -5,9 +5,9 @@
 import pandas as pd
 import pytask
 
-from example_project.config import BLD, SRC
-from example_project.data_management.clean_data import clean_data
-from example_project.utilities import read_yaml
+from template_project.config import BLD, SRC
+from template_project.data_management.clean_data import clean_data
+from template_project.utilities import read_yaml
 
 
 def task_clean_data_python(

diff --git a/src/example_project/final/__init__.py → src/template_project/final/__init__.py b/src/example_project/final/__init__.py → src/template_project/final/__init__.py
diff --git a/...e_project/final/create_estimation_table.r → ...e_project/final/create_estimation_table.r b/...e_project/final/create_estimation_table.r → ...e_project/final/create_estimation_table.r
diff --git a/src/example_project/final/plot.py → src/template_project/final/plot.py b/src/example_project/final/plot.py → src/template_project/final/plot.py
diff --git a/src/example_project/final/plot_regression.r → src/template_project/final/plot_regression.r b/src/example_project/final/plot_regression.r → src/template_project/final/plot_regression.r
diff --git a/src/example_project/final/task_final.py → src/template_project/final/task_final.py b/src/example_project/final/task_final.py → src/template_project/final/task_final.py
@@ -5,10 +5,10 @@
 import pandas as pd
 import pytask
 
-from example_project.analysis.model import load_model
-from example_project.config import BLD, GROUPS, SRC
-from example_project.final.plot import plot_regression_by_age
-from example_project.utilities import read_yaml
+from template_project.analysis.model import load_model
+from template_project.config import BLD, GROUPS, SRC
+from template_project.final.plot import plot_regression_by_age
+from template_project.utilities import read_yaml
 
 for group in GROUPS:
     deps = {

diff --git a/src/example_project/utilities.py → src/template_project/utilities.py b/src/example_project/utilities.py → src/template_project/utilities.py
diff --git a/tests/analysis/test_model.py b/tests/analysis/test_model.py
@@ -3,7 +3,7 @@
 import numpy as np
 import pandas as pd
 import pytest
-from example_project.analysis.model import fit_logit_model
+from template_project.analysis.model import fit_logit_model
 
 DESIRED_PRECISION = 10e-2
 

diff --git a/tests/analysis/test_predict.py b/tests/analysis/test_predict.py
@@ -2,8 +2,8 @@
 
 import pandas as pd
 import pytest
-from example_project.analysis.predict import predict_prob_by_age
 from pandas.testing import assert_frame_equal
+from template_project.analysis.predict import predict_prob_by_age
 
 
 @pytest.fixture()

diff --git a/tests/data_management/test_clean_data.py b/tests/data_management/test_clean_data.py
@@ -1,9 +1,9 @@
 import numpy as np
 import pandas as pd
 import pytest
-from example_project.config import TEST_DIR
-from example_project.data_management.clean_data import clean_data
-from example_project.utilities import read_yaml
+from template_project.config import TEST_DIR
+from template_project.data_management.clean_data import clean_data
+from template_project.utilities import read_yaml
 
 
 @pytest.fixture()