Tweak pipenv example (#31)

* change image to Python and remove pip config

* rename and tweak pipenv example

* add pipenv failing test

* add jobs to workflow

* try multi-line command

* try multi line run command

* add colons because circleci says so

* add quotes to string

* fix indentation

* try escaping delimeter

* remove _False on cloudsmith index url

* change orb semver in example to 1.0

Author: hamza-samih

.circleci/test-deploy.yml

@@ -31,7 +31,7 @@ jobs:
           repository: "circleci-orb-testing"
       - run:
           name: Assert environment variables have been set
-          command: | 
+          command: |
             if [ $CLOUDSMITH_DOWNLOADS_DOMAIN != "packages.ft.com" ]
             then
               echo "Test failed: CLOUDSMITH_DOWNLOADS_DOMAIN has not been set correctly."
@@ -63,6 +63,30 @@ jobs:
           repository: "circleci-orb-testing"
       - run: python -m pip install -r requirements.txt --index-url "$CLOUDSMITH_PIP_INDEX_URL"
 
+  test-pipenv_install_package_example:
+    docker:
+      - image: cimg/python:3.9
+    steps:
+      - checkout
+      - run: python -m ensurepip --upgrade
+      - cloudsmith-python/set_env_vars_for_pip:
+          repository: "circleci-orb-testing"
+      - run: python -m pip install pipenv
+      - run:
+          name: Create Pipfile
+          command: |
+            cat \<< EOT >> Pipfile
+            [[source]]
+            url = "\$CLOUDSMITH_PIP_INDEX_URL"
+            verify_ssl = true
+            name = "cloudsmith"
+            [packages]
+            simplepkg = "0.0.1"
+            [requires]
+            python_version = "3.9"
+            EOT
+      - run: pipenv install
+
   test-configure_pip_example:
     docker:
       - image: cimg/python:3.9
@@ -84,7 +108,7 @@ jobs:
           repository: "circleci-orb-testing"
       - run:
           name: Assert environment variables have been set
-          command: | 
+          command: |
             if [ $CLOUDSMITH_TWINE_REPOSITORY_URL != "https://python.cloudsmith.io/financial-times/circleci-orb-testing/" ]
             then
               echo "Test failed: CLOUDSMITH_TWINE_REPOSITORY_URL has not been set correctly."
@@ -162,6 +186,9 @@ workflows:
       - test-pip_install_requirements_example:
           context: circleci-orb-publishing
           filters: *filters
+      - test-pipenv_install_package_example:
+          context: circleci-orb-publishing
+          filters: *filters
       - test-configure_pip_example:
           context: circleci-orb-publishing
           filters: *filters
@@ -189,6 +216,7 @@ workflows:
             - test-set_env_vars_for_pip
             - test-pip_install_package_example
             - test-pip_install_requirements_example
+            - test-pipenv_install_package_example
             - test-configure_pip_example
             - test-set_env_vars_for_twine
             - test-upload_package_using_twine

src/examples/configure_pip_index_url.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0.0
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
   jobs:
     build:
       docker:

src/examples/install_package_using_python_orb_pipenv.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0.0
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
   jobs:
     build:
       docker:

src/examples/pip_install_package.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0.0
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
   jobs:
     build:
       docker:

src/examples/pip_install_requirements.yml

@@ -0,0 +1,22 @@
+description: >
+  Install a package from Cloudsmith using pipenv. The source URL in the Pipfile must reference $CLOUDSMITH_PIP_INDEX_URL.
+usage:
+  version: 2.1
+  orbs:
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
+jobs:
+  build:
+    docker:
+      - image: cimg/python:3.9
+    steps:
+      - checkout
+      - run: python -m ensurepip --upgrade
+      - cloudsmith-python/set_env_vars_for_pip:
+          repository: your-repository-id
+      - run: python -m pip install pipenv
+      - run: pipenv install
+
+  workflows:
+    main:
+      jobs:
+        - build

src/examples/pipenv_install_packages.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0.0
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
   jobs:
     build:
       docker:

src/examples/upload_package_using_cli.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0.0
+    cloudsmith-python: ft-circleci-orbs/cloudsmith-python@1.0
   jobs:
     build:
       docker: