Skip to content

Commit 5fbdb10

Browse files
✅ Ready to clone and code.
1 parent 0943905 commit 5fbdb10

File tree

15 files changed

+30
-31
lines changed

15 files changed

+30
-31
lines changed

.github/rename_project.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ echo "Description: $description";
1717
echo "Renaming project..."
1818

1919
original_author="UKPLab"
20-
original_name="ukp_project_template"
21-
original_urlname="ukp-project-template"
22-
original_description="The official template for new Python projects at UKP Lab"
20+
original_name="arxiv2025_repa_prm"
21+
original_urlname="arxiv2025-repa-prm"
22+
original_description="Awesome arxiv2025_repa_prm created by UKPLab"
2323
# Iterate over all files in the repository
2424
git ls-files | while read -r filename; do
2525
# Exclude .github/workflows/rename_project.yml from renaming

.github/template.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,4 @@ dmypy.json
136136

137137
# Project files
138138
sketch*
139-
ukp_project_template/sketch*
139+
arxiv2025_repa_prm/sketch*

ABOUT_THIS_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ It includes:
88
- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org);
99
- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/);
1010
- ✅ Code linting using [pylint](https://pypi.org/project/pylint/);
11-
- 🎯 Entry points to execute your program using `python -m <ukp_project_template>` with basic CLI argument parsing;
12-
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project;
11+
- 🎯 Entry points to execute your program using `python -m <arxiv2025_repa_prm>` with basic CLI argument parsing;
12+
- 🔄 Continuous integration using [Github Actions](https://github.com/UKPLab/arxiv2025-repa-prm/actions) with jobs to check, lint and test your project;
1313
- 🌐 An out-of-the-box project page created automatically for your project.
1414

1515
Are there any changes you'd like to request? Feel free to fork and open a pull request!
@@ -49,7 +49,7 @@ Lets take a look at the structure of this template:
4949
5050
├───static # Images & CSS files to generate the project page
5151
52-
├───ukp_project_template # The main python package for the project
52+
├───arxiv2025_repa_prm # The main python package for the project
5353
│ base.py # The base module for the project
5454
│ cli.py # Defines CLI instructions
5555
│ __init__.py # This tells Python that this is a package
@@ -69,7 +69,7 @@ First, you should change the content of `index.html` to fit your needs. Some tin
6969

7070
### Where should I add new stuff ?
7171

72-
You should create new files and subpackages inside ukp_project_template and implement your functionalities there. Remember to add what you write to `__init__.py` so that the imports work smoothly. Take a look at `base.py` and `__init__.py` to understand how it works.
72+
You should create new files and subpackages inside arxiv2025_repa_prm and implement your functionalities there. Remember to add what you write to `__init__.py` so that the imports work smoothly. Take a look at `base.py` and `__init__.py` to understand how it works.
7373

7474
### Why is `requirements.txt` empty ?
7575

@@ -85,7 +85,7 @@ This file lists all the requirements for testing and development. Use it to sepa
8585

8686
### What is the `.github` folder?
8787

88-
It contains [GitHub Actions](https://docs.github.com/en/actions) that are executed automatically when pushing your code. You can see results for your repository [here](https://github.com/UKPLab/ukp-project-template/actions).
88+
It contains [GitHub Actions](https://docs.github.com/en/actions) that are executed automatically when pushing your code. You can see results for your repository [here](https://github.com/UKPLab/arxiv2025-repa-prm/actions).
8989

9090
### What does the linter workflow do?
9191

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
<img src='logo.png' width='200'>
33
</p>
44

5-
# ukp_project_template
5+
# arxiv2025_repa_prm
66
[![Arxiv](https://img.shields.io/badge/Arxiv-YYMM.NNNNN-red?style=flat-square&logo=arxiv&logoColor=white)](https://put-here-your-paper.com)
7-
[![License](https://img.shields.io/github/license/UKPLab/ukp-project-template)](https://opensource.org/licenses/Apache-2.0)
7+
[![License](https://img.shields.io/github/license/UKPLab/arxiv2025-repa-prm)](https://opensource.org/licenses/Apache-2.0)
88
[![Python Versions](https://img.shields.io/badge/Python-3.9-blue.svg?style=flat&logo=python&logoColor=white)](https://www.python.org/)
9-
[![CI](https://github.com/UKPLab/ukp-project-template/actions/workflows/main.yml/badge.svg)](https://github.com/UKPLab/ukp-project-template/actions/workflows/main.yml)
9+
[![CI](https://github.com/UKPLab/arxiv2025-repa-prm/actions/workflows/main.yml/badge.svg)](https://github.com/UKPLab/arxiv2025-repa-prm/actions/workflows/main.yml)
1010

1111
This is the official template for new Python projects at UKP Lab. It was adapted for the needs of UKP Lab from the excellent [python-project-template](https://github.com/rochacbruno/python-project-template/) by [rochacbruno](https://github.com/rochacbruno).
1212

@@ -49,7 +49,7 @@ pip install -r requirements-dev.txt # Only needed for development
4949

5050
### Using the classes
5151

52-
To import classes/methods of `ukp_project_template` from inside the package itself you can use relative imports:
52+
To import classes/methods of `arxiv2025_repa_prm` from inside the package itself you can use relative imports:
5353

5454
```py
5555
from .base import BaseClass # Notice how I omit the package name
@@ -60,19 +60,19 @@ BaseClass().something()
6060
To import classes/methods from outside the package (e.g. when you want to use the package in some other project) you can instead refer to the package name:
6161

6262
```py
63-
from ukp_project_template import BaseClass # Notice how I omit the file name
64-
from ukp_project_template.subpackage import SubPackageClass # Here it's necessary because it's a subpackage
63+
from arxiv2025_repa_prm import BaseClass # Notice how I omit the file name
64+
from arxiv2025_repa_prm.subpackage import SubPackageClass # Here it's necessary because it's a subpackage
6565

6666
BaseClass().something()
6767
SubPackageClass().something()
6868
```
6969

7070
### Using scripts
7171

72-
This is how you can use `ukp_project_template` from command line:
72+
This is how you can use `arxiv2025_repa_prm` from command line:
7373

7474
```bash
75-
$ python -m ukp_project_template
75+
$ python -m arxiv2025_repa_prm
7676
```
7777

7878
### Expected results
File renamed without changes.

ukp_project_template/__main__.py renamed to arxiv2025_repa_prm/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Entry point for ukp_project_template."""
1+
"""Entry point for arxiv2025_repa_prm."""
22

33
from .cli import main # pragma: no cover
44

File renamed without changes.

ukp_project_template/cli.py renamed to arxiv2025_repa_prm/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""CLI interface for ukp_project_template project.
1+
"""CLI interface for arxiv2025_repa_prm project.
22
33
Be creative! do whatever you want!
44
@@ -13,7 +13,7 @@
1313
def main(): # pragma: no cover
1414
"""
1515
The main function executes on commands:
16-
`python -m ukp_project_template` and `$ ukp_project_template `.
16+
`python -m arxiv2025_repa_prm` and `$ arxiv2025_repa_prm `.
1717
1818
This is your program's entry point.
1919

0 commit comments

Comments
 (0)