Powered by Cookiecutter 🍪, Spyder Plugin Cookiecutter is a template for jumpstarting Spyder IDE 🕸️ plugins quickly.
We recommend using conda and anaconda when developing a Spyder-IDE plugin.
- Compatible with Spyder >=3.1 and Spyder 4
- Follows Spyder Plugin Structure (
plugin.py
,widgets
,assets
,tests
) - A functional basic plugin.
License.txt
,MANIFIEST.in
,CONTRIBUTORS.md
and.gitatributes
README.rst
with bagdes and some instructions.
requirements.txt
file for easy install dependencies for developmentsetup.py
- Recipe files for creating conda package.
- pytest configuration, and a basic test
- Integration with Appveyor for windows testing.
- Integration with Circle-CI for linux testing.
- Test Coverage with Coveralls Integration.
- Integration with ciocheck for linting and codestyle checking
- Integration with Scrutinizer CI for Code Quality
First, get Cookiecutter:
$ conda install "cookiecutter>=1.4.0"
Now run against the repo:
$ cookiecutter gh:spyder-ide/spyder-plugin-cookiecutter
You'll be prompted for some values. and after that the repo will be generated
Normally you don't need to change python_package_name
and git_repo_name
.
Example:
plugin_name [Demo]:
git_repo_name [spyder-demo]:
python_package_name [spyder_demo]:
description [Plugin for Spyder IDE.]:
version [0.1.0]:
author [Spyder Project Contributors]:
email [[email protected]]:
github_username [spyder-ide]:
graphical_plugin [y]:
create_config_page [n]:
support_python_2 [n]:
spyder3_compatibility [n]:
For testing you need to install pytest and pytest-cookies
$ pip install pytest pytest-cookies
And run pytest:
$ pytest
Everyone is welcome to contribute!
Support us with a monthly donation and help us continue our activities.
Become a sponsor to get your logo on our README on Github.