/fileformats-extras-template

A template repository for adding "extras" functionality to fileformats classes

Primary LanguagePythonOtherNOASSERTION

How to customise this template

  1. Name your repository with the name fileformats-<SUBPACKAGE-TO-ADD-EXTRAS-TO>-extras
  2. Rename the fileformats/extras/CHANGEME directory to the name of the fileformats subpackage the extras are for
  3. Search and replace "CHANGEME" with the name of the fileformats subpackage the extras are to be added
  4. Replace name + email placeholders in pyproject.toml for developers and maintainers
  5. Implement selected "extras" by implementing functions decorated by one of the *_extra hooks defined in the target fileformats class
  6. Ensure that the decorated are imported into the extras package root, i.e. fileformats/extra/CHANGEME
  7. Delete these instructions

...

FileFormats-CHANGEME Extras

https://codecov.io/gh/arcanaframework/fileformats-CHANGEME-extras/branch/main/graph/badge.svg?token=UIS0OGPST7 GitHub stars Documentation Status

This is a extras module for the fileformats-CHANGEME package, which provides additional functionality to format classes (i.e. aside from basic identification and validation), such as conversion tools, metadata parsers, test data generators, etc...

Quick Installation

This extension can be installed for Python 3 using pip:

$ pip3 install fileformats-CHANGEME-extras

This will install the core package and any other dependencies

License

This work is licensed under a Creative Commons Attribution 4.0 International License

Creative Commons Attribution 4.0 International License