jataware / domain-model-examiner

The goal of this process is to perform machine reading over the model codebase in order to automatically extract key metadata.
MIT License
1 stars 0 forks source link

pip install DMX #14

Open brandomr opened 3 years ago

brandomr commented 3 years ago

This issue is to make DMX pip installable. I have found https://packaging.python.org/tutorials/packaging-projects/ to be helpful.

You could check out how it is set up for mixmasta as well. For this I used cookiecutter to generate the basic template files. You could do this in a separate directory to get your setup files and just move over what you need and/or shift around the files/directories as needed.

GoogleSheets commented 3 years ago

Here it is on the PyPi test instance: https://test.pypi.org/project/dmx/0.5.0/

Plan to correct the version from 0.5.0 to 0.0.1

brandomr commented 3 years ago

Tested with:

pip install --extra-index-url https://pypi.org/simple -i https://test.pypi.org/simple/ dmx==0.5.0

Need to know how to test via some import. E.g.

from dmx import analyze

yaml_results = analyze('http://github.com/jataware/dummy-model')
GoogleSheets commented 3 years ago

The package name dmx was taken in prod; went instead with domainmodelexaminer. https://pypi.org/project/domainmodelexaminer/0.0.1/

import domainmodelexaminer as dmx
yaml_results=dmx.examine('http://github.com/jataware/dummy-model')