Requirements to pipfile

.circleci/config.yml

@@ -18,15 +18,33 @@ references:
         - checkout-content
         - prepare-tox3-7
 
+    create_requirement_files: &create_requirement_files
+      run:
+        name: Create requirement files
+        command: |
+          pip install pipfile-requirements
+          pipfile2req > requirements.txt
+          pipfile2req -d > requirements-dev.txt
+
+    restore_tox_37_cache: &restore_tox_37_cache
+      restore_cache:
+        key: tox-37-cache-{{ checksum "Pipfile" }}-{{ checksum "Pipfile.lock" }}
+
+    save_tox_37_cache: &save_tox_37_cache
+      save_cache:
+        key: tox-37-cache-{{ checksum "Pipfile" }}-{{ checksum "Pipfile.lock" }}
+        paths:
+          - .tox/py37
+
 jobs:
   tox3-7-unit-tests:
       # docker image circleci/python:3.8.3-buster-node also contains python 3.7
       docker:
         - image: circleci/python:3.8.3-buster-node
       steps:
         - checkout
-        - restore_cache:
-            key: tox-37-cache-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
+        - *create_requirement_files
+        - *restore_tox_37_cache
         - run:
             # install npm modules so readme tests run with mdx verification
             name: npm install
@@ -41,18 +59,16 @@ jobs:
             no_output_timeout: 15m
             command: |
               tox -e py37 -v
-        - save_cache:
-            key: tox-37-cache-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
-            paths:
-              - .tox/py37
+        - *save_tox_37_cache
 
   tox3-8-unit-tests:
       docker:
         - image: circleci/python:3.8.3-buster-node
       steps:
         - checkout
+        - *create_requirement_files
         - restore_cache:
-            key: tox-38-cache-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
+            key: tox-38-cache-{{ checksum "Pipfile" }}-{{ checksum "Pipfile.lock" }}
         - run:
             # install npm modules so readme tests run with mdx verification
             name: npm install
@@ -84,8 +100,8 @@ jobs:
       - image: circleci/python:3.8.3-buster-node
     steps:
       - checkout
-      - restore_cache:
-          key: tox-37-cache-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
+      - *create_requirement_files
+      - *restore_tox_37_cache
       - run:
           # install npm modules so readme tests run with mdx verification
           name: npm install
@@ -99,10 +115,7 @@ jobs:
           name: Tox build
           command: |
             tox -e py37 --notest
-      - save_cache:
-          key: tox-37-cache-{{ checksum "requirements.txt" }}-{{ checksum "requirements-dev.txt" }}
-          paths:
-            - .tox/py37
+      - *save_tox_37_cache
       - persist_to_workspace:
           root: ~/project
           paths:

CONTRIBUTION.md

@@ -5,11 +5,11 @@ We build `demisto-sdk` to support python 3.7 and 3.8.
 
 ## Getting started
 
