https://github.com/spyder-ide/spyder-api-docs

In-progress developer docs on Spyder's new plugin API
https://github.com/spyder-ide/spyder-api-docs

api developer-docs documentation plugins spyder spyder-ide website

Last synced: 5 months ago
JSON representation

In-progress developer docs on Spyder's new plugin API

• Host: GitHub
• URL: https://github.com/spyder-ide/spyder-api-docs
• Owner: spyder-ide
• License: mit
• Created: 2020-06-05T21:33:43.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-02-10T23:54:20.000Z (about 1 year ago)
• Last Synced: 2025-06-10T03:51:10.151Z (9 months ago)
• Topics: api, developer-docs, documentation, plugins, spyder, spyder-ide, website
• Language: Python
• Homepage: https://spyder-ide.github.io/spyder-api-docs/
• Size: 10 MB
• Stars: 2
• Watchers: 6
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Security: SECURITY.md
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

          
# Spyder API Docs

![Banner image with the Spyder wordmark and full name, the Scientific Python Development Environment](spyder_readme_banner.png)

*Copyright (c) 2020- Spyder-API-Docs Contributors and others (see [AUTHORS.txt](https://github.com/spyder-ide/spyder-api-docs/blob/master/AUTHORS.txt))*

[![License](https://img.shields.io/pypi/l/spyder.svg)](./LICENSE.txt)

[![Build](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/build.yaml/badge.svg)](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/build.yaml)

[![Check](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/check.yaml/badge.svg)](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/check.yaml)

[![Lint](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/lint.yaml/badge.svg)](https://github.com/spyder-ide/spyder-api-docs/actions/workflows/lint.yaml)

[![Netlify Status](https://api.netlify.com/api/v1/badges/e8229c2b-a95c-4bac-876d-61cd286c62e8/deploy-status)](https://app.netlify.com/sites/spyder-api-docs-preview/deploys)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)

[![OpenCollective Backers](https://opencollective.com/spyder/backers/badge.svg?color=blue)](https://opencollective.com/spyder)

- [Overview](#overview)

- [Building and Running](#building-and-running)

- [Contributing](#contributing)

- [More Information](#more-information)

## Overview

This repository contains the *developer and API* documentation for Spyder, the Scientific Python Development Environment.

You can view the live dev docs for current and past Spyder versions at [Spyder-IDE.GitHub.io/Spyder-API-Docs](https://spyder-ide.github.io/spyder-api-docs/).

For Spyder's *user* documentation, visit the [``spyder-ide/spyder-docs`` repository](https://github.com/spyder-ide/spyder-docs) or the deployed documentation at [docs.spyder-ide.org](https://docs.spyder-ide.org/).

For more information about Spyder itself, please see our [website](https://www.spyder-ide.org/) and the [main repo](https://github.com/spyder-ide/spyder).

## Building and Running

This project uses [Nox](https://nox.thea.codes/) to help automate setting up an environment, building and running, linting the codebase, and many other development tasks.

To build it, ensure Nox is installed (via pip, Conda, pipx, etc), and then just run

```shell

nox -s build

```

For more details and step by step instructions, see our [Contributing Guide](./CONTRIBUTING.md).

## Contributing

We welcome your contributions of issue reports, fixes and enhancements to Spyder-API-Docs, as it is by and for the community, and we appreciate others getting involved.

Its easy to build a local copy in one or two steps with Nox, or you can also just check your changes with our automated CI jobs on PRs.

Just submit a PR with your changes and we'll be happy to review it; make sure to read our [Contributing Guide](./CONTRIBUTING.md) first to ensure the process of getting your revisions integrated goes smoothly.

Thanks for your interest in Spyder-API-Docs, and we appreciate your support of the project!

## More Information

[Main Website](https://www.spyder-ide.org/)

[Online Documentation](https://docs.spyder-ide.org/)

[Spyder GitHub](https://github.com/spyder-ide/spyder)

[Spyder Google Group](https://groups.google.com/group/spyderlib)

[@Spyder_IDE on Twitter](https://twitter.com/spyder_ide)

[@Spyder on Fosstodon](https://fosstodon.org/@Spyder)

[@SpyderIDE on Facebook](https://www.facebook.com/SpyderIDE/)

[Support Spyder on OpenCollective](https://opencollective.com/spyder/)