Overview
The hub-rest-api-python provides Python bindings for Hub REST API.
To use
pip install blackduck
from blackduck.HubRestApi import HubInstance
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()
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,
pip 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
pip install -r requirements.txt
pip 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
pip install -r requirements.txt
pip install .
cd test
pytest
Where can I get the latest release?
This package is available on PyPi,
pip install blackduck
Documentation
Documentation for hub-rest-api-python can be found on the base project: Hub REST API Python Wiki
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file blackduck-0.0.17.tar.gz.
File metadata
- Download URL: blackduck-0.0.17.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4cfeb9984542b649875621cdadd5b7dd831134e11cd8286856daba8334fdc955
|
|
| MD5 |
45b86870546372d1c634e0db692fb151
|
|
| BLAKE2b-256 |
a44223c92c678ff5cec29f2f84d2d93c3a422583297ab0d4ba2e478648fd779d
|
File details
Details for the file blackduck-0.0.17-py3-none-any.whl.
File metadata
- Download URL: blackduck-0.0.17-py3-none-any.whl
- Upload date:
- Size: 17.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
04088afa8263ea6979ca16578b65a8efe5b668884396d120ff2e701804601a7a
|
|
| MD5 |
e206a47b9cc31c64ba712f4105863992
|
|
| BLAKE2b-256 |
98ca321f1f0b3f8af8975b3f21ee7fd9bc6f8511be538768ce6a8f46802f5b20
|
