Extending Exopy

Exopy is designed with the idea that user should be able to extend it to fit their own needs. The following section will describe how one should proceed to do so. The three first sections describe general concepts which are always applicable, the following ones are dedicated to the extension of specific part of the application.

If you need to extend the functionalities provided by an extension package please refer to its documentation for the specifics of the procedure.

• 1. Glossary and principle
  • 1.1. Set up exopy in developper mode
  • 1.2. Application architecture
  • 1.3. Structure of a plugin
  • 1.4. Extension packages
• 2. Interacting with the core of Exopy
  • 2.1. Providing application wide commands and sharing state
  • 2.2. Customizing application start up and closing
  • 2.3. Using the built in preferences manager
  • 2.4. Declaring error handlers
  • 2.5. Declaring dependencies
  • 2.6. Customizing logging
  • 2.7. Contributing to the application interface
• 3. Tasks and interfaces
  • 3.1. Creating a new task
  • 3.2. Creating a new interface
  • 3.3. Creating your own task filter
  • 3.4. Creating your own task configurer
  • 3.5. More on tasks internals
• 4. Instruments
  • 4.1. Instruments within Exopy
  • 4.2. Registering a driver
  • 4.3. Registering a user
  • 4.4. Registering a starter
  • 4.5. Registering a connection
  • 4.6. Registering a settings
  • 4.7. Registering a manufacturer alias
• 5. Measurement and tools
  • 5.1. Tools
  • 5.2. Editors
  • 5.3. Engines
• 6. Writing and running tests
  • 6.1. Writing test using pytest
  • 6.2. Running the test suite
• 7. Style guide
  • 7.1. Header
  • 7.2. Line length
  • 7.3. Docstrings
  • 7.4. Naming conventions
  • 7.5. Import formatting
  • 7.6. Python version compatibility
• 8. Atom and Enaml
  • 8.1. Atom
  • 8.2. Enaml

Note

When writing code for Exopy, or an extension packages you should follow the project style guides described in Style guide. Of course if you are developing a private extension you are free to do as you see fit but in order for a contribution to Exopy or one of its official extension package to be accepted it must follow those style guides.

Note

Exopy does not export any name in the __init__.py module. However for ease of use the objects necessary to extend Exopy functionality are exported in the api.py file associated with each plugin.

Note

Exopy is built on top of Atom and Enaml. Please have a look at Atom and Enaml for an explanation on how this influence the code.