generated from childmindresearch/template-python-repository
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
96 additions
and
383 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,24 @@ | ||
[![DOI](https://zenodo.org/badge/657341621.svg)](https://zenodo.org/doi/10.5281/zenodo.10383685) | ||
|
||
# CMI-DAIR Template Python Repository | ||
|
||
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. | ||
- [ ] 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. | ||
- [ ] Remove the placeholder src and test files, these are there merely to show how the CI works. | ||
- [ ] If it hasn't already been done for your organization/acccount, grant third-party app permissions for CodeCov. | ||
- [ ] To set up an API documentation website, after the first successful build, go to the `Settings` tab of your repository, scroll down to the `GitHub Pages` section, and select `gh-pages` as the source. This will generate a link to your API docs. | ||
- [ ] Update stability badge in `README.md` to reflect the current state of the project. A list of stability badges to copy can be found [here](https://github.com/orangemug/stability-badges). The [node documentation](https://nodejs.org/docs/latest-v20.x/api/documentation.html#documentation_stability_index) can be used as a reference for the stability levels. | ||
|
||
# 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/styxgraph/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/styxgraph/actions/workflows/test.yaml?query=branch%3Amain) | ||
[![codecov](https://codecov.io/gh/childmindresearch/styxgraph/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/childmindresearch/styxgraph) | ||
[![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) | ||
|
||
What problem does this tool solve? | ||
|
||
## Features | ||
|
||
- A few | ||
- Cool | ||
- Things | ||
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/styxgraph/blob/main/LICENSE) | ||
[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/styxgraph) | ||
|
||
## Installation | ||
|
||
Install this package via : | ||
|
||
```sh | ||
pip install APP_NAME | ||
``` | ||
|
||
Or get the newest development version via: | ||
|
||
```sh | ||
pip install git+https://github.com/childmindresearch/template-python-repository | ||
``` | ||
|
||
## Quick start | ||
|
||
Short tutorial, maybe with a | ||
## Usage | ||
|
||
```Python | ||
import APP_NAME | ||
from styxdefs import set_global_runner, get_global_runner | ||
from styxgraph import GraphRunner | ||
|
||
set_global_runner(DockerRunner()) # (Optional) Use any Styx runner like usual | ||
set_global_runner(GraphRunner(get_global_runner())) # Use GraphRunner middleware | ||
|
||
APP_NAME.short_example() | ||
``` | ||
# Use any Styx functions as usual | ||
# ... | ||
|
||
## Links or References | ||
print(get_global_runner().mermaid()) # Print mermaid diagram | ||
|
||
- [https://www.wikipedia.de](https://www.wikipedia.de) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
[tool.poetry] | ||
name = "app-name" | ||
name = "styxgraph" | ||
version = "0.1.0" | ||
description = "A beautiful description." | ||
authors = ["Reinder Vos de Wael <[email protected]>"] | ||
license = "LGPL-2.1" | ||
description = "Execution graph middleware for Styx" | ||
authors = ["Florian Rupprecht <[email protected]>"] | ||
license = "MIT License" | ||
readme = "README.md" | ||
packages = [{include = "APP_NAME", from = "src"}] | ||
packages = [{include = "styxgraph", from = "src"}] | ||
|
||
[tool.poetry.dependencies] | ||
python = "~3.11" | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.