Additional repo cleanup (#174)

* cleanup tox.ini

* udpate README

* rename workflows

* update contributing

* add SUPPORT.md

Author: sserrata

.github/workflows/pydocs.yml .github/workflows/pydocs-preview.yml.github/workflows/pydocs.yml renamed to .github/workflows/pydocs-preview.yml

@@ -1,4 +1,4 @@
-name: PyPI upload
+name: PyPI Publish
 
 on:
   release:

.github/workflows/pythonpublish.yml .github/workflows/pypi_publish.yml.github/workflows/pythonpublish.yml renamed to .github/workflows/pypi_publish.yml

@@ -1,112 +1,60 @@
-# Contributing
+# How to contribute
 
-Contributions are welcome, and they are greatly appreciated\! Every
-little bit helps, and credit will always be given.
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
-You can contribute in many ways:
+It's people like you that make security open source such a force in preventing
+successful cyber-attacks. Following these guidelines helps keep the project
+maintainable, easy to contribute to, and more secure. Thank you for taking the
+time to follow this guide.
 
-## Types of Contributions
+## Where to start
 
-### Report Bugs
+There are many ways to contribute. You can fix a bug, improve the documentation,
+submit bug reports and feature requests, or take a first shot at a feature you
+need for yourself.
 
-Report bugs at
-<https://github.com/PaloAltoNetworks/cortex-data-lake-python/issues>.
+Pull requests are necessary for all contributions of code or documentation.
 
-If you are reporting a bug, please include:
+## New to open source?
 
--   Your operating system name and version.
--   Any details about your local setup that might be helpful in
-    troubleshooting.
--   Detailed steps to reproduce the bug.
+If you're **new to open source** and not sure what a pull request is, welcome!!
+We're glad to have you! All of us once had a contribution to make and didn't
+know where to start.
 
-> If you are reporting a bug specific to the Cortex Data Lake API, please
-> contact Palo Alto Networks TAC to open a case.
+Even if you don't write code for your job, don't worry, the skills you learn
+during your first contribution to open source can be applied in so many ways,
+you'll wonder what you ever did before you had this knowledge. It's worth
+learning.
 
-### Fix Bugs
+[Learn how to make a pull request](https://github.com/PaloAltoNetworks/.github/blob/master/Learn-GitHub.md#learn-how-to-make-a-pull-request)
 
-Look through the GitHub issues for bugs. Anything tagged with "bug" and
-"help wanted" is open to whoever wants to implement it.
+## Fixing a typo, or a one or two line fix
 
-### Implement Features
+Many fixes require little effort or review, such as:
 
-Look through the GitHub issues for features. Anything tagged with
-"enhancement" and "help wanted" is open to whoever wants to implement
-it.
+> - Spelling / grammar, typos, white space and formatting changes
+> - Comment clean up
+> - Change logging messages or debugging output
 
-# Write Documentation
+These small changes can be made directly in GitHub if you like.
 
-The Cortex Data Lake Python SDK could always use more documentation,
-whether as part of the official docs, in docstrings, or even on the web
-in blog posts, articles, and such.
+Click the pencil icon in GitHub above the file to edit the file directly in
+GitHub. This will automatically create a fork and pull request with the change.
+See:
+[Make a small change with a Pull Request](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github/)
 
-More details can be found here:
-<https://cortex.pan.dev/docs/contributing>
+## Bug fixes and features
 
-# Submit Feedback
+For something that is bigger than a one or two line fix, go through the process
+of making a fork and pull request yourself:
 
-The best way to send feedback is to file an issue at
-<https://github.com/PaloAltoNetworks/cortex-data-lake-python/issues>.
+> 1. Create your own fork of the code
+> 2. Clone the fork locally
+> 3. Make the changes in your local clone
+> 4. Push the changes from local to your fork
+> 5. Create a pull request to pull the changes from your fork back into the
+>    upstream repository
 
-If you are proposing a feature:
-
--   Explain in detail how it would work.
--   Keep the scope as narrow as possible, to make it easier to
-    implement.
--   Remember that this is a volunteer-driven project, and that
-    contributions are welcome :)
-
-## Get Started\!
-
-Ready to contribute? Here's how to set up `cortex-data-lake-python` for
-local development.
-
-1.  Fork the `cortex-data-lake-python` repo on GitHub.
-
-2.  Clone your fork locally:
-
-        $ git clone git@github.com:your_name_here/cortex-data-lake-python.git
-
-3.  Install your local copy into a virtual environment. Assuming you have `venv`
-    installed, this is how you set up your fork for local development:
-
-        $ python -m venv env
-        $ source env/bin/activate
-        $ pip install -r requirements_dev.txt
-
-4.  Create a branch for local development:
-
-        $ git checkout -b name-of-your-bugfix-or-feature
-
-    Now you can make your changes locally.
-
-5.  When you're done making changes, check that your changes pass flake8
-    and the tests, including testing other Python versions with tox:
-
-        $ flake8 cortex tests
-        $ python setup.py test or py.test
-        $ tox
-
-6.  Commit your changes and push your branch to GitHub:
-
-        $ git add .
-        $ git commit -m "Your detailed description of your changes."
-        $ git push origin name-of-your-bugfix-or-feature
-
-7.  Submit a pull request through the GitHub website.
-
-## Pull Request Guidelines
-
-Before you submit a pull request, check that it meets these guidelines:
-
-1.  The pull request should include tests.
-2.  If the pull request adds functionality, the docs should be updated.
-    Put your new functionality into a function with a docstring, and add
-    the feature to the list in README.rst.
-3.  The pull request should work for Python 2.7, 3.5 and 3.6, 3.8, and
-    for PyPy2 and PyPy3.
-
-## Tips
-
-To run a subset of tests:
-
-    $ pytest tests.test_httpclient
+Please use clear commit messages so we can understand what each commit does.
+We'll review every PR and might offer feedback or request changes before
+merging.

.github/workflows/pythonpackage.yml .github/workflows/test.yml.github/workflows/pythonpackage.yml renamed to .github/workflows/test.yml

@@ -1,4 +1,4 @@
-![Tests](https://github.com/PaloAltoNetworks/pan-cortex-data-lake-python/workflows/Tests/badge.svg) ![PyPI upload](https://github.com/PaloAltoNetworks/pan-cortex-data-lake-python/workflows/PyPI%20upload/badge.svg?branch=master) [![PyPI version](https://badge.fury.io/py/pan-cortex-data-lake.svg)](https://badge.fury.io/py/pan-cortex-data-lake)
+![Tests](https://github.com/PaloAltoNetworks/pan-cortex-data-lake-python/workflows/Tests/badge.svg) ![PyPI upload](https://github.com/PaloAltoNetworks/pan-cortex-data-lake-python/workflows/PyPI%20upload/badge.svg?branch=master) ![![PyPI version](https://badge.fury.io/py/pan-cortex-data-lake.svg)](https://badge.fury.io/py/pan-cortex-data-lake)
 
 # Palo Alto Networks Cortex™ Data Lake SDK
 
@@ -18,10 +18,11 @@ common tasks/operations.
 
 -   Log/event pagination
 -   OAuth 2.0 and token refreshing
--   More, coming soon!
+
+Resources:
 
 -   Documentation: <https://cortex.pan.dev>
--   Free software: ISC license
+-   Free software: [ISC license](https://choosealicense.com/licenses/isc/)
 
 ---
 
@@ -36,13 +37,27 @@ common tasks/operations.
 
 ## Status
 
-The Palo Alto Networks Cortex™ Data Lake Python SDK is considered **alpha** at this time.
+The Palo Alto Networks Cortex™ Data Lake Python SDK is considered **beta** at this time.
 
 ## Installation
 
 From PyPI:
 
-    $ pip install pan-cortex-data-lake
+```bash
+pip install pan-cortex-data-lake
+```
+
+From source:
+
+```bash
+pip install .
+```
+
+To run tests:
+
+```bash
+pip install .[test]
+```
 
 ## Obtaining and Using OAuth 2.0 Tokens
 
@@ -51,22 +66,21 @@ If you're an app developer, work with your Developer Relations representative to
 # Example
 
 ```python
->>> from pan_cortex_data_lake import Credentials, QueryService
->>> c = Credentials()
->>> qs = QueryService(credentials=c)
->>> query_params = {
-...     "query": "SELECT * FROM `1234567890.firewall.traffic` LIMIT 1",
-... }
->>> q = qs.create_query(query_params=query_params)
->>> q.status_code
-201
->>> q.json()
-{'jobId': '40fedce6-ddf5-44cf-9af2-7c3d5303f388', 'uri': '/query/v2/jobs/40fedce6-ddf5-44cf-9af2-7c3d5303f388'}
->>> results = qs.get_job_results(job_id='40fedce6-ddf5-44cf-9af2-7c3d5303f388')
->>> results.json()
+from pan_cortex_data_lake import Credentials, QueryService
+
+
+c = Credentials()
+qs = QueryService(credentials=c)
+query_params = {
+    "query": "SELECT * FROM `1234567890.firewall.traffic` LIMIT 1",
+}
+q = qs.create_query(query_params=query_params)
+results = qs.get_job_results(job_id=q.json()['jobId'])
+print(results.json())
 ```
 
 # Contributors
 
--   Kevin Steves - [github](https://github.com/kevinsteves)
--   Steven Serrata - [github](https://github.com/sserrata)
+<a href="https://github.com/PaloAltoNetworks/pan-cortex-data-lake-python/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=PaloAltoNetworks/pan-cortex-data-lake-python" />
+</a>

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+Community Supported
+
+The software and templates in the repo are released under an as-is, best effort,
+support policy. This software should be seen as community supported and Palo
+Alto Networks will contribute our expertise as and when possible. We do not
+provide technical support or help in using or troubleshooting the components of
+the project through our normal support options such as Palo Alto Networks
+support teams, or ASC (Authorized Support Centers) partners and backline support
+options. The underlying product used (the VM-Series firewall) by the scripts or
+templates are still supported, but the support is only for the product
+functionality and not for help in deploying or using the template or script
+itself. Unless explicitly tagged, all projects or work posted in our GitHub
+repository (at https://github.com/PaloAltoNetworks) or sites other than our
+official Downloads page on https://support.paloaltonetworks.com are provided
+under the best effort policy.

MANIFEST.in

@@ -1,17 +1,7 @@
 [tox]
-envlist = py27, py35, py36, py37, py38, pypy, pypy3 flake8
+envlist = py35, py36, py37, py38, pypy3 flake8
 skipsdist = True
 
-[travis]
-python =
-    pypy3: pypy3
-    pypy: pypy
-    3.8: py38
-    3.7: py37
-    3.6: py36
-    3.5: py35
-    2.7: py27
-
 [testenv:flake8]
 basepython=python
 deps=flake8
@@ -20,17 +10,10 @@ commands=flake8 pan_cortex_data_lake
 [testenv]
 setenv =
     PYTHONPATH = {toxinidir}
-deps =
-    -r{toxinidir}/requirements_dev.txt
-    -r{toxinidir}/requirements.txt
 commands =
     pip install -U pip
+    pip install .[test]
     py.test -v ./tests --basetemp={envtmpdir}
 
 [flake8]
 ignore = E501, E402
-
-; If you want to make tox run the tests with the same versions, create a
-; requirements.txt with the pinned versions and uncomment the following lines:
-; deps =
-;     -r{toxinidir}/requirements.txt