Merge pull request #9 from kaisero/develop

Version 0.0.3 Release

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+ignore = E203, E266, E501, W503, F403, F401
+max-line-length = 120
+max-complexity = 18
+select = B,C,E,F,W,T4,B9

.gitignore

@@ -1,6 +1,121 @@
-.idea
-.idea/*
-*.pyc
-*~
-__pycache__
-prototype.py
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: flake8
+      - id: double-quote-string-fixer
+  - repo: https://github.com/psf/black
+    rev: 19.3b0
+    hooks:
+      - id: black

Pipfile

@@ -0,0 +1,24 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+requests = "*"
+PyYAML = "*"
+urllib3 = "*"
+
+[dev-packages]
+black = "*"
+pytest = "*"
+pytest-runner = "*"
+mypy = "*"
+pep8 = "*"
+pycodestyle = "*"
+flake8 = "*"
+autopep8 = "*"
+pre-commit = "*"
+twine = "*"
+
+[requires]
+python_version = "3.6"

README.md

@@ -1,27 +1,22 @@
-# FireREST
+# What is FireREST
 
 FireREST is a simple wrapper for Cisco Firepower Management Center REST API. It exposes various api calls
 as functions and takes care of authentication, token refresh and paging for large datasets.
 
-## Compatibility
+## Requirements 
 
-FireREST is compatible with Python3.
+* Python >= 3.6
 
-## Features
+## Installation
 
-* API Authentication (incl. api token refresh & re-authentication after max refresh is reached)
-* POST, PUT, GET, DELETE operations for...
-** TBD
+```bash
+$ pip install fireREST
+```
 
-* GET operations for...
-** TBD
+## Authors 
 
-## Examples
+Oliver Kaiser ([email protected])
 
-## TODO
+## License
 
-* Support for api rate limiting
-* Provide json validation for implemented api functions
-* Test coverage for core functions
-* Test coverage for api calls exposed as functions
-* Pypi integration
+GNU General Public License v3.0