Pip Example

Overview

This example demonstrates how to build a Python Pip project with Artifactory, while collecting build-info.

Before Running the Example

Set Up the Environment

1. Make sure Python is installed and the python command is in your PATH.
2. Install pip. You can use the Pip Documentation and also Installing packages using pip and virtual environments
3. Create three Pypi repositories in Artifactory - a local, remote and a virtual repository. You can use the PyPi Repositories Documentation.

• The remote repository should proxy https://files.pythonhosted.org (the default when creating a Pypi remote repository).
• Name the virtual repository pypi.
• The virtual repository should include the remote repository.
• The virtual repository should have the local repository set as the Default Deployment Repository.

4. Make sure wheel and setuptools are installed. You can use the Installing Packages Documentation.
5. Make sure version 1.28.0 or above of JFrog CLI is installed.

Validate the Setup

In your terminal, validate that the following commands work.

Output Python version:
> python --version

Output pip version:
> pip --version

Verify wheel is installed:
> wheel -h

Verify setuptools is installed:
> pip show setuptools

Verify that virtual-environment is activated:
> echo $VIRTUAL_ENV

Output JFrog CLI version:
> jf --version

Running the Example

'cd' to the root project directory

Configure Artifactory:
> jf c add --url=<JFROG_PLATFORM_URL> [credentials flags]

Configure the project's resolution repository. You shoud set the virtual repository you created.
> jf pip-config --repo-resolve=<PYPI_REPO>

Install project dependencies with pip from Artifactory:

Using Setup.py:
> jf pip install . --build-name=my-pip-build --build-number=1 --module=jfrog-python-example
 OR
Using requirements.txt:
> jf pip install -r requirements.txt --build-name=my-pip-build --build-number=1 --module=jfrog-python-example

Package the project, create distribution archives (tar.gz and whl):
> python setup.py sdist bdist_wheel

Upload the packages to the pypi repository in Artifactory:
> jf rt u dist/ pypi/ --build-name=my-pip-build --build-number=1 --module=jfrog-python-example

Collect environment variables and add them to the build info:
> jf rt bce my-pip-build 1

Publish the build info to Artifactory:
> jf rt bp my-pip-build 1

Install published package by installing it from Artifactory using pip:
> jf pip install jfrog-python-example

Validate package successfully installed:
> pip show jfrog-python-example

Learn about Building Python Packages with JFrog CLI.