Skip to content

Commit 80a67b0

Browse files
MarenBermudezBoeckleMarenBermudezBoeckle
committed
Initialize template.
1 parent 254c3e4 commit 80a67b0

File tree

14 files changed

+158
-40
lines changed

14 files changed

+158
-40
lines changed

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎.gitignore‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717
# bld
1818
bld/
1919

20-
*.sav
21-
2220
# latex
2321
*.aux
2422
*.bbl
@@ -41,8 +39,3 @@ docs_template/scripts/latex/*.png
4139

4240
# local
4341
.vscode
44-
45-
46-
47-
# Notebook for Tests
48-
Maren_tests.ipynb

‎.pre-commit-config.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ repos:
1313
rev: v5.0.0
1414
hooks:
1515
- id: check-added-large-files
16-
args: [--maxkb=150]
16+
args: [--maxkb=25]
1717
- id: check-case-conflict
1818
- id: check-merge-conflict
1919
- id: check-vcs-permalinks
@@ -36,17 +36,17 @@ repos:
3636
rev: v1.35.1
3737
hooks:
3838
- id: yamllint
39-
#- repo: https://github.com/astral-sh/ruff-pre-commit
40-
# rev: v0.6.9
41-
# hooks:
42-
# # Run the linter.
43-
# - id: ruff
44-
# types_or: [python, jupyter]
45-
# args:
46-
# - --fix
39+
- repo: https://github.com/astral-sh/ruff-pre-commit
40+
rev: v0.6.9
41+
hooks:
42+
# Run the linter.
43+
- id: ruff
44+
types_or: [python, jupyter]
45+
args:
46+
- --fix
4747
# Run the formatter.
48-
# - id: ruff-format
49-
# types_or: [python, jupyter]
48+
- id: ruff-format
49+
types_or: [python, jupyter]
5050
- repo: https://github.com/kynan/nbstripout
5151
rev: 0.7.1
5252
hooks:

‎CHANGES_template.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Release Notes
2+
3+
## v0.8.4 -- October 2024
4+
5+
- Make hooks more permissive (docstrings, pandas naming, computing on return or not).
6+
- Docs: Replace `conda` by `mamba` where appropriate.
7+
8+
9+
## v0.8.3 -- October 2024
10+
11+
Display the correct version number in the rendered docs.
12+
13+
## v0.8.2 -- October 2024
14+
15+
- Just point to installation section of Effective Programming Practices for main installation part.
16+
- Remove all traces of Anaconda throughout, replace by Miniforge.
17+
18+
## v0.8.1 -- July 2024
19+
20+
Display the correct version number in the rendered docs.
21+
22+
## v0.8.0 -- July 2024
23+
24+
Complete re-write of how to obtain templates, simplifying the example project, and
25+
aligning the data management part with that of the newest EPP iteration.
26+
27+
- Remove cookiecutter (#149, @timmens, @hmgaudecker)
28+
- Update data management (#152, @timmens, @hmgaudecker)
29+
30+
## v0.7.1 -- December 2023
31+
32+
- Replace `Pdb++` by `Pdb+` (#142, @janosg).
33+
- Fix a problem with LaTeX paths, noted by Berlin students (#143).
34+
35+
## v0.7.0 -- October 2023
36+
37+
- Update required pytask to version 0.4 and adjust code accordingly (only Python
38+
example) (#139).
39+
- Pre-commit autoupdate / fix ruff complaints.
40+
41+
## v0.6.5 -- March 2023
42+
43+
Incorporate more feedback from EPP students, @janosg:
44+
45+
- Fix paths for LaTeX files (#133).
46+
- Fix GHA workflow (#134).
47+
- Pre-commit autoupdate / fix ruff complaints.
48+
- Use default sequence style of yamlfix.
49+
50+
## v0.6.3 -- January 2023
51+
52+
Incorporate more feedback from EPP students, @janosg:
53+
54+
- Do not add linters by default, but give an option to add them.
55+
- Add github actions back in, make codecov meaningful.
56+
57+
## v0.6.2 -- January 2023
58+
59+
Incorporate feedback from EPP students, @janosg, @tobiasraabe.
60+
61+
- Update warning message for R, better explanations for examples and links to issues.
62+
- Add scripts as explicit dependencies.
63+
- Use git_remote_url option again.
64+
- Add yaml linters, run them. Update versions of pre-commit hooks also in inner project.
65+
- Ditch flake8 in favor of ruff.
66+
- Get rid of refurb's complaints.
67+
- Ignore complexity in post_gen_project.
68+
69+
## v0.6 -- December 2022
70+
71+
- Add R example (#105, @carolinalvarez, @timmens)
72+
- Complete re-write of example, structure, docs (#98, #108, #111, #115, #118, #119, @timmens)
73+
- Convert Documentation from reST to Markdown (#117, @mj023)
74+
75+
## v0.5 -- January 2022
76+
77+
- Move to plotly (#92, @timmens)
78+
- Cleaning up (@hmgaudecker)
79+
80+
## v0.4 -- January 2021
81+
82+
- Move from Waf to Pytask (#86, @tobiasraabe, @hmgaudecker)
83+
- Move to GitHub Actions for CI (@janosg, WIP)
84+
85+
## v0.3 -- October 2019
86+
87+
- Much improved documentation (@raholler)
88+
- Extensive instructions for use on Windows (@raholler)
89+
- Reuse previously-entered data when cookiecutter fails
90+
(@tobiasraabe, @raholler)
91+
- Fix Stata template by setting <span
92+
class="title-ref">--shell-escape=1</span> (#63, @raholler)
93+
- Add pyupgrade to pre-commit hooks (#59)
94+
- Thanks to students at LMU for pointing lots of this out!
95+
96+
## v0.2 -- September 2019
97+
98+
- Full continuous integration testing on the Azure platform
99+
- R example completely working in Miniconda environment out of the
100+
box (@raholler)
101+
- Documentation for Stata / R examples (@raholler)
102+
- Much improved instructions for usage on Windows (@raholler)
103+
- Improved structure of docs
104+
105+
## v0.1 -- October 2018
106+
107+
- First version with cookiecutter (thanks, @tobiasraabe
108+
and @julienschat)
109+
- All the stuff that accumulated over the years with the help of many.
110+
I wish my memory was better so I would be able to list the
111+
contributions separately. Thanks, @PKEuS, @philippmuller,
112+
@julienschat, @janosg, @tdrerup and many more who provided feedback!

‎CITATION‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
@Unpublished{Bermudez2024,
2-
Title = "Security Analysis Chile",
3-
Author = "Maren Bermudez Boeckle",
1+
@Unpublished{DOE2024,
2+
Title = "EXAMPLE PROJECT",
3+
Author = "JANE DOE",
44
Year = "2024",
5-
Url = "https://github.com/iame-uni-bonn/final-project-MarenBermudezBoeckle.git",
5+
Url = "https://github.com/opensourceeconomics/econ-project-templates",
66
}

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025-, Maren Bermudez Boeckle
3+
Copyright (c) 2013-, Hans-Martin von Gaudecker
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this
66
software and associated documentation files (the "Software"), to deal in the Software

‎documents/paper.tex‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@
5959

6060
\begin{document}
6161

62-
\title{Security Analysis Chile}
63-
\thanks{University of Bonn. Email: janedoe[at]example-university.de}
62+
\title{EXAMPLE PROJECT}
63+
\thanks{EXAMPLE UNIVERSITY. Email: janedoe[at]example-university.de}
6464

65-
\author{Maren Bermudez Boeckle}
65+
\author{JANE DOE}
6666

6767
\date{
6868
{\bf Preliminary -- please do not quote}

‎documents/presentation.tex‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@
3434

3535
\begin{document}
3636

37-
\title{Security Analysis Chile}
37+
\title{EXAMPLE PROJECT}
3838

39-
\author[Maren Bermudez Boeckle]
39+
\author[JANE DOE]
4040
{
41-
{\bf Maren Bermudez Boeckle}\\
42-
{\small University of Bonn }\\[1ex]
41+
{\bf JANE DOE}\\
42+
{\small EXAMPLE UNIVERSITY }\\[1ex]
4343
}
4444

4545

‎environment.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ dependencies:
2424
- numpy
2525
- pandas >=2.2
2626
- plotly >=5.2.0,<6
27-
- tabula-py
2827

2928
# R template project dependencies
3029
- pytask-r >=0.4.1

‎pyproject.toml‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44

55
[project]
66
name = "project_mbb"
7-
description = "Project on Security and Security Perception in Chile"
7+
description = "Template for reproducible research projects in economics"
88
requires-python = ">=3.11"
99
dynamic = ["version"]
1010
keywords = [
1111
"Reproducible Research",
1212
"Economics",
13-
"Security",
14-
"Chile",
1513
]
1614
classifiers = [
1715
"Intended Audience :: Science/Research",
@@ -23,10 +21,10 @@ classifiers = [
2321
"Programming Language :: Python :: 3 :: Only",
2422
]
2523
authors = [
26-
{ name = "Maren Bermudez Boeckle", email = "maren.bermudez.b@gmail.com" },
24+
{ name = "JANE DOE", email = "janedoe@example-university.com" },
2725
]
2826
maintainers = [
29-
{ name = "Maren Bermudez Boeckle", email = "s47mberm@uni-bonn.de" },
27+
{ name = "JANE DOE", email = "janedoe@example-university.com" },
3028
]
3129

3230
[project.readme]
@@ -37,10 +35,10 @@ content-type = "text/markdown"
3735
text = "MIT"
3836

3937
[project.urls]
40-
Changelog = "https://github.com/iame-uni-bonn/final-project-MarenBermudezBoeckle.git"
41-
Documentation = "https://github.com/iame-uni-bonn/final-project-MarenBermudezBoeckle.git"
42-
Github = "https://github.com/iame-uni-bonn/final-project-MarenBermudezBoeckle.git"
43-
Tracker = "https://github.com/iame-uni-bonn/final-project-MarenBermudezBoeckle.git/issues"
38+
Changelog = "https://github.com/OpenSourceEconomics/econ-project-templates"
39+
Documentation = "https://github.com/OpenSourceEconomics/econ-project-templates"
40+
Github = "https://github.com/OpenSourceEconomics/econ-project-templates"
41+
Tracker = "https://github.com/OpenSourceEconomics/econ-project-templates/issues"
4442

4543
# ======================================================================================
4644
# Build system configuration

0 commit comments

Comments
 (0)