poetry

python-example/poetry-example/README.md

@@ -0,0 +1,77 @@
+# 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](https://pip.pypa.io/en/stable/installing/) and also [Installing packages using pip and virtual environments](https://packaging.python.org/guides/installing-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](https://www.jfrog.com/confluence/display/RTF/PyPI+Repositories).
+* 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](https://packaging.python.org/tutorials/installing-packages/).
+5. Make sure version 1.28.0 or above of [JFrog CLI](https://jfrog.com/getcli/) is installed.
+
+### Validate the Setup
+In your terminal, validate that the following commands work.
+```console
+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
+
+```console
+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](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-BuildingPythonPackages).

python-example/poetry-example/poetry-project/pythonProj.py

@@ -0,0 +1,10 @@
+#!/usr/bin/python
+
+# Function definition is here
+def printme( str ):
+    # This prints a passed string into this function
+    print (str)
+    return;
+
+# Now you can call printme function
+printme("Hello from JFROG");

python-example/poetry-example/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "poetry-project"
+version = "1.0"
+description = "Project example for building Python project with JFrog products"
+authors = ["JFrog <jfrog@jfrog.com>"]
+packages = [{include = "poetry-project"}]
+
+[tool.poetry.dependencies]
+PyYAML = ">3.11"
+nltk = "*"