https://github.com/physiopy/physiopy-repository-template
Template repository for physiopy
https://github.com/physiopy/physiopy-repository-template
closember hacktoberfest physiological-data physiological-signals physiology template
Last synced: 11 days ago
JSON representation
Template repository for physiopy
- Host: GitHub
- URL: https://github.com/physiopy/physiopy-repository-template
- Owner: physiopy
- License: unlicense
- Created: 2022-11-30T08:41:58.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-29T07:19:54.000Z (29 days ago)
- Last Synced: 2026-01-01T04:49:59.281Z (26 days ago)
- Topics: closember, hacktoberfest, physiological-data, physiological-signals, physiology, template
- Language: Python
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Zenodo: .zenodo.json
Awesome Lists containing this project
README
This is a template for physiopy's repositories (and other repositories based on the same settings).
Remember to change the licence as soon as you adopt the template.
This repository is meant to be a template for python3 projects. If the repository you are making is more documentation focused, you may not require all the of the configurations below.
Available Configurations
------------------------
- CircleCI medium docker running Linux (python 3.7, 3.10, style checks, and coverage)
- Auto release based on Github versioning with Physiopy's labels.
- `.gitattributes` for python
- `.gitignore` for python and containers
- Pre-commit (Ruff, codespell, and RST documentation)
- Read the Docs (based on sphinx)
- Duecredit
- Zenodo
- Codecov (for master branch, 90%+)
- Python setup with `extra_require` options
- Versioneer
- Issue templates (bugs, feature requests, generic)
- PR template
- Workflows (Auto label, bot automerge, auto author assignment, Auto release, and PyPI upload)
- Bots (Welcome bot via `config.yml`, Dependabot)
Usage
-----
1. Start a new repository selecting this template
2a. If using within physiopy, fork the repository and clone your fork locally as `origin`
2b. If using alone, clone the repository locally as `origin`
3. If using within physiopy, set the physiopy version of this repository as `upstream`
4. Set up your default pushes to `origin` (`git config remote.pushDefault origin`)
5. Find and replace the items between `<>`, for instance ``, throughout all files in the repository.
6. If using outside of physiopy, find all `physiopy`s indicating the owner in github paths, and change it to your handle. Don't do this for your fork of a physiopy repository.
7. Change `'physiopy/physiopy-repository-template'` in line 15 of `.github/workflows/bot.yml` into what it needs to be.
8. Change licence and make sure to activate the licence of choice correctly.
9. Check and set up setup.cfg
10. Remove or add configurations; finalise set up, then push your first PR.
More explanation coming soon.
==========
[](https://github.com/physiopy//releases)
[](https://github.com/physiopy//releases)
[](https://github.com/intuit/auto)
[](https://.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/physiopy/)
[](https://circleci.com/gh/physiopy/)
[](https://.readthedocs.io/en/latest/?badge=latest)
[](https://pypi.org/project//)
[](https://pypi.org/project//)
[](https://github.com/intuit/auto)
[](https://pypi.org/project//)
[](#contributors-)
```` is a python3 library meant to do something.
> If you use ```` in your work, please support it by citing the zenodo DOI of the version you used. You can find the latest version [here](https://doi.org/10.5281/zenodo.3470091)
> We also support gathering all relevant citations via [DueCredit](http://duecredit.org).
[Read the latest documentation](https://.readthedocs.io/en/latest/) for more information on !
## Tested OSs
We would love to do that, but for the moment we cannot support **Windows or MacOS testing**. The reason is related to the cost of running such tests: for each non-Linux test, we can run up to 8 tests on Linux instead. Partial Windows and MacOS testing might be introduced in future releases.
Hence, while **we cannot ensure that will run on Windows or MacOS**, we don't see any reason it shouldn't. Besides, it will run on Windows Linux Subsystems.
We apologise for the discomfort.
## Contributors ✨
**We're looking for code contributors,** but any suggestion/bug report is welcome! Feel free to open issues!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
License
-------
This template is released under The Unlicense. Commented here below a copy of the Apache 2.0 Licence, adopted by Physiopy.
Remember to change the licence of your repository as soon as you adopt the template.
