An example of adding dascore IO support in an external package using plug-ins
To create your own support for external dascore IO support, do the following:
- Add your implementation in externalio.core. See dascore's adding new project support for more details.
- Rename this package from externalio to your io format name and update the description in
__init__.py
- Look through the pyproject.toml and rename all instances of externalio and follow comment instructions
- (best practice) create a directory called "tests" and add some tests/test files.
- Update this readme file with relevant information about your format.
Now, if you have done everything correctly, you should be able to install your package with pip (pip install .
if in the package directory) and dascore will automatically recognize your format without importing this package.
Try it via:
import dascore as dc
patch = dc.spool("path/to/myfile")[0]