Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Cookiecutter template for a Spyder IDE plugin (compatible with Spyder IDE versions 3.x and 4.x)

License

Notifications You must be signed in to change notification settings

spyder-ide/spyder-plugin-cookiecutter

Folders and files

NameName
Last commit message
Last commit date
Jul 17, 2019
Jul 17, 2019
Aug 5, 2019
Jul 31, 2019
Aug 5, 2019
Aug 5, 2019
Jan 21, 2017
Jan 16, 2017
Jan 19, 2017
Aug 5, 2019
Aug 5, 2019
Aug 5, 2019

Repository files navigation

Spyder Plugin Cookiecutter

Project details

Join the chat at https://gitter.im/spyder-ide/public OpenCollective Backers OpenCollective Sponsors

Build status

CircleCI

Overview

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.

Features

  • Compatible with Spyder >=3.1 and Spyder 4
  • Follows Spyder Plugin Structure (plugin.py, widgets, assets, tests)
  • A functional basic plugin.

Repo structure

  • License.txt, MANIFIEST.in, CONTRIBUTORS.md and .gitatributes
  • README.rst with bagdes and some instructions.

Packaging

  • requirements.txt file for easy install dependencies for development
  • setup.py
  • Recipe files for creating conda package.

Testing and Continuous Integration

  • pytest configuration, and a basic test
  • Integration with Appveyor for windows testing.
  • Integration with Circle-CI for linux testing.

Code Checking

Usage

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]: 

Testing

For testing you need to install pytest and pytest-cookies

$ pip install pytest pytest-cookies

And run pytest:

$ pytest

Contributing

Everyone is welcome to contribute!

Backers

Support us with a monthly donation and help us continue our activities.

Backers

Sponsors

Become a sponsor to get your logo on our README on Github.

Sponsors