Skip to main content

Sherpa knowledge import plugins

Project description

Requirements

  • Python 3.8+
  • Flit to put Python packages and modules on PyPI
  • Pydantic for the data parts.

Installation

pip install flit
pip install pyimporters-dummy

Publish the Python Package to PyPI

  • Increment the version of your package in the __init__.py file:
"""An amazing package!"""

__version__ = 'x.y.z'
  • Publish
flit publish

Write your own pyimporters plugin

  • Git clone the pyimporters_dummy project
git clone git@bitbucket.org:kairntech/pyimporters_dummy.git
  • Rename the project with your own format name <new_format>
mv pyimporters_dummy pyimporters_<new_format>
  • Delete the .git directory
rm -r -f pyimporters_<new_format>/.git
  • Change to the new pyimporters_<new_format> directory
cd pyimporters_<new_format>
  • Rename the package directory project
mv pyimporters_dummy pyimporters_<new_format>
  • Rename the python file implementation
mv pyimporters_<new_format>/dummy.py pyimporters_<new_format>/<new_format>.py
  • Rename the python tests file implementation
mv tests/test_dummy.py tests/test_<new_format>.py
  • Edit the pyproject.toml file to change a few lines and add your additional requirements
[tool.flit.metadata]
module = "pyimporters_<new_format>"
...
requires = [
    "pyimporters_plugins>=0.1.61",
    "additional_requirement1",
    "additional_requirement2",
    ...
    "additional_requirementN",
]
dist-name = "pyimporters-<new_format>"
...
[tool.flit.entrypoints."pyimporters.plugins"]
<new_format> = "pyimporters_<new_format>.<new_format>:NewFormatKnowledgeParser"
  • Write the implementation and test of your new format in python using your favorite IDE
@dataclass
class NewFormatOptions(KnowledgeParserOptions):
    """
    Options for the new format knowledge import
    """
    foo : str = Query("bar", description="Dummy parameter")

NewFormatOptionsModel = NewFormatOptions.__pydantic_model__

class NewFormatKnowledgeParser(KnowledgeParserBase):
    def parse(self, source : Path, options: Union[KnowledgeParserOptions, Dict[str, Any]], bar : Bar) -> Generator[Term, None, None]:
        options = NewFormatOptions(**options) if isinstance(options, dict) else options
        # Initialize the progress indicator number of terms to read so that the progress indicator can send feedback to the end user
        bar.max = 100 
        bar.start()
        # yield as many terms as you want, advancing the progress indicator each time
        bar.next()
        yield Term(identifier=options.foo, preferredForm=options.foo)
        # Terminate the progress indicator
        bar.finish()

    @classmethod
    def get_schema(cls) -> KnowledgeParserOptions:
        return NewFormatOptions

    @classmethod
    def get_model(cls) -> Type[BaseModel]:
        return NewFormatOptionsModel

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyimporters-dummy-0.1.171.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

pyimporters_dummy-0.1.171-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file pyimporters-dummy-0.1.171.tar.gz.

File metadata

  • Download URL: pyimporters-dummy-0.1.171.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for pyimporters-dummy-0.1.171.tar.gz
Algorithm Hash digest
SHA256 c2ce6f14e52e4744c5eb6676c2a53b8d54dea7464ca071f08b5f1684775410cb
MD5 db2e085863f52716db3ce6bdd176c893
BLAKE2b-256 9a9a98f168ebc1e4d46e0228ff7419c2f44547cb147ce3f61ca2e24caf882dc7

See more details on using hashes here.

File details

Details for the file pyimporters_dummy-0.1.171-py3-none-any.whl.

File metadata

File hashes

Hashes for pyimporters_dummy-0.1.171-py3-none-any.whl
Algorithm Hash digest
SHA256 dc0e2c8649dcf7360e84a3fe4e14404664d8bed3e35ae312cfd29383f1825fdb
MD5 8a80090558203f90a3df8906f11bb178
BLAKE2b-256 e941935d7b6576f9824bc9765f6fe507b456b9ac49cfaa13e5d693d79d6fb191

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page