From 80d7d85d6c95e204159d31c9461cb315fa62d6e3 Mon Sep 17 00:00:00 2001 From: "serviceosaurus[bot]" Date: Tue, 20 Aug 2024 03:45:43 +0000 Subject: [PATCH] =?UTF-8?q?=E2=9C=85=20Ready=20to=20clone=20and=20code.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/rename_project.sh | 6 +++--- .github/template.yml | 1 - .gitignore | 2 +- ABOUT_THIS_TEMPLATE.md | 10 +++++----- README.md | 16 ++++++++-------- .../__init__.py | 0 .../__main__.py | 2 +- .../base.py | 0 .../cli.py | 4 ++-- .../subpackage/__init__.py | 0 .../subpackage/subpackage.py | 0 docs/index.md | 2 +- mkdocs.yml | 4 ++-- setup.py | 10 +++++----- tests/test_base.py | 4 ++-- 15 files changed, 30 insertions(+), 31 deletions(-) delete mode 100644 .github/template.yml rename {ukp_project_template => arxiv2024_missciplus}/__init__.py (100%) rename {ukp_project_template => arxiv2024_missciplus}/__main__.py (69%) rename {ukp_project_template => arxiv2024_missciplus}/base.py (100%) rename {ukp_project_template => arxiv2024_missciplus}/cli.py (88%) rename {ukp_project_template => arxiv2024_missciplus}/subpackage/__init__.py (100%) rename {ukp_project_template => arxiv2024_missciplus}/subpackage/subpackage.py (100%) diff --git a/.github/rename_project.sh b/.github/rename_project.sh index 4459ea9..87ee7b7 100755 --- a/.github/rename_project.sh +++ b/.github/rename_project.sh @@ -17,9 +17,9 @@ echo "Description: $description"; echo "Renaming project..." original_author="UKPLab" -original_name="ukp_project_template" -original_urlname="ukp-project-template" -original_description="The official template for new Python projects at UKP Lab" +original_name="arxiv2024_missciplus" +original_urlname="arxiv2024-missciplus" +original_description="Awesome arxiv2024_missciplus created by UKPLab" # Iterate over all files in the repository git ls-files | while read -r filename; do # Exclude .github/workflows/rename_project.yml from renaming diff --git a/.github/template.yml b/.github/template.yml deleted file mode 100644 index 94e4e54..0000000 --- a/.github/template.yml +++ /dev/null @@ -1 +0,0 @@ -author: UKPLab diff --git a/.gitignore b/.gitignore index 4e550cf..947bba9 100644 --- a/.gitignore +++ b/.gitignore @@ -136,4 +136,4 @@ dmypy.json # Project files sketch* -ukp_project_template/sketch* \ No newline at end of file +arxiv2024_missciplus/sketch* \ No newline at end of file diff --git a/ABOUT_THIS_TEMPLATE.md b/ABOUT_THIS_TEMPLATE.md index 82291f1..83d90bb 100644 --- a/ABOUT_THIS_TEMPLATE.md +++ b/ABOUT_THIS_TEMPLATE.md @@ -9,8 +9,8 @@ It includes: - πŸ“ƒ Documentation structure using [mkdocs](http://www.mkdocs.org) - πŸ§ͺ Testing structure using [pytest](https://docs.pytest.org/en/latest/) - βœ… Code linting using [pylint](https://pypi.org/project/pylint/) -- 🎯 Entry points to execute your program using `python -m ` with basic CLI argument parsing. -- πŸ”„ Continuous integration using [Github Actions](https://github.com/UKPLab/ukp-project-template/actions) with jobs to check, lint and test your project. +- 🎯 Entry points to execute your program using `python -m ` with basic CLI argument parsing. +- πŸ”„ Continuous integration using [Github Actions](https://github.com/UKPLab/arxiv2024-missciplus/actions) with jobs to check, lint and test your project. Are there any changes you'd like to request? Feel free to fork and open a pull request! @@ -46,7 +46,7 @@ Lets take a look at the structure of this template: β”œβ”€β”€β”€docs # Auto-generated documentation β”‚ index.md # Landing page of docs β”‚ -β”œβ”€β”€β”€ukp_project_template # The main python package for the project +β”œβ”€β”€β”€arxiv2024_missciplus # The main python package for the project β”‚ base.py # The base module for the project β”‚ cli.py # Defines CLI instructions β”‚ __init__.py # This tells Python that this is a package @@ -63,7 +63,7 @@ Lets take a look at the structure of this template: ### Where should I add new stuff ? -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. +You should create new files and subpackages inside arxiv2024_missciplus 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. ### Why is `requirements.txt` empty ? @@ -79,7 +79,7 @@ This file lists all the requirements for testing and development. Use it to sepa ### What is the `.github` folder? -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). +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/arxiv2024-missciplus/actions). ### What does the linter workflow do? diff --git a/README.md b/README.md index 441b6c2..9edb5fa 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@

