Run setup_template.py

childmindresearch · Nov 15, 2023 · 47a20b5 · 47a20b5
1 parent dce6625
commit 47a20b5
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 300 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-ENTER_YOUR_EMAIL_ADDRESS.
+[email protected].
 
 All complaints will be reviewed and investigated promptly and fairly.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
-# template-python-repository pull request guidelines
+# styx pull request guidelines
 
-Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the template-python-repository project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details.
+Pull requests are always welcome, and we appreciate any help you give. Note that a code of conduct applies to all spaces managed by the styx project, including issues and pull requests. Please see the [Code of Conduct](CODE_OF_CONDUCT.md) for details.
 
 When submitting a pull request, we ask you to check the following:
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Child Mind Institute
+Copyright (c) 2023 Florian Rupprecht
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -2,10 +2,10 @@
 
 This is a template repository. Below is a checklist of things you should do to use it:
 
-- [ ] Run `setup_template.py` to set up the repository.
+- [x] Run `setup_template.py` to set up the repository.
 - [ ] Rewrite this `README` file.
 - [ ] Install the `pre-commit` hooks.
-- [ ] Update the `LICENSE` file to your desired license and set the year.
+- [x] Update the `LICENSE` file to your desired license and set the year.
 - [ ] Update the supported versions in `SECURITY.md` or, if not relevant, delete this file.
 - [ ] Remove the placeholder src and test files, these are there merely to show how the CI works.
 - [ ] Grant third-party app permissions (e.g. Codecov) [here](https://github.com/organizations/cmi-dair/settings/installations), if necessary.
@@ -15,12 +15,12 @@ This is a template repository. Below is a checklist of things you should do to u
 
 # Project name
 
-[![Build](https://github.com/cmi-dair/template-python-repository/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/cmi-dair/template-python-repository/actions/workflows/test.yaml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/cmi-dair/template-python-repository/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/cmi-dair/template-python-repository)
+[![Build](https://github.com/cmi-dair/styx/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/cmi-dair/styx/actions/workflows/test.yaml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/cmi-dair/styx/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/cmi-dair/styx)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 ![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cmi-dair/template-python-repository/blob/main/LICENSE)
-[![pages](https://img.shields.io/badge/api-docs-blue)](https://cmi-dair.github.io/template-python-repository)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cmi-dair/styx/blob/main/LICENSE)
+[![pages](https://img.shields.io/badge/api-docs-blue)](https://cmi-dair.github.io/styx)
 
 What problem does this tool solve?
 
@@ -35,23 +35,23 @@ What problem does this tool solve?
 Install this package via :
 
 ```sh
-pip install APP_NAME
+pip install styx
 ```
 
 Or get the newest development version via:
 
 ```sh
-pip install git+https://github.com/cmi-dair/template-python-repository
+pip install git+https://github.com/cmi-dair/styx
 ```
 
 ## Quick start
 
 Short tutorial, maybe with a
 
 ```Python
-import APP_NAME
+import styx
 
-APP_NAME.short_example()
+styx.short_example()
 ```
 
 ## Links or References

diff --git a/SECURITY.md b/SECURITY.md
@@ -15,6 +15,6 @@ Note which version(s) will receive security updates. For example:
 
 ## Reporting Vulnerabilities
 
-To report security vulnerabilities, please do NOT use our issues page. Instead, kindly email us at ENTER_YOUR_EMAIL_ADDRESS. Please refrain from using other communication channels.
+To report security vulnerabilities, please do NOT use our issues page. Instead, kindly email us at [email protected]. Please refrain from using other communication channels.
 
 For non-security-related issues, we welcome your input and feedback on our issues page. Feel free to share your ideas and suggestions to help us improve our services.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,11 +1,11 @@
 [tool.poetry]
-name = "app-name"
+name = "styx"
 version = "0.1.0"
-description = "A beautiful description."
-authors = ["Reinder Vos de Wael <[email protected]>"]
+description = "Boutiques code generator"
+authors = ["Florian Rupprecht <[email protected]>"]
 license = "LGPL-2.1"
 readme = "README.md"
-packages = [{include = "APP_NAME", from = "src"}]
+packages = [{include = "styx", from = "src"}]
 
 [tool.poetry.dependencies]
 python = "^3.11"

diff --git a/setup/__init__.py b/setup/__init__.py
diff --git a/setup/licenses.py b/setup/licenses.py
diff --git a/setup/settings.py b/setup/settings.py
diff --git a/setup_template.py b/setup_template.py
diff --git a/src/APP_NAME/algorithms.py b/src/APP_NAME/algorithms.py
diff --git a/src/APP_NAME/__init__.py → src/styx/__init__.py b/src/APP_NAME/__init__.py → src/styx/__init__.py
diff --git a/tests/test_fibonacci.py b/tests/test_fibonacci.py