Skip to content

Commit db81108

Browse files
teanijarvteanijarv
committed
project metadata
1 parent 63dc0e5 commit db81108

6 files changed

Lines changed: 139 additions & 3 deletions

File tree

‎CITATION.cff‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
cff-version: 1.2.0
2+
message: "If you use yabplot in your research, please cite it as below."
3+
authors:
4+
- family-names: "Anijärv"
5+
given-names: "Toomas Erik"
6+
orcid: "https://orcid.org/0000-0002-3650-4230"
7+
title: "yabplot: yet another brain plot for unified neuroimaging visualization in Python"
8+
doi: 10.5281/zenodo.18237144
9+
version: 0.5.1
10+
url: "https://github.com/teanijarv/yabplot"
11+
preferred-citation:
12+
type: software
13+
authors:
14+
- family-names: "Anijärv"
15+
given-names: "Toomas Erik"
16+
orcid: "https://orcid.org/0000-0002-3650-4230"
17+
title: "yabplot: yet another brain plot for unified neuroimaging visualization in Python"
18+
year: 2026
19+
doi: 10.5281/zenodo.18237144
20+
url: "https://github.com/teanijarv/yabplot"
21+
abstract: "An open-source Python package for 3D neuroimaging visualization."

‎CODE_OF_CONDUCT.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# code of conduct
2+
3+
## our pledge
4+
in the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
5+
6+
## our standards
7+
examples of behavior that contributes to creating a positive environment include:
8+
* using welcoming and inclusive language
9+
* being respectful of differing viewpoints and experiences
10+
* gracefully accepting constructive criticism
11+
* focusing on what is best for the community
12+
* showing empathy towards other community members
13+
14+
examples of unacceptable behavior by participants include:
15+
* the use of sexualized language or imagery and unwelcome sexual attention or advances
16+
* trolling, insulting/derogatory comments, and personal or political attacks
17+
* public or private harassment
18+
* publishing others' private information, such as a physical or electronic address, without explicit permission
19+
* other conduct which could reasonably be considered inappropriate in a professional setting
20+
21+
## our responsibilities
22+
as the maintainers of this project, we are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
23+
24+
we have the right and responsibility to remove, edit, or reject comments, commits, code, docs edits, issues, and other contributions that are not aligned to this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that we deem inappropriate, threatening, offensive, or harmful.
25+
26+
## enforcement
27+
instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us at teanijarv@pm.me. all complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. we are obligated to maintain confidentiality with regard to the reporter of an incident.

‎CONTRIBUTING.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# contributing to yabplot
2+
3+
thank you for your interest in contributing to `yabplot`! we welcome contributions from the neuroimaging and open-source communities.
4+
5+
## how to contribute
6+
7+
### reporting bugs
8+
- use the [github issue tracker](https://github.com/teanijarv/yabplot/issues) to report bugs.
9+
- include a minimal reproducible example and information about your environment (os, python version, package versions).
10+
11+
### suggesting enhancements
12+
- open an issue describing the proposed feature and why it would be useful for the community.
13+
14+
### pull requests
15+
1. fork the repository and create your branch from `main`.
16+
2. if you've added code that should be tested, add tests in the `tests/` directory.
17+
3. if you've changed API, update the documentation.
18+
4. ensure the test suite passes: `uv run pytest tests/`
19+
5. submit a pull request with a clear description of the changes.
20+
21+
## development setup
22+
23+
we use `uv` for dependency management. to set up your development environment:
24+
25+
```bash
26+
git clone https://github.com/teanijarv/yabplot.git
27+
cd yabplot
28+
uv venv
29+
uv pip install -e ".[docs]"
30+
uv pip install pytest
31+
```
32+
33+
## community
34+
by contributing, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md).

‎MANIFEST.in‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
include pyproject.toml
22
include README.md
33
include LICENSE
4-
recursive-include yabplot *.txt *.json *.md
4+
include CITATION.cff
5+
include CONTRIBUTING.md
6+
include CODE_OF_CONDUCT.md
7+
8+
recursive-include yabplot *.txt *.json *.md
9+
recursive-include tests *.py

‎pyproject.toml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "yabplot"
3-
version = "0.5.0"
3+
version = "0.5.1"
44
description = "yet another brain plot"
55
readme = "README.md"
66
requires-python = ">=3.10"
@@ -32,3 +32,8 @@ include = ["yabplot*"]
3232

3333
[tool.setuptools.package-data]
3434
"yabplot" = ["*.txt", "*.json"]
35+
36+
[dependency-groups]
37+
dev = [
38+
"pytest>=9.0.3",
39+
]

‎uv.lock‎

Lines changed: 45 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)