Skip to content

Repository files navigation

How to customise this template

  1. Name your repository with the name fileformats-vendor-<YOUR-VENDOR-NAME>
  2. Rename the fileformats/vendor/CHANGEME/MIMELIKE.py and extras/fileformats/extras/vendor/CHANGEME/MIMELIKE.py to the name of the "mime-like" type of the data the formats hold, e.g. fileformats/vendor/CHANGEME/medimage.py, fileformats/vendor/CHANGEME/biosig.py
  3. Rename the fileformats/vendor/CHANGEME and extras/fileformats/vendor/CHANGEME directories to the name of the vendor, i.e.
  4. Search and replace "CHANGEME" with the name of the vendor across all files in the repository
  5. Replace name + email placeholders in pyproject.toml for developers and maintainers
  6. Implement extension file-format classes in the fileformats/vendor/<YOUR-VENDOR-NAME>/<YOUR-MIMELIKE-TYPE>.py
  7. Implement "extra" functions (see the extras developer guide) in extras/fileformats/extras/vendor/<YOUR-VENDOR-NAME>/<YOUR-MIMELIKE-TYPE>.py
  8. Delete these instructions in this README

...

FileFormats Vendor CHANGEME

CI/CD Codecov Static Badge Python Versions Latest Version Documentation Status

The extension package of Fileformats provides a library of Python classes types for recognising and handling vendor-specific formats for CHANGEME files.

Quick Installation

This extension can be installed for Python 3 using pip::

$ pip3 install fileformats-vendor-CHANGEME

This will install the core package and any other dependencies

License

This work is licensed under the Apache License, Version 2.0.

About

Extension template for the fileformats package for vendor-specific formats

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages