Chore/set up automation (#4)

Author: alanag13

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+source = src

.editorconfig

@@ -0,0 +1,14 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+[*.py]
+max_line_length = 100

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [2.7, 3.5, 3.6, 3.7, 3.8]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install tox
+        run: pip install tox==3.14.3
+      - name: Run Tox
+        run: tox -e py  # Run tox using the version of Python in `PATH`

.github/workflows/publish.yml

@@ -0,0 +1,69 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build Release
+      run: |
+          python setup.py sdist bdist_wheel
+    - name: Set File Names and Release IDs
+      run: |
+          src_file=( ./dist/*.tar.gz )
+          wheel_file=( ./dist/*.whl )
+          echo "::set-env name=RELEASE_ID::$(jq --raw-output '.release.id' $GITHUB_EVENT_PATH)"
+          echo "::set-env name=SOURCE_DIST_FILE::$(basename $src_file)"
+          echo "::set-env name=WHEEL_FILE::$(basename $wheel_file)"
+    - name: Set Upload Url
+      run: |
+          echo "::set-env name=UPLOAD_URL::https://uploads.github.com/repos/${GITHUB_REPOSITORY}/releases/${RELEASE_ID}/assets{?name,label}"
+    - name: Output Variables For Uploading
+      id: get_upload_vars
+      run: |
+          echo "Release ID: $RELEASE_ID"
+          echo "Source Dist File: $SOURCE_DIST_FILE"
+          echo "Source Dist Upload Url: $SOURCE_DIST_URL"
+          echo "Wheel File: $WHEEL_FILE"
+          echo "Upload Url: $UPLOAD_URL"
+          echo "::set-output name=source_dist_path::./dist/${SOURCE_DIST_FILE}"
+          echo "::set-output name=source_dist_name::${SOURCE_DIST_FILE}"
+          echo "::set-output name=wheel_path::./dist/${WHEEL_FILE}"
+          echo "::set-output name=wheel_name::./dist/${WHEEL_FILE}"
+          echo "::set-output name=upload_url::${UPLOAD_URL}"
+    - name: Upload Source Distribution to GitHub release
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.get_upload_vars.outputs.upload_url }}
+        asset_path: ${{ steps.get_upload_vars.outputs.source_dist_path }}
+        asset_name: ${{ steps.get_upload_vars.outputs.source_dist_name }}
+        asset_content_type: application/x-gzip
+    - name: Upload Wheel to GitHub Release
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.get_upload_vars.outputs.upload_url }}
+        asset_path: ${{ steps.get_upload_vars.outputs.wheel_path }}
+        asset_name: ${{ steps.get_upload_vars.outputs.wheel_name }}
+        asset_content_type: application/zip
+    - name: Publish Build to PyPI
+      env:
+        TWINE_USERNAME: '__token__'
+        TWINE_PASSWORD: ${{ secrets.PYPI_ACCESS_TOKEN }}
+      run: |
+        twine upload dist/*

.gitignore

@@ -1,8 +1,11 @@
 # Test config file
 *config.cfg
 
+.DS_Store
+
 # IDE files
 .idea/
+.vscode
 
 # Database files
 *.db

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -10,22 +11,36 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 ## Unreleased
 
 ### Removed
-- Removed config file settings and `-c` CLI arg. Use `c42sec profile set`.
-- Removed `--clear-password` CLI argument. Use `c42sec profile set -p`. You will be prompted.
+
+- Removed config file settings and `-c` CLI arg. Use `code42 profile set`.
+- Removed `--clear-password` CLI argument. Use `code42 profile set -p`. You will be prompted.
+- Removed top-level destination args. Use subcommands `write-to`. `send-to`, `print` off of `code42 security data`.
 
 ### Added
-- Added ability to view your profile: `c42sec profile show`.
+
+- Added ability to view your profile: `code42 profile show`.
+- Added `securitydata` subcommands:
+    - Use `code42 securitydata write-to` to output to a file.
+    - Use `code42 securitydata send-to` to output to a server.
+    - Use `code42 securitydata print` to outputs to stdout.
+    - Use `code42 securitydata clear-cursor` to remove the stored cursor for 'incremental' mode.
+- Added support for raw JSON queries via `code42 securitydata [subcommand] --advanced-query [JSON]`.
 
 ### Changed
-- Renamed `c42aed` to `c42sec`.
-- Moved CLI arguments `-s`, `-u`, and `--ignore-ssl-errors` to `c42sec profile set` command.
 
+- Renamed base command `c42aed` to `code42`.
+- Moved CLI arguments `-s`, `-u`, and `--ignore-ssl-errors` to `code42 profile set` command.
+- Renamed and moved top-level `-r` flag. 
+    - Use `-i` on one of these `securitydata` subcommands `write-to`. `send-to`, `print`.
+- Moved search arguments to individual `securitydata` subcommands `write-to`. `send-to`, `print`.
 
 ## 0.1.1 - 2019-10-29
 
 ### Fixed
+
 - Issue where IOError message was inaccurate when using the wrong port for server destinations.
 
 ### Added
+
 - Error handling for all socket errors.
 - Error handling for IOError 'connection refused'.

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing to code42cli
+
+## Development environment
+
+Install code42cli and its development dependencies. The `-e` option installs py42 in 
+["editable mode"](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs). 
+
+```bash
+$ pip install -e .[dev]
+```
+
+If you are using `zsh`, you may need to escape the brackets.
+
+We use [black](https://black.readthedocs.io/en/stable/) to automatically format our code.
+After installing dependencies, be sure to run:
+
+```bash
+$ pre-commit install
+```
+
+This will set up a pre-commit hook that will automatically format your code to our desired styles whenever you commit.
+It requires python 3.6 to run, so be sure to have a python 3.6 executable of some kind in your PATH when you commit.
+
+## General
+
+* Use positional argument specifiers in `str.format()`
+* Use syntax and built-in modules that are compatible with both Python 2 and 3.
+* Use the `code42cli._internal.compat` module to create abstractions around functionality that differs between 2 and 3.
+
+## Changes
+
+Document all notable consumer-affecting changes in CHANGELOG.md per principles and guidelines at
+[Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Tests
+
+We use [tox](https://tox.readthedocs.io/en/latest/#) to run the
+[pytest](https://docs.pytest.org/) test framework on Python 2.7, 3.5, 3.6, and 3.7.
+
+To run all tests, run this at the root of the repo:
+
+```bash
+$ tox
+```
+
+If you're using a virtual environment, this will only run the tests within that environment/version of Python.
+To run the tests on all supported versions of Python in a local dev environment, we recommend using 
+[pyenv](https://github.com/pyenv/pyenv) and tox in your system (non-virtual) environment:
+
+```bash
+$ pip install tox
+$ pyenv install 2.7.16
+$ pyenv install 3.5.7
+$ pyenv install 3.6.9
+$ pyenv install 3.7.4
+$ pyenv local 2.7.16 3.5.7 3.6.9 3.7.4
+$ tox
+```
+
+### Writing tests
+
+Put actual before expected values in assert statements. Pytest assumes this order.
+
+```python
+a = 4
+assert a % 2 == 0
+```
+
+Use the following naming convention with test methods:  
+
+test\_\[unit_under_test\]\_\[variables_for_the_test\]\_\[expected_state\]
+
+Example:
+
+```python
+def test_add_one_and_one_equals_two():
+```

MANIFEST.in

@@ -0,0 +1 @@
+include README.md LICENSE.md tox.ini

README.md

@@ -1,37 +1,79 @@
-# c42sec
+# The Code42 CLI
 
-The c42seceventcli AED module contains a CLI tool for extracting AED events as well as an optional state manager 
-for recording timestamps. The state manager records timestamps so that on future runs,
-you only extract events you did not previously extract.
+Use the `code42` command to interact with your Code42 environment.
+`code42 securitydata` is a CLI tool for extracting AED events. 
+Additionally, `code42 securitydata` can record a checkpoint so that you only get events you have not previously gotten.
 
 ## Requirements
 
 - Python 2.7.x or 3.5.0+
 - Code42 Server 6.8.x+
 
 ## Installation
-Install `c42sec` using:
+Install the `code42` CLI using:
 
 ```bash
 $ python setup.py install
 ```
 
 ## Usage
 
-First, set your profile
-
+First, set your profile:
 ```bash
-c42sec profile set -s https://example.authority.com -u [email protected] -p
+code42 profile set -s https://example.authority.com -u [email protected]
 ```
+Your profile contains the necessary properties for logging into Code42 servers.
+You will prompted for a password if there is not one saved for your current username/authority URL combination.
 
-`-p` will prompt for your password securely. If your username does not have a password stored, you will be prompted anyway.
+To explicitly set your password, use `-p`:
+```bash
+code42 profile set -p
+```
+You will be securely prompted to input your password.
+Your password is not stored in plain-text, and is not shown when you do `code42 profile show`.
+However, `code42 profile show` will confirm that there is a password set for your profile.
 
 To ignore SSL errors, do:
+```bash
+code42 profile set --disable-ssl-errors
+```
 
+To re-enable SSL errors, do:
 ```bash
-c42sec profile set --ignore-ssl-errors true
+code42 profile set --enable-ssl-errors
 ```
 
+Next, you can query for events and send them to three possible destination types
+* stdout
+* A file
+* A server, such as SysLog
+
+To print events to stdout, do:
+```bash
+code42 securitydata print
+```
+
+To write events to a file, do:
+```bash
+code42 securitydata write-to filename.txt
+```
+
+To send events to a server, do:
+```bash
+code42 securitydata send-to https://syslog.company.com -p TCP
+```
+
+Each destination-type subcommand shares query parameters
+* `-t` (exposure types)
+* `-b` (begin date)
+* `-e` (end date)
+* `--advanced-query` (raw JSON query)
+
+Note that you cannot use other query parameters if you use `--advanced-query`.
+
+To learn more about acceptable arguments, add the `-h` flag to `code42` or and of the destination-type subcommands.
+
+
 # Known Issues
 
 Only the first 10,000 of each set of events containing the exact same insertion timestamp is reported.