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 (black, isort, flake8, pydocstyle, and RST documentation)
• Read the Docs (based on sphinx)
• Zenodo
• Codecov (for master branch, 90%+)
• Python setup with extra_require options
• Versioneer
• Issue templates (bugs, feature requests, generic)
• PR template
• Workflows (Auto release, PyPI upload, Auto label)
• Welcome bot (via config.yml)

Usage

1. Find and replace the items between <>, for instance <reponame>
2. Change licence
3. Set up your default pushes to origin (git config remote.pushDefault origin)
4. Remove or add configurations; finalise set up.

More explanation coming soon.

<!-- --> <!-- -->

<!-- ALL-CONTRIBUTORS-BADGE:END -->

<reponame> is a python3 library meant to do something.

If you use <reponame> in your work, please support it by citing the zenodo DOI of the version you used. You can find the latest version here

We also support gathering all relevant citations via DueCredit.

Read the latest documentation 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 specification. Contributions of any kind welcome!

Thanks goes to these wonderful people (emoji key): <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable -->

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. <!-- Copyright 2019-2020, The Physiopy community.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->