-1. [Clone demisto-sdk repository](#1-Clone-demisto-sdk-repository)
-2. [Install demisto sdk dev environment](#2-Install-demisto-sdk-dev-environment)
-3. [Pre-commit hooks setup](#3-Pre-commit-hooks-setup)
-4. [DemistoContentPython Libary](#4-DemistoContentPython-Libary)
-5. [Develop new command](#5-Develop-new-command)
+1. [Clone demisto-sdk repository](#1-clone-demisto-sdk-repository)
+2. [Install demisto sdk dev environment](#2-install-demisto-sdk-dev-environment)
+3. [Pre-commit hooks setup](#3-pre-commit-hooks-setup)
+4. [DemistoContentPython Library](#4-demistocontentpython-library)
+5. [Develop new command](#5-develop-new-command)
 6. [Running unit-tests using tox](#6-running-unit-tests-using-tox)
 7. [Push changes to GitHub (External PRs)](#7-push-changes-to-github-relevant-only-for-external-prs)
 8. [Review Process](#8-review-process)
@@ -33,33 +33,33 @@ This will be used as your testing environment, you do not need to update it agai
 
 1. Make sure you have python3 installed.
 
-2. Add executable permissions to our setup script by running `chmod a+x ~/dev/demisto/demisto-sdk/demisto-sdk-development.sh`.
+2. Make sure you have pipenv installed.
 
-3. Run the script: `~/dev/demisto/demisto-sdk/demisto-sdk-development.sh`.
-   * You might need to setup your SHELL env variable by running `export SHELL=/bin/zsh` or `export SHELL=/bin/bash`.
+3. run `pipenv install --dev`
 
-4. Restart your terminal.
+4. To install local version of demisto-sdk, run `pipenv install --keep-outdated -e <path to your demisto-sdk repo>`
 
-You have now setup the your `demisto-sdk-dev` env!
+5. For further reading about pipenv, you can refer to [pipenv documentation](https://pipenv.pypa.io/en/latest/).
 
-To activate it simply run: `workon demisto-sdk-dev`
+You have now setup the your `demisto-sdk` dev environment!
+
+To activate it simply run: `pipenv shell`.
    * Check that the demisto-sdk installed is your local version by running `demisto-sdk -v` - you will should see something similar to `demisto-sdk 1.X.X.dev`.
-     If not, while your current working directory is the `demisto-sdk` root repo by runnning `cd ~/dev/demisto/demisto-sdk` and then run `pip3 install -e .`.
 
-To deactivate the virtual environment and return simply run: `deactivate`.
+To deactivate the virtual environment and return simply run: `exit`.
    * Note that your local `demisto-sdk` version should remain unchanged.
 
 ---
 
 ### 3. Pre-commit hooks setup
 We use are using [pre-commit](https://pre-commit.com/) to run hooks on our build. To use it run:
-1. Install hook to be performed as a hook before commiting changes - `pre-commit install`
+1. Install hook to be performed as a hook before commit changes - `pre-commit install`
 2. Enable auto update of pre-commit hooks - `pre-commit autoupdate`
-3. In order to run pre-commit without commiting - `pre-commit run -a` (on all files), `pre-commit run` (on staged files)
+3. In order to run pre-commit without commit- `pre-commit run -a` (on all files), `pre-commit run` (on staged files)
 
 ---
 
-### 4. DemistoContentPython Libary
+### 4. DemistoContentPython Library
 ContentPython is a python library used to interact with Demisto Content repository, high-level abstraction.
 For more information read the following [guide](demisto_sdk/commands/common/content/README.md).
 

Pipfile

@@ -0,0 +1,69 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+astroid = ">=2.4.2,<2.5.4"
+autopep8 = "*"
+bandit = "*"
+bs4 = "*"
+chardet = "==3.0.2"
+click = "==7.1.2"
+colorama = "*"
+coloredlogs = "*"
+configparser = "*"
+coverage = "*"
+dateparser = "*"
+decorator = "*"
+demisto-py = "*"
+dictor = "*"
+docker = "==4.3.0"
+flake8 = "*"
+flatten-dict = "*"
+gitdb = "*"
+google-cloud-storage = "==1.29.0"
+inflection = "==0.5.1"
+isort = "*"
+jsonschema = "*"
+mergedeep = "*"
+mypy = "==0.782"
+networkx = "*"
+nltk = "*"
+pandas = "*"
+pipenv = "*"
+prettytable = "==0.7.2"
+pykwalify = "*"
+pylint = "==2.6.0"
+pyspellchecker = "*"
+requests = "*"
+"ruamel.yaml" = "<0.17"
+slackclient = "==2.9.3"
+tabulate = "*"
+ujson = "*"
+urllib3 = "*"
+vulture = "*"
+wcmatch = "*"
+yamlordereddictloader = "*"
+GitPython = "*"
+Jinja2 = "<3.0,>=2.11.1"
+Pebble = "*"
+PyPDF2 = "*"
+PyYAML = "*"
+
+[dev-packages]
+mitmproxy = "==5.1.0"
+mock = "*"
+pre-commit = "*"
+pytest = "*"
+pytest-cov = "*"
+pytest-datadir-ng = "*"
+pytest-mock = "*"
+pytest-subprocess = "*"
+requests-mock = "*"
+tox-pyenv = "*"
+Deprecated = "*"
+pipfile-requirements = "*"
+
+[requires]
+python_version = "3.9"