initial commit
This commit is contained in:
commit
a57d852670
|
|
@ -0,0 +1,23 @@
|
|||
venv/
|
||||
test-venv/
|
||||
|
||||
*.pyc
|
||||
__pycache__/
|
||||
|
||||
instance/
|
||||
|
||||
.pytest_cache/
|
||||
.coverage
|
||||
htmlcov/
|
||||
|
||||
dist/
|
||||
build/
|
||||
*.egg-info/
|
||||
|
||||
node_modules/
|
||||
|
||||
.envs
|
||||
session_files/
|
||||
mongo_data/
|
||||
test_data/
|
||||
|
||||
|
|
@ -0,0 +1,634 @@
|
|||
[MAIN]
|
||||
|
||||
# Analyse import fallback blocks. This can be used to support both Python 2 and
|
||||
# 3 compatible code, which means that the block might have code that exists
|
||||
# only in one or another interpreter, leading to false positives when analysed.
|
||||
analyse-fallback-blocks=no
|
||||
|
||||
# Clear in-memory caches upon conclusion of linting. Useful if running pylint
|
||||
# in a server-like mode.
|
||||
clear-cache-post-run=no
|
||||
|
||||
# Load and enable all available extensions. Use --list-extensions to see a list
|
||||
# all available extensions.
|
||||
#enable-all-extensions=
|
||||
|
||||
# In error mode, messages with a category besides ERROR or FATAL are
|
||||
# suppressed, and no reports are done by default. Error mode is compatible with
|
||||
# disabling specific errors.
|
||||
#errors-only=
|
||||
|
||||
# Always return a 0 (non-error) status code, even if lint errors are found.
|
||||
# This is primarily useful in continuous integration scripts.
|
||||
#exit-zero=
|
||||
|
||||
# A comma-separated list of package or module names from where C extensions may
|
||||
# be loaded. Extensions are loading into the active Python interpreter and may
|
||||
# run arbitrary code.
|
||||
extension-pkg-allow-list=
|
||||
|
||||
# A comma-separated list of package or module names from where C extensions may
|
||||
# be loaded. Extensions are loading into the active Python interpreter and may
|
||||
# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
|
||||
# for backward compatibility.)
|
||||
extension-pkg-whitelist=
|
||||
|
||||
# Return non-zero exit code if any of these messages/categories are detected,
|
||||
# even if score is above --fail-under value. Syntax same as enable. Messages
|
||||
# specified are enabled, while categories only check already-enabled messages.
|
||||
fail-on=
|
||||
|
||||
# Specify a score threshold under which the program will exit with error.
|
||||
fail-under=10
|
||||
|
||||
# Interpret the stdin as a python script, whose filename needs to be passed as
|
||||
# the module_or_package argument.
|
||||
#from-stdin=
|
||||
|
||||
# Files or directories to be skipped. They should be base names, not paths.
|
||||
ignore=CVS
|
||||
|
||||
# Add files or directories matching the regular expressions patterns to the
|
||||
# ignore-list. The regex matches against paths and can be in Posix or Windows
|
||||
# format. Because '\\' represents the directory delimiter on Windows systems,
|
||||
# it can't be used as an escape character.
|
||||
ignore-paths=
|
||||
|
||||
# Files or directories matching the regular expression patterns are skipped.
|
||||
# The regex matches against base names, not paths. The default value ignores
|
||||
# Emacs file locks
|
||||
ignore-patterns=^\.#
|
||||
|
||||
# List of module names for which member attributes should not be checked
|
||||
# (useful for modules/projects where namespaces are manipulated during runtime
|
||||
# and thus existing member attributes cannot be deduced by static analysis). It
|
||||
# supports qualified module names, as well as Unix pattern matching.
|
||||
ignored-modules=
|
||||
|
||||
# Python code to execute, usually for sys.path manipulation such as
|
||||
# pygtk.require().
|
||||
#init-hook=
|
||||
|
||||
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
|
||||
# number of processors available to use, and will cap the count on Windows to
|
||||
# avoid hangs.
|
||||
jobs=1
|
||||
|
||||
# Control the amount of potential inferred values when inferring a single
|
||||
# object. This can help the performance when dealing with large functions or
|
||||
# complex, nested conditions.
|
||||
limit-inference-results=100
|
||||
|
||||
# List of plugins (as comma separated values of python module names) to load,
|
||||
# usually to register additional checkers.
|
||||
load-plugins=
|
||||
|
||||
# Pickle collected data for later comparisons.
|
||||
persistent=yes
|
||||
|
||||
# Minimum Python version to use for version dependent checks. Will default to
|
||||
# the version used to run pylint.
|
||||
py-version=3.8
|
||||
|
||||
# Discover python modules and packages in the file system subtree.
|
||||
recursive=no
|
||||
|
||||
# Add paths to the list of the source roots. Supports globbing patterns. The
|
||||
# source root is an absolute path or a path relative to the current working
|
||||
# directory used to determine a package namespace for modules located under the
|
||||
# source root.
|
||||
source-roots=
|
||||
|
||||
# When enabled, pylint would attempt to guess common misconfiguration and emit
|
||||
# user-friendly hints instead of false-positive error messages.
|
||||
suggestion-mode=yes
|
||||
|
||||
# Allow loading of arbitrary C extensions. Extensions are imported into the
|
||||
# active Python interpreter and may run arbitrary code.
|
||||
unsafe-load-any-extension=no
|
||||
|
||||
# In verbose mode, extra non-checker-related info will be displayed.
|
||||
#verbose=
|
||||
|
||||
|
||||
[BASIC]
|
||||
|
||||
# Naming style matching correct argument names.
|
||||
argument-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct argument names. Overrides argument-
|
||||
# naming-style. If left empty, argument names will be checked with the set
|
||||
# naming style.
|
||||
#argument-rgx=
|
||||
|
||||
# Naming style matching correct attribute names.
|
||||
attr-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct attribute names. Overrides attr-naming-
|
||||
# style. If left empty, attribute names will be checked with the set naming
|
||||
# style.
|
||||
#attr-rgx=
|
||||
|
||||
# Bad variable names which should always be refused, separated by a comma.
|
||||
bad-names=foo,
|
||||
bar,
|
||||
baz,
|
||||
toto,
|
||||
tutu,
|
||||
tata
|
||||
|
||||
# Bad variable names regexes, separated by a comma. If names match any regex,
|
||||
# they will always be refused
|
||||
bad-names-rgxs=
|
||||
|
||||
# Naming style matching correct class attribute names.
|
||||
class-attribute-naming-style=any
|
||||
|
||||
# Regular expression matching correct class attribute names. Overrides class-
|
||||
# attribute-naming-style. If left empty, class attribute names will be checked
|
||||
# with the set naming style.
|
||||
#class-attribute-rgx=
|
||||
|
||||
# Naming style matching correct class constant names.
|
||||
class-const-naming-style=UPPER_CASE
|
||||
|
||||
# Regular expression matching correct class constant names. Overrides class-
|
||||
# const-naming-style. If left empty, class constant names will be checked with
|
||||
# the set naming style.
|
||||
#class-const-rgx=
|
||||
|
||||
# Naming style matching correct class names.
|
||||
class-naming-style=PascalCase
|
||||
|
||||
# Regular expression matching correct class names. Overrides class-naming-
|
||||
# style. If left empty, class names will be checked with the set naming style.
|
||||
#class-rgx=
|
||||
|
||||
# Naming style matching correct constant names.
|
||||
const-naming-style=UPPER_CASE
|
||||
|
||||
# Regular expression matching correct constant names. Overrides const-naming-
|
||||
# style. If left empty, constant names will be checked with the set naming
|
||||
# style.
|
||||
#const-rgx=
|
||||
|
||||
# Minimum line length for functions/classes that require docstrings, shorter
|
||||
# ones are exempt.
|
||||
docstring-min-length=-1
|
||||
|
||||
# Naming style matching correct function names.
|
||||
function-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct function names. Overrides function-
|
||||
# naming-style. If left empty, function names will be checked with the set
|
||||
# naming style.
|
||||
#function-rgx=
|
||||
|
||||
# Good variable names which should always be accepted, separated by a comma.
|
||||
good-names=i,
|
||||
j,
|
||||
k,
|
||||
ex,
|
||||
Run,
|
||||
_
|
||||
|
||||
# Good variable names regexes, separated by a comma. If names match any regex,
|
||||
# they will always be accepted
|
||||
good-names-rgxs=
|
||||
|
||||
# Include a hint for the correct naming format with invalid-name.
|
||||
include-naming-hint=no
|
||||
|
||||
# Naming style matching correct inline iteration names.
|
||||
inlinevar-naming-style=any
|
||||
|
||||
# Regular expression matching correct inline iteration names. Overrides
|
||||
# inlinevar-naming-style. If left empty, inline iteration names will be checked
|
||||
# with the set naming style.
|
||||
#inlinevar-rgx=
|
||||
|
||||
# Naming style matching correct method names.
|
||||
method-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct method names. Overrides method-naming-
|
||||
# style. If left empty, method names will be checked with the set naming style.
|
||||
#method-rgx=
|
||||
|
||||
# Naming style matching correct module names.
|
||||
module-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct module names. Overrides module-naming-
|
||||
# style. If left empty, module names will be checked with the set naming style.
|
||||
#module-rgx=
|
||||
|
||||
# Colon-delimited sets of names that determine each other's naming style when
|
||||
# the name regexes allow several styles.
|
||||
name-group=
|
||||
|
||||
# Regular expression which should only match function or class names that do
|
||||
# not require a docstring.
|
||||
no-docstring-rgx=^_
|
||||
|
||||
# List of decorators that produce properties, such as abc.abstractproperty. Add
|
||||
# to this list to register other decorators that produce valid properties.
|
||||
# These decorators are taken in consideration only for invalid-name.
|
||||
property-classes=abc.abstractproperty
|
||||
|
||||
# Regular expression matching correct type alias names. If left empty, type
|
||||
# alias names will be checked with the set naming style.
|
||||
#typealias-rgx=
|
||||
|
||||
# Regular expression matching correct type variable names. If left empty, type
|
||||
# variable names will be checked with the set naming style.
|
||||
#typevar-rgx=
|
||||
|
||||
# Naming style matching correct variable names.
|
||||
variable-naming-style=snake_case
|
||||
|
||||
# Regular expression matching correct variable names. Overrides variable-
|
||||
# naming-style. If left empty, variable names will be checked with the set
|
||||
# naming style.
|
||||
#variable-rgx=
|
||||
|
||||
|
||||
[CLASSES]
|
||||
|
||||
# Warn about protected attribute access inside special methods
|
||||
check-protected-access-in-special-methods=no
|
||||
|
||||
# List of method names used to declare (i.e. assign) instance attributes.
|
||||
defining-attr-methods=__init__,
|
||||
__new__,
|
||||
setUp,
|
||||
asyncSetUp,
|
||||
__post_init__
|
||||
|
||||
# List of member names, which should be excluded from the protected access
|
||||
# warning.
|
||||
exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
|
||||
|
||||
# List of valid names for the first argument in a class method.
|
||||
valid-classmethod-first-arg=cls
|
||||
|
||||
# List of valid names for the first argument in a metaclass class method.
|
||||
valid-metaclass-classmethod-first-arg=mcs
|
||||
|
||||
|
||||
[DESIGN]
|
||||
|
||||
# List of regular expressions of class ancestor names to ignore when counting
|
||||
# public methods (see R0903)
|
||||
exclude-too-few-public-methods=
|
||||
|
||||
# List of qualified class names to ignore when counting class parents (see
|
||||
# R0901)
|
||||
ignored-parents=
|
||||
|
||||
# Maximum number of arguments for function / method.
|
||||
max-args=5
|
||||
|
||||
# Maximum number of attributes for a class (see R0902).
|
||||
max-attributes=7
|
||||
|
||||
# Maximum number of boolean expressions in an if statement (see R0916).
|
||||
max-bool-expr=5
|
||||
|
||||
# Maximum number of branch for function / method body.
|
||||
max-branches=12
|
||||
|
||||
# Maximum number of locals for function / method body.
|
||||
max-locals=15
|
||||
|
||||
# Maximum number of parents for a class (see R0901).
|
||||
max-parents=7
|
||||
|
||||
# Maximum number of public methods for a class (see R0904).
|
||||
max-public-methods=20
|
||||
|
||||
# Maximum number of return / yield for function / method body.
|
||||
max-returns=6
|
||||
|
||||
# Maximum number of statements in function / method body.
|
||||
max-statements=50
|
||||
|
||||
# Minimum number of public methods for a class (see R0903).
|
||||
min-public-methods=2
|
||||
|
||||
|
||||
[EXCEPTIONS]
|
||||
|
||||
# Exceptions that will emit a warning when caught.
|
||||
overgeneral-exceptions=builtins.BaseException,builtins.Exception
|
||||
|
||||
|
||||
[FORMAT]
|
||||
|
||||
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
|
||||
expected-line-ending-format=
|
||||
|
||||
# Regexp for a line that is allowed to be longer than the limit.
|
||||
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
|
||||
|
||||
# Number of spaces of indent required inside a hanging or continued line.
|
||||
indent-after-paren=4
|
||||
|
||||
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
|
||||
# tab).
|
||||
indent-string=' '
|
||||
|
||||
# Maximum number of characters on a single line.
|
||||
max-line-length=100
|
||||
|
||||
# Maximum number of lines in a module.
|
||||
max-module-lines=1000
|
||||
|
||||
# Allow the body of a class to be on the same line as the declaration if body
|
||||
# contains single statement.
|
||||
single-line-class-stmt=no
|
||||
|
||||
# Allow the body of an if to be on the same line as the test if there is no
|
||||
# else.
|
||||
single-line-if-stmt=no
|
||||
|
||||
|
||||
[IMPORTS]
|
||||
|
||||
# List of modules that can be imported at any level, not just the top level
|
||||
# one.
|
||||
allow-any-import-level=
|
||||
|
||||
# Allow explicit reexports by alias from a package __init__.
|
||||
allow-reexport-from-package=no
|
||||
|
||||
# Allow wildcard imports from modules that define __all__.
|
||||
allow-wildcard-with-all=no
|
||||
|
||||
# Deprecated modules which should not be used, separated by a comma.
|
||||
deprecated-modules=
|
||||
|
||||
# Output a graph (.gv or any supported image format) of external dependencies
|
||||
# to the given file (report RP0402 must not be disabled).
|
||||
ext-import-graph=
|
||||
|
||||
# Output a graph (.gv or any supported image format) of all (i.e. internal and
|
||||
# external) dependencies to the given file (report RP0402 must not be
|
||||
# disabled).
|
||||
import-graph=
|
||||
|
||||
# Output a graph (.gv or any supported image format) of internal dependencies
|
||||
# to the given file (report RP0402 must not be disabled).
|
||||
int-import-graph=
|
||||
|
||||
# Force import order to recognize a module as part of the standard
|
||||
# compatibility libraries.
|
||||
known-standard-library=
|
||||
|
||||
# Force import order to recognize a module as part of a third party library.
|
||||
known-third-party=enchant
|
||||
|
||||
# Couples of modules and preferred modules, separated by a comma.
|
||||
preferred-modules=
|
||||
|
||||
|
||||
[LOGGING]
|
||||
|
||||
# The type of string formatting that logging methods do. `old` means using %
|
||||
# formatting, `new` is for `{}` formatting.
|
||||
logging-format-style=old
|
||||
|
||||
# Logging modules to check that the string format arguments are in logging
|
||||
# function parameter format.
|
||||
logging-modules=logging
|
||||
|
||||
|
||||
[MESSAGES CONTROL]
|
||||
|
||||
# Only show warnings with the listed confidence levels. Leave empty to show
|
||||
# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
|
||||
# UNDEFINED.
|
||||
confidence=HIGH,
|
||||
CONTROL_FLOW,
|
||||
INFERENCE,
|
||||
INFERENCE_FAILURE,
|
||||
UNDEFINED
|
||||
|
||||
# Disable the message, report, category or checker with the given id(s). You
|
||||
# can either give multiple identifiers separated by comma (,) or put this
|
||||
# option multiple times (only on the command line, not in the configuration
|
||||
# file where it should appear only once). You can also use "--disable=all" to
|
||||
# disable everything first and then re-enable specific checks. For example, if
|
||||
# you want to run only the similarities checker, you can use "--disable=all
|
||||
# --enable=similarities". If you want to run only the classes checker, but have
|
||||
# no Warning level messages displayed, use "--disable=all --enable=classes
|
||||
# --disable=W".
|
||||
disable=raw-checker-failed,
|
||||
bad-inline-option,
|
||||
locally-disabled,
|
||||
file-ignored,
|
||||
suppressed-message,
|
||||
useless-suppression,
|
||||
deprecated-pragma,
|
||||
use-symbolic-message-instead,
|
||||
use-implicit-booleaness-not-comparison-to-string,
|
||||
use-implicit-booleaness-not-comparison-to-zero
|
||||
|
||||
# Enable the message, report, category or checker with the given id(s). You can
|
||||
# either give multiple identifier separated by comma (,) or put this option
|
||||
# multiple time (only on the command line, not in the configuration file where
|
||||
# it should appear only once). See also the "--disable" option for examples.
|
||||
enable=
|
||||
|
||||
|
||||
[METHOD_ARGS]
|
||||
|
||||
# List of qualified names (i.e., library.method) which require a timeout
|
||||
# parameter e.g. 'requests.api.get,requests.api.post'
|
||||
timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
|
||||
|
||||
|
||||
[MISCELLANEOUS]
|
||||
|
||||
# List of note tags to take in consideration, separated by a comma.
|
||||
notes=FIXME,
|
||||
XXX,
|
||||
TODO
|
||||
|
||||
# Regular expression of note tags to take in consideration.
|
||||
notes-rgx=
|
||||
|
||||
|
||||
[REFACTORING]
|
||||
|
||||
# Maximum number of nested blocks for function / method body
|
||||
max-nested-blocks=5
|
||||
|
||||
# Complete name of functions that never returns. When checking for
|
||||
# inconsistent-return-statements if a never returning function is called then
|
||||
# it will be considered as an explicit return statement and no message will be
|
||||
# printed.
|
||||
never-returning-functions=sys.exit,argparse.parse_error
|
||||
|
||||
|
||||
[REPORTS]
|
||||
|
||||
# Python expression which should return a score less than or equal to 10. You
|
||||
# have access to the variables 'fatal', 'error', 'warning', 'refactor',
|
||||
# 'convention', and 'info' which contain the number of messages in each
|
||||
# category, as well as 'statement' which is the total number of statements
|
||||
# analyzed. This score is used by the global evaluation report (RP0004).
|
||||
evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
|
||||
|
||||
# Template used to display messages. This is a python new-style format string
|
||||
# used to format the message information. See doc for all details.
|
||||
msg-template=
|
||||
|
||||
# Set the output format. Available formats are: text, parseable, colorized,
|
||||
# json2 (improved json format), json (old json format) and msvs (visual
|
||||
# studio). You can also give a reporter class, e.g.
|
||||
# mypackage.mymodule.MyReporterClass.
|
||||
#output-format=
|
||||
|
||||
# Tells whether to display a full report or only the messages.
|
||||
reports=no
|
||||
|
||||
# Activate the evaluation score.
|
||||
score=yes
|
||||
|
||||
|
||||
[SIMILARITIES]
|
||||
|
||||
# Comments are removed from the similarity computation
|
||||
ignore-comments=yes
|
||||
|
||||
# Docstrings are removed from the similarity computation
|
||||
ignore-docstrings=yes
|
||||
|
||||
# Imports are removed from the similarity computation
|
||||
ignore-imports=yes
|
||||
|
||||
# Signatures are removed from the similarity computation
|
||||
ignore-signatures=yes
|
||||
|
||||
# Minimum lines number of a similarity.
|
||||
min-similarity-lines=4
|
||||
|
||||
|
||||
[SPELLING]
|
||||
|
||||
# Limits count of emitted suggestions for spelling mistakes.
|
||||
max-spelling-suggestions=4
|
||||
|
||||
# Spelling dictionary name. No available dictionaries : You need to install
|
||||
# both the python package and the system dependency for enchant to work.
|
||||
spelling-dict=
|
||||
|
||||
# List of comma separated words that should be considered directives if they
|
||||
# appear at the beginning of a comment and should not be checked.
|
||||
spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
|
||||
|
||||
# List of comma separated words that should not be checked.
|
||||
spelling-ignore-words=
|
||||
|
||||
# A path to a file that contains the private dictionary; one word per line.
|
||||
spelling-private-dict-file=
|
||||
|
||||
# Tells whether to store unknown words to the private dictionary (see the
|
||||
# --spelling-private-dict-file option) instead of raising a message.
|
||||
spelling-store-unknown-words=no
|
||||
|
||||
|
||||
[STRING]
|
||||
|
||||
# This flag controls whether inconsistent-quotes generates a warning when the
|
||||
# character used as a quote delimiter is used inconsistently within a module.
|
||||
check-quote-consistency=no
|
||||
|
||||
# This flag controls whether the implicit-str-concat should generate a warning
|
||||
# on implicit string concatenation in sequences defined over several lines.
|
||||
check-str-concat-over-line-jumps=no
|
||||
|
||||
|
||||
[TYPECHECK]
|
||||
|
||||
# List of decorators that produce context managers, such as
|
||||
# contextlib.contextmanager. Add to this list to register other decorators that
|
||||
# produce valid context managers.
|
||||
contextmanager-decorators=contextlib.contextmanager
|
||||
|
||||
# List of members which are set dynamically and missed by pylint inference
|
||||
# system, and so shouldn't trigger E1101 when accessed. Python regular
|
||||
# expressions are accepted.
|
||||
generated-members=
|
||||
|
||||
# Tells whether to warn about missing members when the owner of the attribute
|
||||
# is inferred to be None.
|
||||
ignore-none=yes
|
||||
|
||||
# This flag controls whether pylint should warn about no-member and similar
|
||||
# checks whenever an opaque object is returned when inferring. The inference
|
||||
# can return multiple potential results while evaluating a Python object, but
|
||||
# some branches might not be evaluated, which results in partial inference. In
|
||||
# that case, it might be useful to still emit no-member and other checks for
|
||||
# the rest of the inferred objects.
|
||||
ignore-on-opaque-inference=yes
|
||||
|
||||
# List of symbolic message names to ignore for Mixin members.
|
||||
ignored-checks-for-mixins=no-member,
|
||||
not-async-context-manager,
|
||||
not-context-manager,
|
||||
attribute-defined-outside-init
|
||||
|
||||
# List of class names for which member attributes should not be checked (useful
|
||||
# for classes with dynamically set attributes). This supports the use of
|
||||
# qualified names.
|
||||
ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
|
||||
|
||||
# Show a hint with possible names when a member name was not found. The aspect
|
||||
# of finding the hint is based on edit distance.
|
||||
missing-member-hint=yes
|
||||
|
||||
# The minimum edit distance a name should have in order to be considered a
|
||||
# similar match for a missing member name.
|
||||
missing-member-hint-distance=1
|
||||
|
||||
# The total number of similar names that should be taken in consideration when
|
||||
# showing a hint for a missing member.
|
||||
missing-member-max-choices=1
|
||||
|
||||
# Regex pattern to define which classes are considered mixins.
|
||||
mixin-class-rgx=.*[Mm]ixin
|
||||
|
||||
# List of decorators that change the signature of a decorated function.
|
||||
signature-mutators=
|
||||
|
||||
|
||||
[VARIABLES]
|
||||
|
||||
# List of additional names supposed to be defined in builtins. Remember that
|
||||
# you should avoid defining new builtins when possible.
|
||||
additional-builtins=
|
||||
|
||||
# Tells whether unused global variables should be treated as a violation.
|
||||
allow-global-unused-variables=yes
|
||||
|
||||
# List of names allowed to shadow builtins
|
||||
allowed-redefined-builtins=
|
||||
|
||||
# List of strings which can identify a callback function by name. A callback
|
||||
# name must start or end with one of those strings.
|
||||
callbacks=cb_,
|
||||
_cb
|
||||
|
||||
# A regular expression matching the name of dummy variables (i.e. expected to
|
||||
# not be used).
|
||||
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
|
||||
|
||||
# Argument names that match this expression will be ignored.
|
||||
ignored-argument-names=_.*|^ignored_|^unused_
|
||||
|
||||
# Tells whether we should check for unused import in __init__ files.
|
||||
init-import=no
|
||||
|
||||
# List of qualified module names which can have objects that can redefine
|
||||
# builtins.
|
||||
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
"""
|
||||
lib_af_api
|
||||
---------------------------------------------
|
||||
A Python library for managing AF API objects
|
||||
"""
|
||||
|
||||
from lib_af_api.campaign import Campaign
|
||||
from lib_af_api.business import Business
|
||||
from lib_af_api.event import Event
|
||||
from lib_af_api.microsite import Microsite
|
||||
from lib_af_api.token import Token
|
||||
from lib_af_api.voterset import VoterSet
|
||||
from lib_af_api.voter import Voter
|
||||
from lib_af_api.user import User
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
"""
|
||||
Business Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Business():
|
||||
"""Business class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Business
|
||||
|
||||
:param base_url: Base URL for Business API
|
||||
:param jwt: JWT Authentication for Business API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the businesses
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/businesses',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Events
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and return null
|
||||
logging.error("[AFBUSINESS GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, business_key):
|
||||
"""
|
||||
get Get the business
|
||||
|
||||
:param business_key: The Business key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/businesses/{business_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Business
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFBUSINESS GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, business_key, patch_data):
|
||||
"""
|
||||
patch Path the Business
|
||||
|
||||
:param business_key: The Business key to update with API
|
||||
:param patch_data: The data to update the Business
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = business_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/businesses/{business_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Business
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFBUSINESS UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
"""
|
||||
Campaign Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Campaign():
|
||||
"""Campaign class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Campaign
|
||||
|
||||
:param base_url: Base URL for Campaign API
|
||||
:param jwt: JWT Authentication for Campaign API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the campaigns
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/campaigns',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Events
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and return null
|
||||
logging.error("[AFCAMPAIGN GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, campaign_key):
|
||||
"""
|
||||
get Get the campaign
|
||||
|
||||
:param campaign_key: The Campaign key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/campaigns/{campaign_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Campaign
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFCAMPAIGN GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, campaign_key, patch_data):
|
||||
"""
|
||||
patch Path the Campaign
|
||||
|
||||
:param campaign_key: The Campaign key to update with API
|
||||
:param patch_data: The data to update the Campaign
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = campaign_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/campaigns/{campaign_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Campaign
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFCAMPAIGN UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
|
@ -0,0 +1,206 @@
|
|||
"""
|
||||
Event Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Event():
|
||||
"""Event class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Event
|
||||
|
||||
:param base_url: Base URL for Event API
|
||||
:param jwt: JWT Authentication for Event API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the events
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/events',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Events
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFEVENT GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, event_key):
|
||||
"""
|
||||
get Get the event
|
||||
|
||||
:param event_key: The Event key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/events/{event_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Event
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFEVENT GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, event_key, patch_data):
|
||||
"""
|
||||
patch Path the Event
|
||||
|
||||
:param event_key: The Event key to update with API
|
||||
:param patch_data: The data to update the Event
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = event_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/events/{event_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Event
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFEVENT UPDATE] [%s]", response.text)
|
||||
try:
|
||||
return response.json()
|
||||
except: # pylint: disable=bare-except
|
||||
return None
|
||||
|
||||
|
||||
def patch_v2(self, event_key, patch_data, retry=-1):
|
||||
"""
|
||||
patch_v2 Path the Event V2. This will retry a 409 as many times as set by 'retry' parameter
|
||||
|
||||
:param event_key: The Event key to update with API
|
||||
:param patch_data: The data to update the Event
|
||||
:param retry: If set to a positive number an attempt to replay the path will happen
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = event_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/events/{event_key}',
|
||||
headers=headers,
|
||||
timeout=30,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Event
|
||||
if response.ok:
|
||||
return response.json(), response.status_code
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFEVENT UPDATE] [%s]", response.text)
|
||||
|
||||
# Check if this call should be tried again
|
||||
if str(response.status_code) == "409" and retry > 0:
|
||||
return self.patch_v2(event_key, patch_data, retry=retry-1)
|
||||
|
||||
try:
|
||||
return response.json(), response.status_code
|
||||
except: # pylint: disable=bare-except
|
||||
return None, response.status_code
|
||||
|
||||
|
||||
def patch_v3(self, event_key, patch_data):
|
||||
"""
|
||||
patch_v3 Path the Event V3.
|
||||
|
||||
:param event_key: The Event key to update with API
|
||||
:param patch_data: The data to update the Event
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = event_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/events/{event_key}',
|
||||
headers=headers,
|
||||
timeout=30,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Event
|
||||
if response.ok:
|
||||
return response.json(), response.status_code
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFEVENT UPDATE] [%s]", response.text)
|
||||
|
||||
try:
|
||||
return response.json(), response.status_code
|
||||
except: # pylint: disable=bare-except
|
||||
return None, response.status_code
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
"""
|
||||
Helpers for Alliance Forge API objects
|
||||
"""
|
||||
|
||||
from datetime import datetime
|
||||
import pytz
|
||||
|
||||
def get_event_segments(event : dict, event_campaign : dict) -> dict:
|
||||
"""
|
||||
get_event_segments Calculate the segments for the event.
|
||||
|
||||
:param event: The Event object
|
||||
:param event_campaign: The Campaign object for the event
|
||||
|
||||
:return The segments for the event as dict
|
||||
"""
|
||||
|
||||
# Default segments
|
||||
event_segments = {
|
||||
"sms_segments": 0,
|
||||
"mms_segments": 0,
|
||||
"crystal_segments": 0
|
||||
}
|
||||
|
||||
# Get the values to calculate with
|
||||
content = event["content"]
|
||||
if content is None:
|
||||
content = ""
|
||||
|
||||
message_length = len(content)
|
||||
segment_counter = 1
|
||||
|
||||
# Get the allowed size of the first segment. Static 160 except for MMS
|
||||
first_segment_size = 160
|
||||
|
||||
# Update to MMS segment size
|
||||
if event["media_name"] is not None:
|
||||
# Based on contract negotiations
|
||||
first_segment_size = event_campaign["mms_included_characters"]
|
||||
event_segments["mms_segments"] = 1
|
||||
|
||||
# Check if Crystal
|
||||
if event["media_name"].endswith("mp4"):
|
||||
event_segments["crystal_segments"] = 1
|
||||
|
||||
# Count the segments
|
||||
message_length -= first_segment_size
|
||||
while message_length > 0:
|
||||
segment_counter += 1
|
||||
message_length -= first_segment_size
|
||||
|
||||
event_segments["sms_segments"] = segment_counter
|
||||
|
||||
return event_segments
|
||||
|
||||
|
||||
def get_datetime_convert(af_datetime_str : str, af_time_zone : str) -> datetime:
|
||||
"""
|
||||
get_datetime_convert Get the datetime string to a datetime object converted to timezone.
|
||||
|
||||
:param af_datetime_str: The datetime string. Format "%Y-%m-%dT%H:%M"
|
||||
:param af_time_zone: The alliance forge timezone
|
||||
"""
|
||||
|
||||
# AF time zone mapping
|
||||
time_zone_convert = {"hawaii": "US/Hawaii",
|
||||
"alaska": "US/Alaska",
|
||||
"pacific": "US/Pacific",
|
||||
"mountain": "US/Mountain",
|
||||
"arizona": "US/Arizona",
|
||||
"central": "US/Central",
|
||||
"eastern": "US/Eastern",
|
||||
"aleutian": "US/Aleutian",
|
||||
"east_indiana": "US/East-Indiana",
|
||||
"indiana_starke": "US/Indiana-Starke",
|
||||
"michigan": "US/Michigan",
|
||||
"samoa": "US/Samoa"}
|
||||
|
||||
# Get the datetime to an object and properly set the timezone
|
||||
gmt_datetime = datetime.strptime(af_datetime_str, "%Y-%m-%dT%H:%M")
|
||||
gmt_timezone = pytz.timezone('GMT')
|
||||
gmt_datetime = gmt_timezone.localize(gmt_datetime)
|
||||
|
||||
# Convert to the target timezone
|
||||
target_timezone = pytz.timezone(time_zone_convert.get(af_time_zone, "US/Pacific"))
|
||||
target_datetime = gmt_datetime.astimezone(target_timezone)
|
||||
|
||||
return target_datetime
|
||||
|
|
@ -0,0 +1,123 @@
|
|||
"""
|
||||
Microsite Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Microsite():
|
||||
"""Microsite class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Microsite
|
||||
|
||||
:param base_url: Base URL for Microsite API
|
||||
:param jwt: JWT Authentication for Microsite API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the microsites
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/microsites',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Microsites
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFMICROSITE GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, microsite_key):
|
||||
"""
|
||||
get Get the microsite
|
||||
|
||||
:param microsite_key: The Microsite key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/microsites/{microsite_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Microsite
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFMICROSITE GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, microsite_key, patch_data):
|
||||
"""
|
||||
patch Path the Microsite
|
||||
|
||||
:param microsite_key: The Microsite key to update with API
|
||||
:param patch_data: The data to update the Microsite
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = microsite_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/microsites/{microsite_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Microsite
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFMICROSITE UPDATE] [%s]", response.text)
|
||||
try:
|
||||
return response.json()
|
||||
except: # pylint: disable=bare-except
|
||||
return None
|
||||
|
|
@ -0,0 +1,175 @@
|
|||
"""
|
||||
Token Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Token():
|
||||
"""Token class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Token
|
||||
|
||||
:param base_url: Base URL for Token API
|
||||
:param jwt: JWT Authentication for Token API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get(self, campaign_key):
|
||||
"""
|
||||
get Get the campaign
|
||||
|
||||
:param campaign_key: The Campaign key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/campaigns/{campaign_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Campaign
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFCAMPAIGN GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, campaign_key, patch_data):
|
||||
"""
|
||||
patch Path the Campaign
|
||||
|
||||
:param campaign_key: The Campaign key to update with API
|
||||
:param patch_data: The data to update the Campaign
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = campaign_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/campaigns/{campaign_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Campaign
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFCAMPAIGN UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def password_reset_trigger(self, username=None, email=None):
|
||||
"""
|
||||
password_reset_trigger Send a password reset email to the username account provided
|
||||
|
||||
:param username: The username of the account to be affected
|
||||
:param email: The email of the account to be affected
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
#'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
print(f"token::password_reset_trigger(): username = {username} email = {email}")
|
||||
|
||||
# Set the patch data
|
||||
patch_data = {}
|
||||
if username not in (None, ""):
|
||||
patch_data['user_name'] = username
|
||||
patch_data['email'] = None
|
||||
elif email not in (None, ""):
|
||||
patch_data['user_name'] = None
|
||||
patch_data['email'] = email
|
||||
|
||||
if patch_data['user_name'] in (None, '') and patch_data['email'] in (None, ''):
|
||||
print(f"token::password_reset_trigger(): Error: 'user_name' and 'email' values are both empty. patch_data = {patch_data}")
|
||||
return None
|
||||
|
||||
print(f'{self.base_url}/api/v1/token/generate')
|
||||
print(f'patch_data = {patch_data}')
|
||||
|
||||
# Run the PATCH
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/token/generate',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
logging.error("[PASSWORD RESET TRIGGER] [%s]", response.text)
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def password_reset(self, token_value=None, password=None, verify=None):
|
||||
"""
|
||||
password_reset Reset password with token value
|
||||
|
||||
:param username: The username of the account to be affected
|
||||
"""
|
||||
|
||||
if token_value in (None, ""):
|
||||
return None
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
#'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data = {
|
||||
'user_token': token_value,
|
||||
'password': password,
|
||||
'password_verification': verify
|
||||
}
|
||||
|
||||
# Run the PATCH
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/token/password/{token_value}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
logging.error("[PASSWORD RESET] [%s]", response.text)
|
||||
|
||||
return None
|
||||
|
|
@ -0,0 +1,155 @@
|
|||
"""
|
||||
User Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class User():
|
||||
"""User class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init User
|
||||
|
||||
:param base_url: Base URL for User API
|
||||
:param jwt: JWT Authentication for User API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the users
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/users',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Events
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and return null
|
||||
logging.error("[AFUSER GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, user_key):
|
||||
"""
|
||||
get Get the user
|
||||
|
||||
:param user_key: The User key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/users/{user_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return User
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and return null
|
||||
logging.error("[AFUSER GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, user_key, patch_data):
|
||||
"""
|
||||
patch Patch the User
|
||||
|
||||
:param user_key: The User key to update with API
|
||||
:param patch_data: The data to update the User
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = user_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/users/{user_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return User
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and return null
|
||||
logging.error("[AFUSER UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def change_role(self, user_key, role_type, role_key, action):
|
||||
"""
|
||||
patch Patch the User Roles
|
||||
|
||||
:param user_key: The User key to update with API
|
||||
:param key_type: The type of key provided (either campaign, business, or company)
|
||||
:param role_key: The Campaign / Business key to add to roles
|
||||
:param action: The action to take (either add or remove)
|
||||
"""
|
||||
|
||||
# verify parameters are not null
|
||||
if user_key is None or role_key is None:
|
||||
return None
|
||||
if role_type not in ('campaign', 'business', 'company'):
|
||||
return None
|
||||
if action not in ('add', 'remove'):
|
||||
return None
|
||||
|
||||
new_role = f"{role_type}_key:{role_key}"
|
||||
|
||||
# get the user record
|
||||
user = self.get(user_key)
|
||||
|
||||
# check if role exists
|
||||
if new_role in user['roles']:
|
||||
if action == "remove":
|
||||
user['roles'].remove(new_role)
|
||||
else:
|
||||
if action == "add":
|
||||
user['roles'].append(new_role)
|
||||
|
||||
# patch the user record and return the results
|
||||
return self.patch(user_key, {'roles': user['roles']})
|
||||
|
|
@ -0,0 +1,181 @@
|
|||
"""
|
||||
Voter Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class Voter():
|
||||
"""Voter class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init Voter
|
||||
|
||||
:param base_url: Base URL for Voter API
|
||||
:param jwt: JWT Authentication for Voter API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get_all(self, args = None):
|
||||
"""
|
||||
get_all Get the voter
|
||||
|
||||
:param args: Dict of args to add as URL params
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
if not isinstance(args, dict):
|
||||
args = {}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/voters',
|
||||
params=args,
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Voter
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER GET ALL] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def get(self, voter_key):
|
||||
"""
|
||||
get Get the voter
|
||||
|
||||
:param voter_key: The Voter key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/voters/{voter_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Voter
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, voter_key, patch_data):
|
||||
"""
|
||||
patch Path the Voter
|
||||
|
||||
:param voter_key: The Voter key to update with API
|
||||
:param patch_data: The data to update the Voter
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = voter_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/voters/{voter_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return Voter
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def post(self, post_data):
|
||||
"""
|
||||
post Post the Voter
|
||||
|
||||
:param post_data: The data to create the Voter
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.post(
|
||||
f'{self.base_url}/api/v1/voters',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=post_data
|
||||
)
|
||||
|
||||
# Good response. Return Voter
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER CREATE] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def delete(self, voter_key):
|
||||
"""
|
||||
delete Delete the Voter
|
||||
|
||||
:param voter_key: The Voter key to delete with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.delete(
|
||||
f'{self.base_url}/api/v1/voters/{voter_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return Voter
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER DELETE] [%s]", response.text)
|
||||
return None
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
"""
|
||||
VoterSet Class object
|
||||
"""
|
||||
|
||||
import logging
|
||||
import requests
|
||||
|
||||
|
||||
class VoterSet():
|
||||
"""VoterSet class"""
|
||||
|
||||
def __init__(self, base_url, jwt):
|
||||
"""
|
||||
__init__ Init VoterSet
|
||||
|
||||
:param base_url: Base URL for Voter API
|
||||
:param jwt: JWT Authentication for Voter API
|
||||
"""
|
||||
|
||||
self.base_url = base_url
|
||||
self.jwt = jwt
|
||||
|
||||
|
||||
def get(self, voterset_key):
|
||||
"""
|
||||
get Get the voterset
|
||||
|
||||
:param voterset_key: The Voterset key to get with API
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Run the GET
|
||||
response = requests.get(
|
||||
f'{self.base_url}/api/v1/votersets/{voterset_key}',
|
||||
headers=headers,
|
||||
timeout=300
|
||||
)
|
||||
|
||||
# Good response. Return VoterSet
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER GET] [%s]", response.text)
|
||||
return None
|
||||
|
||||
|
||||
def patch(self, voterset_key, patch_data):
|
||||
"""
|
||||
patch Path the Voterset
|
||||
|
||||
:param voterset_key: The Voterset key to update with API
|
||||
:param patch_data: The data to update the Voterset
|
||||
"""
|
||||
|
||||
# Set the headers for the request
|
||||
headers = {
|
||||
'Content-Type': 'application/json',
|
||||
'Accept': 'application/json',
|
||||
'Authorization': f'Bearer {self.jwt}'
|
||||
}
|
||||
|
||||
# Set the key to the patch data
|
||||
patch_data['key'] = voterset_key
|
||||
|
||||
# Run the GET
|
||||
response = requests.patch(
|
||||
f'{self.base_url}/api/v1/votersets/{voterset_key}',
|
||||
headers=headers,
|
||||
timeout=300,
|
||||
json=patch_data
|
||||
)
|
||||
|
||||
# Good response. Return VoterSet
|
||||
if response.ok:
|
||||
return response.json()
|
||||
|
||||
# Log error and retunr null
|
||||
logging.error("[AFVOTER UPDATE] [%s]", response.text)
|
||||
return None
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
"""
|
||||
Project build definition file.
|
||||
"""
|
||||
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
with open('README.md', 'r') as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name='lib_af_api',
|
||||
version='1.0.5',
|
||||
author='',
|
||||
author_email='',
|
||||
description='',
|
||||
long_description=long_description,
|
||||
long_description_content_type='text/markdown',
|
||||
zip_safe=False,
|
||||
include_package_data=False,
|
||||
packages=find_packages(),
|
||||
python_requires='>=3.7',
|
||||
install_requires=[
|
||||
'pytz>=2024.1',
|
||||
'requests>=2.32.3'
|
||||
],
|
||||
)
|
||||
Loading…
Reference in New Issue