Package: wipp-client
WIPP Python ClientWIPP API Python client libraryFeaturesSearch and list all WIPP entities (such as collections, plugins, jobs and workflows)List all members of the image and CSV colectionsInstallationClone the repoCheckout to the branch of interestIntall the librarypip install wipp_client/Quick StartBefore importing the module, set the environment variable:exportWIPP_API_INTERNAL_URL=http://wipp.url.com/apiwherewipp.url.commust be replaced with url of your WIPP instance.Try the following commands in Python REPL (python) or
include them in a Python file or Jupyter notebook.
CLI is not provided at this point.fromwipp_clientimportWippw=Wipp()# Search image collectionscollections=w.search_image_collections("ratBrain")forcincollections:print(c)# Get list of images in the image collectionimages=w.get_image_collections_images(collections[0].id)foriinimages:print(i)# Search CSV collectionscsv_collections=w.search_csv_collections("covid")forcsvcincsv_collections:print(csvc)# Get list of CSV files in the CSV collectionw.get_csv_collections_csv_files(csv_collections[0].id)DocumentationFor full package documentation please visitpolusai.github.io/wipp_client.DevelopmentSeeCONTRIBUTING.mdfor information related to developing the code.The Four Commands You Need To Knowpip install -e .[dev]This will install your package in editable mode with all the required development
dependencies (i.e.tox).make buildThis will runtoxwhich will run all your tests in both Python 3.7
and Python 3.8 as well as linting your code.make cleanThis will clean up various Python and build generated files so that you can ensure
that you are working in a clean environment.make docsThis will generate and launch a web browser to view the most up-to-date
documentation for your Python package.Additional Optional Setup Steps:Turn your project into a GitHub repository:Make an account ongithub.comGo tomake a new repositoryRecommendations:It is strongly recommended to make the repository name the same as the Python
package nameA lot of the following optional steps arefreeif the repository is Public,
plus open source is coolAfter a GitHub repo has been created, run the commands listed under:
"...or push an existing repository from the command line"Register your project with Codecov:Make an account oncodecov.io(Recommended to sign in with GitHub)
everything else will be handled for you.Ensure that you have set GitHub pages to build thegh-pagesbranch by selecting thegh-pagesbranch in the dropdown in the "GitHub Pages" section of the repository settings.
(Repo Settings)Register your project with PyPI:Make an account onpypi.orgGo to your GitHub repository's settings and under theSecrets tab,
add a secret calledPYPI_TOKENwith your password for your PyPI account.
Don't worry, no one will see this password because it will be encrypted.Next time you push to the branchmainafter usingbump2version, GitHub
actions will build and deploy your Python package to PyPI.Suggested Git Branch Strategymainis for the most up-to-date development, very rarely should you directly
commit to this branch. GitHub Actions will run on every push and on a CRON to this
branch but still recommended to commit to your development branches and make pull
requests to main. If you push a tagged commit with bumpversion, this will also release to PyPI.Your day-to-day work should exist on branches separate frommain. Even if it is
just yourself working on the repository, make a PR from your working branch tomainso that you can ensure your commits don't break the development head. GitHub Actions
will run on every push to any branch or any pull request from any branch to any other
branch.It is recommended to use "Squash and Merge" commits when committing PR's. It makes
each set of changes tomainatomic and as a side effect naturally encourages small
well defined PR's.MIT license