Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up documentation and tools #193

Closed
rjyounes opened this issue Mar 1, 2020 · 5 comments
Closed

Clean up documentation and tools #193

rjyounes opened this issue Mar 1, 2020 · 5 comments
Assignees
Labels
effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation) priority: should have Medium priority feature or bug fix

Comments

@rjyounes
Copy link
Collaborator

rjyounes commented Mar 1, 2020

  • bundle.bat can be deleted - now replaced by ontology-toolkit. Instructions in README.md should be updated to reflect the use of ontology-toolkit.
  • versionize scripts can be deleted
  • serialize scripts can be deleted
  • version.txt - delete
  • curl_requests.txt - do we need this?
  • Only rdf-toolkit is needed in tools directory
@rjyounes rjyounes added effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation) priority: should have Medium priority feature or bug fix labels Mar 1, 2020
@rjyounes rjyounes changed the title Clean up documentation files Clean up documentation and tools Mar 2, 2020
@marksem
Copy link
Collaborator

marksem commented Mar 26, 2020

@sa-bpelakh , I think I'll need your help to know what tools are needed and no-longer-needed to do a release, since you did the most recent release.

@sa-bpelakh
Copy link
Collaborator

@marksem So, you should read https://github.com/semanticarts/ontology-toolkit/blob/develop/README.md, if you run python ontology-toolkit.py bundle [version] from the gist root directory, that gets you most of the way there. If you move the locations of any of the artifacts (like LICENSE.txt etc), the script will need to be adjusted, it makes some assumptions to simply the command line interface.

@marksem
Copy link
Collaborator

marksem commented Mar 26, 2020

@sa-bpelakh , what is the recommended way to install the needed requirements for ontology-toolkit? E.g. pip install -r requirements.txt vs. pipenv vs virtualenv? Also, what is the recommended way to get ontology-toolkit.py on your PATH so you can run it anywhere (such as in the gist folder)?

It would be helpful to add such direction to the ontology-toolkit readme. It probably makes more sense to have that there than in the gist readme.

@sa-bpelakh
Copy link
Collaborator

pip install -r requirements.txt will work for now. You can use virtualenv if you want to isolate the downloaded packages, but I don't tend to do that. I created semanticarts/ontology-toolkit#16 to augment the documentation.

I will also look into PyInstaller to see if we can get the script packaged as an executable.

@rjyounes
Copy link
Collaborator Author

rjyounes commented Apr 6, 2020

@marksem You may want to follow the GitHub process for adding a license: https://help.github.com/en/github/building-a-strong-community/adding-a-license-to-a-repository

This involves keeping it at the root of the repo rather than in the doc folder, contrary to what I suggested above.

@rjyounes rjyounes assigned sa-bpelakh and unassigned marksem Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: small Requires less than one day to complete impact: patch No new functionality or changes in human-readable semantics (e.g,. fixing a typo in an annotation) priority: should have Medium priority feature or bug fix
Projects
None yet
Development

No branches or pull requests

3 participants