-# ukp_project_template +# arxiv2024_missciplus [![Arxiv](https://img.shields.io/badge/Arxiv-YYMM.NNNNN-red?style=flat-square&logo=arxiv&logoColor=white)](https://put-here-your-paper.com) -[![License](https://img.shields.io/github/license/UKPLab/ukp-project-template)](https://opensource.org/licenses/Apache-2.0) +[![License](https://img.shields.io/github/license/UKPLab/arxiv2024-missciplus)](https://opensource.org/licenses/Apache-2.0) [![Python Versions](https://img.shields.io/badge/Python-3.9-blue.svg?style=flat&logo=python&logoColor=white)](https://www.python.org/) -[![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) +[![CI](https://github.com/UKPLab/arxiv2024-missciplus/actions/workflows/main.yml/badge.svg)](https://github.com/UKPLab/arxiv2024-missciplus/actions/workflows/main.yml) 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). @@ -48,7 +48,7 @@ pip install -r requirements-dev.txt # Only needed for development ### Using the classes -To import classes/methods of `ukp_project_template` from inside the package itself you can use relative imports: +To import classes/methods of `arxiv2024_missciplus` from inside the package itself you can use relative imports: ```py from .base import BaseClass # Notice how I omit the package name @@ -59,8 +59,8 @@ BaseClass().something() 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: ```py -from ukp_project_template import BaseClass # Notice how I omit the file name -from ukp_project_template.subpackage import SubPackageClass # Here it's necessary because it's a subpackage +from arxiv2024_missciplus import BaseClass # Notice how I omit the file name +from arxiv2024_missciplus.subpackage import SubPackageClass # Here it's necessary because it's a subpackage BaseClass().something() SubPackageClass().something() @@ -68,10 +68,10 @@ SubPackageClass().something() ### Using scripts -This is how you can use `ukp_project_template` from command line: +This is how you can use `arxiv2024_missciplus` from command line: ```bash -$ python -m ukp_project_template +$ python -m arxiv2024_missciplus ``` ### Expected results diff --git a/ukp_project_template/__init__.py b/arxiv2024_missciplus/__init__.py similarity index 100% rename from ukp_project_template/__init__.py rename to arxiv2024_missciplus/__init__.py diff --git a/ukp_project_template/__main__.py b/arxiv2024_missciplus/__main__.py similarity index 69% rename from ukp_project_template/__main__.py rename to arxiv2024_missciplus/__main__.py index c6bc87c..0d4b8e5 100644 --- a/ukp_project_template/__main__.py +++ b/arxiv2024_missciplus/__main__.py @@ -1,4 +1,4 @@ -"""Entry point for ukp_project_template.""" +"""Entry point for arxiv2024_missciplus.""" from .cli import main # pragma: no cover diff --git a/ukp_project_template/base.py b/arxiv2024_missciplus/base.py similarity index 100% rename from ukp_project_template/base.py rename to arxiv2024_missciplus/base.py diff --git a/ukp_project_template/cli.py b/arxiv2024_missciplus/cli.py similarity index 88% rename from ukp_project_template/cli.py rename to arxiv2024_missciplus/cli.py index 325b7c9..f46a63b 100644 --- a/ukp_project_template/cli.py +++ b/arxiv2024_missciplus/cli.py @@ -1,4 +1,4 @@ -"""CLI interface for ukp_project_template project. +"""CLI interface for arxiv2024_missciplus project. Be creative! do whatever you want! @@ -13,7 +13,7 @@ def main(): # pragma: no cover """ The main function executes on commands: - `python -m ukp_project_template` and `$ ukp_project_template `. + `python -m arxiv2024_missciplus` and `$ arxiv2024_missciplus `. This is your program's entry point. diff --git a/ukp_project_template/subpackage/__init__.py b/arxiv2024_missciplus/subpackage/__init__.py similarity index 100% rename from ukp_project_template/subpackage/__init__.py rename to arxiv2024_missciplus/subpackage/__init__.py diff --git a/ukp_project_template/subpackage/subpackage.py b/arxiv2024_missciplus/subpackage/subpackage.py similarity index 100% rename from ukp_project_template/subpackage/subpackage.py rename to arxiv2024_missciplus/subpackage/subpackage.py diff --git a/docs/index.md b/docs/index.md index fe27dfe..389a982 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,4 +18,4 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org). ## Docs -::: ukp_project_template \ No newline at end of file +::: arxiv2024_missciplus \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 83f9db2..d6c2ac2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: ukp_project_template +site_name: arxiv2024_missciplus nav: - Home: index.md @@ -8,7 +8,7 @@ theme: plugins: - search - mkdocstrings: - project_name: ukp_project_template + project_name: arxiv2024_missciplus handlers: python: options: diff --git a/setup.py b/setup.py index dc33116..7704a24 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -"""Python setup.py for ukp_project_template package""" +"""Python setup.py for arxiv2024_missciplus package""" import io import os from setuptools import find_packages, setup @@ -6,7 +6,7 @@ def read(*paths, **kwargs): """Read the contents of a text file safely. - >>> read("ukp_project_template", "VERSION") + >>> read("arxiv2024_missciplus", "VERSION") '0.1.0' >>> read("README.md") ... @@ -30,15 +30,15 @@ def read_requirements(path): setup( - name="ukp_project_template", - url="https://github.com/UKPLab/ukp-project-template/", + name="arxiv2024_missciplus", + url="https://github.com/UKPLab/arxiv2024-missciplus/", long_description=read("README.md"), long_description_content_type="text/markdown", author="author_name", packages=find_packages(exclude=["tests", ".github"]), install_requires=read_requirements("requirements.txt"), entry_points={ - "console_scripts": ["ukp_project_template = ukp_project_template.__main__:main"] + "console_scripts": ["arxiv2024_missciplus = arxiv2024_missciplus.__main__:main"] }, extras_require={"test": read_requirements("requirements-dev.txt")}, ) diff --git a/tests/test_base.py b/tests/test_base.py index 6eac760..f0ad47c 100644 --- a/tests/test_base.py +++ b/tests/test_base.py @@ -1,6 +1,6 @@ # Tests are defined here -from ukp_project_template import BaseClass -from ukp_project_template.subpackage import SubPackageClass +from arxiv2024_missciplus import BaseClass +from arxiv2024_missciplus.subpackage import SubPackageClass def test_template(): assert True