Update template

childmindresearch · May 23, 2024 · 258f1e6 · 258f1e6
1 parent 3d37e00
commit 258f1e6
Show file tree

Hide file tree

Showing 13 changed files with 21 additions and 298 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
+# bidsi 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 bidsi 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) 2024 Child Mind Institute
 
 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
@@ -5,7 +5,7 @@
 Welcome to the CMI-DAIR Template Python Repository! This template is designed to streamline your project setup and ensure a consistent structure. To get started, follow these steps:
 
 
-- [ ] Run `setup_template.py` to initialize the repository.
+- [x] Run `setup_template.py` to initialize the repository.
 - [ ] Replace the content of this `README.md` with details specific to your project.
 - [ ] Install the `pre-commit` hooks to ensure code quality on each commit.
 - [ ] Revise SECURITY.md to reflect supported versions or remove it if not applicable.
@@ -16,12 +16,12 @@ Welcome to the CMI-DAIR Template Python Repository! This template is designed to
 
 # Project name
 
-[![Build](https://github.com/childmindresearch/template-python-repository/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/template-python-repository/actions/workflows/test.yaml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/childmindresearch/template-python-repository/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/childmindresearch/template-python-repository)
+[![Build](https://github.com/childmindresearch/bidsi/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/bidsi/actions/workflows/test.yaml?query=branch%3Amain)
+[![codecov](https://codecov.io/gh/childmindresearch/bidsi/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/childmindresearch/bidsi)
 [![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-stable](https://img.shields.io/badge/stability-stable-green.svg)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/template-python-repository/blob/main/LICENSE)
-[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/template-python-repository)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/bidsi/blob/main/LICENSE)
+[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/bidsi)
 
 What problem does this tool solve?
 
@@ -36,23 +36,23 @@ What problem does this tool solve?
 Install this package via :
 
 ```sh
-pip install APP_NAME
+pip install bidsi
 ```
 
 Or get the newest development version via:
 
 ```sh
-pip install git+https://github.com/childmindresearch/template-python-repository
+pip install git+https://github.com/childmindresearch/bidsi
 ```
 
 ## Quick start
 
 Short tutorial, maybe with a
 
 ```Python
-import APP_NAME
+import bidsi
 
-APP_NAME.short_example()
+bidsi.short_example()
 ```
 
 ## Links or References

diff --git a/SECURITY.md b/SECURITY.md
@@ -2,19 +2,8 @@
 
 Child Mind Institute values the security of our users, data, and servers. We take the security of our systems seriously and encourage users to report any suspected security vulnerabilities promptly.
 
-## Supported Versions
-
-MODIFY:
-
-Note which version(s) will receive security updates. For example:
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.0.x   | :white_check_mark: |
-| 0.9.x   | :x:                |
-
 ## 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 = "bidsi"
 version = "0.1.0"
-description = "A beautiful description."
-authors = ["Reinder Vos de Wael <reinder.vosdewael@childmind.org>"]
-license = "LGPL-2.1"
+description = "Library for writing BIDS file structures."
+authors = ["Gabriel Schubiner <gabriel.schubiner@childmind.org>"]
+license = "MIT License"
 readme = "README.md"
-packages = [{include = "APP_NAME", from = "src"}]
+packages = [{include = "bidsi", 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/__init__.py → src/bidsi/__init__.py b/src/APP_NAME/__init__.py → src/bidsi/__init__.py
diff --git a/src/APP_NAME/algorithms.py → src/bidsi/algorithms.py b/src/APP_NAME/algorithms.py → src/bidsi/algorithms.py
@@ -1,4 +1,4 @@
-"""Example functions for APP_NAME."""
+"""Example functions for bidsi."""
 
 
 def fibonacci(n: int) -> int: