Package for using the Synopsys Black Duck Hub REST API.
Project description
Overview
The hub-rest-api-python provides Python bindings for Hub REST API.
To use
pip install blackduck
from blackduck.HubRestApi import HubInstance
import json
username = "sysadmin"
password = "your-password"
urlbase = "https://ec2-34-201-23-208.compute-1.amazonaws.com"
hub = HubInstance(urlbase, username, password, insecure=True)
projects = hub.get_projects()
print(json.dumps(projects.get('items', [])))
Examples
Example code showing how to do various things can be found in the examples folder.
Build
You should be using virtualenv, virtrualenvwrapper to make things easy on yourself.
Ref: Packaging Python Projects Tutorial
Build the blackduck packages
To build both the source distribution package and the wheel package,
pip3 install -r requirements.txt
python3 setup.py sdist bdist_wheel
Distribute the package
Requires you have an account on either/both PyPi and Test PyPi AND you must be a package maintainer.
Send a request to gsnyder@synopsys.com or gsnyder2007@gmail.com if you want to be listed as a package maintainer.
To PyPi
Upload to PyPi,
twine upload dist/*
Then try installing it from PyPy
pip install blackduck
To Test PyPi
Upload to Test PyPi,
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Then try installing it from Test PyPy
pip install --index-url https://test.pypi.org/simple/ blackduck
Install package locally
Do this when testing a new version.
git clone https://github.com/blackducksoftware/hub-rest-api-python.git
cd hub-rest-api-python
pip3 install -r requirements.txt
pip3 install .
Test
Using (pytest)[https://pytest.readthedocs.io/en/latest/contents.html]
git clone https://github.com/blackducksoftware/hub-rest-api-python.git
cd hub-rest-api-python
# optional but advisable: create/use virtualenv
# you should have 3.x+, e.g. Python 3.7.0
pip3 install -r requirements.txt
pip3 install .
cd test
pytest
Where can I get the latest release?
This package is available on PyPi,
pip3 install blackduck
Documentation
Documentation for hub-rest-api-python can be found on the base project: Hub REST API Python Wiki
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for blackduck-0.0.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddce6d91824448990827b1f1b9d75f26117a100e3a9cda13dcfb0966bc8bbba7 |
|
MD5 | e38e3b648b78142dc9759595b3095935 |
|
BLAKE2b-256 | e212f667097ebac80b8a7650d266733f6fb25a46db1fe4ce1c4d6201c4eea93c |