Add CircleCI to the Python client

Author: Samuel Hassine

.circleci/config.yml

@@ -0,0 +1,54 @@
+version: 2.1
+
+jobs:
+  build:
+    working_directory: ~/opencti-client
+    docker:
+      - image: circleci/python:3.6
+    steps:
+      - checkout
+      - run:
+          name: build
+          command: python3 setup.py sdist
+      - persist_to_workspace:
+          root: ~/
+          paths:
+            - opencti-client
+  deploy:
+    working_directory: ~/opencti-client
+    docker:
+      - image: circleci/python:3.6
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: verify git tag vs. version
+          command: python3 setup.py verify
+      - run:
+          name: install twine
+          command: pip3 install twine
+      - run:
+          name: init .pypirc
+          command: |
+            echo -e "[pypi]" >> ~/.pypirc
+            echo -e "username = opencti" >> ~/.pypirc
+            echo -e "password = $PYPI_PASSWORD" >> ~/.pypirc
+      - run:
+          name: upload to pypi
+          command: twine upload dist/*
+
+workflows:
+  opencti_client_python:
+    jobs:
+      - build:
+          filters:
+            tags:
+              only: /.*/
+      - deploy:
+          requires:
+            - build
+          filters:
+            tags:
+              only: /[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve OpenCTI
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please replace every line in curly brackets { like this } with an appropriate answer, and remove this line.
+
+## Description
+
+{ Please provide a clear and concise description of the bug. }
+
+## Environment
+
+1. OS (where OpenCTI server runs): { e.g. Mac OS 10, Windows 10, Ubuntu 16.4, etc. }
+2. OpenCTI version: { e.g. OpenCTI 1.0.2 }
+3. Other environment details:
+
+## Reproducible Steps
+
+Steps to create the smallest reproducible scenario:
+1. { e.g. Run ... }
+2. { e.g. Click ... }
+3. { e.g. Error ... }
+
+## Expected Output
+
+{ Please describe what you expected to happen. }
+
+## Actual Output
+
+{ Please describe what actually happened. }
+ 
+## Additional information
+
+{ Any additional information, including logs or screenshots if you have any. }

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Ask for a new feature to be implemented in OpenCTI
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please replace every line in curly brackets { like this } with appropriate answers, and remove this line.
+
+## Problem to Solve
+
+{ Please describe the problem you would like to solve. }
+
+## Current Workaround
+
+{ Please describe how you currently solve or work around this problem, given OpenCTI's limitation. }
+
+## Proposed Solution
+
+{ Please describe the solution you would like OpenCTI to provide, to solve the problem above. }
+
+## Additional Information
+
+{ Any additional information, including logs or screenshots if you have any. }

.gitignore

@@ -0,0 +1,7 @@
+config.yml
+__pycache__
+exports
+build
+dist
+pycti.egg-info
+logs

setup.py

@@ -1,6 +1,7 @@
 #!/usr/bin/python3
 # coding: utf-8
-
+import os
+import sys
 from setuptools import setup
 
 try:
@@ -10,14 +11,25 @@
     print("warning: pypandoc module not found, could not convert Markdown to RST")
     read_md = lambda f: open(f, 'r').read()
 
+class VerifyVersionCommand(install):
+    description = 'verify that the git tag matches our version'
+
+    def run(self):
+        tag = os.getenv('CIRCLE_TAG')
+        if tag != VERSION:
+            info = "Git tag: {0} does not match the version of this app: {1}".format(
+                tag, VERSION
+            )
+            sys.exit(info)
+
 setup(
     name='pycti',
-    version='1.0.2',
+    version='1.0.4',
     description='Python API client for OpenCTI.',
-    long_description='This is the official Python client for the OpenCTI application',
-    author='Luatix',
+    long_description='Official Python client for the OpenCTI platform.',
+    author='OpenCTI',
     author_email='[email protected]',
-    maintainer='Luatix',
+    maintainer='OpenCTI',
     url='https://github.com/OpenCTI-Platform/client-python',
     license='AGPL-V3',
     packages=['pycti'],
@@ -35,5 +47,8 @@
         'Topic :: Software Development :: Libraries :: Python Modules'
     ],
     include_package_data=True,
-    install_requires=['requests']
+    install_requires=['requests', 'PyYAML', 'python-dateutil'],
+    cmdclass={
+        'verify': VerifyVersionCommand,
+    }
 )