CatPtain commited on
Commit
12c00ae
·
verified ·
1 Parent(s): c2dec59

Upload 14 files

Browse files
Files changed (14) hide show
  1. .codespell.ignore +47 -0
  2. .codespell.skip +21 -0
  3. .coveragerc +7 -0
  4. .gitattributes +3 -51
  5. .gitignore +63 -0
  6. .markdownlintrc +12 -0
  7. .pre-commit-config.yaml +81 -0
  8. .pydocstyle.ini +4 -0
  9. .pylintrc +399 -0
  10. .secrets.baseline +148 -0
  11. CODE_OF_CONDUCT.md +88 -0
  12. LICENSE +665 -0
  13. pytest.ini +8 -0
  14. ruff.toml +56 -0
.codespell.ignore ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ake
2
+ alle
3
+ ba
4
+ brin
5
+ buda
6
+ buidl
7
+ buil
8
+ certi
9
+ commun
10
+ coo
11
+ creat
12
+ datas
13
+ ether
14
+ fo
15
+ gard
16
+ hel
17
+ hist
18
+ hsi
19
+ ist
20
+ jewl
21
+ ket
22
+ mape
23
+ mis
24
+ navagation
25
+ nd
26
+ nwe
27
+ operatio
28
+ ot
29
+ parana
30
+ pres
31
+ ro
32
+ ser
33
+ shold
34
+ shs
35
+ statics
36
+ te
37
+ tha
38
+ toke
39
+ vai
40
+ varian
41
+ vie
42
+ welp
43
+ wew
44
+ yeld
45
+ zar
46
+ zlot
47
+ bootup
.codespell.skip ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ./tests
2
+ .git
3
+ *.bat
4
+ *.css
5
+ *.csv
6
+ *.html
7
+ *.ini
8
+ *.ipynb
9
+ *.js
10
+ *.json
11
+ *.lock
12
+ *.nsi
13
+ *.scss
14
+ *.txt
15
+ *.yaml
16
+ ./build/pyinstaller
17
+ ./website/config.toml
18
+ ./**/node_modules
19
+ ./frontend-components/**
20
+ ./website/content/terminal/reference/crypto/onchain/**
21
+ ./openbb_platform/providers/econdb/openbb_econdb/utils/helpers.py
.coveragerc ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ [coverage:run]
2
+ omit =
3
+ env/*
4
+ tests/*
5
+ **/tests/**
6
+ **/package/**
7
+ source = .
.gitattributes CHANGED
@@ -1,51 +1,3 @@
1
- *.7z filter=lfs diff=lfs merge=lfs -text
2
- *.arrow filter=lfs diff=lfs merge=lfs -text
3
- *.bin filter=lfs diff=lfs merge=lfs -text
4
- *.bz2 filter=lfs diff=lfs merge=lfs -text
5
- *.ckpt filter=lfs diff=lfs merge=lfs -text
6
- *.ftz filter=lfs diff=lfs merge=lfs -text
7
- *.gz filter=lfs diff=lfs merge=lfs -text
8
- *.h5 filter=lfs diff=lfs merge=lfs -text
9
- *.joblib filter=lfs diff=lfs merge=lfs -text
10
- *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
- *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
- *.model filter=lfs diff=lfs merge=lfs -text
13
- *.msgpack filter=lfs diff=lfs merge=lfs -text
14
- *.npy filter=lfs diff=lfs merge=lfs -text
15
- *.npz filter=lfs diff=lfs merge=lfs -text
16
- *.onnx filter=lfs diff=lfs merge=lfs -text
17
- *.ot filter=lfs diff=lfs merge=lfs -text
18
- *.parquet filter=lfs diff=lfs merge=lfs -text
19
- *.pb filter=lfs diff=lfs merge=lfs -text
20
- *.pickle filter=lfs diff=lfs merge=lfs -text
21
- *.pkl filter=lfs diff=lfs merge=lfs -text
22
- *.pt filter=lfs diff=lfs merge=lfs -text
23
- *.pth filter=lfs diff=lfs merge=lfs -text
24
- *.rar filter=lfs diff=lfs merge=lfs -text
25
- *.safetensors filter=lfs diff=lfs merge=lfs -text
26
- saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
- *.tar.* filter=lfs diff=lfs merge=lfs -text
28
- *.tar filter=lfs diff=lfs merge=lfs -text
29
- *.tflite filter=lfs diff=lfs merge=lfs -text
30
- *.tgz filter=lfs diff=lfs merge=lfs -text
31
- *.wasm filter=lfs diff=lfs merge=lfs -text
32
- *.xz filter=lfs diff=lfs merge=lfs -text
33
- *.zip filter=lfs diff=lfs merge=lfs -text
34
- *.zst filter=lfs diff=lfs merge=lfs -text
35
- *tfevents* filter=lfs diff=lfs merge=lfs -text
36
- build/conda/installer/assets/dmg_volume.icns filter=lfs diff=lfs merge=lfs -text
37
- build/conda/installer/assets/Installer_vertical2.bmp filter=lfs diff=lfs merge=lfs -text
38
- cli/openbb_cli/assets/styles/default/Consolas.ttf filter=lfs diff=lfs merge=lfs -text
39
- frontend-components/fonts/FiraCode-Regular.ttf filter=lfs diff=lfs merge=lfs -text
40
- frontend-components/fonts/FiraCode-VF.ttf filter=lfs diff=lfs merge=lfs -text
41
- images/background.png filter=lfs diff=lfs merge=lfs -text
42
- images/dmg_volume.icns filter=lfs diff=lfs merge=lfs -text
43
- images/legacy/GamestonkLogo.png filter=lfs diff=lfs merge=lfs -text
44
- images/legacy/GamestonkTerminal.icns filter=lfs diff=lfs merge=lfs -text
45
- images/legacy/gst_logo_green_white_background.png filter=lfs diff=lfs merge=lfs -text
46
- images/legacy/gst_logo_rGreen.png filter=lfs diff=lfs merge=lfs -text
47
- images/legacy/gst_logo.png filter=lfs diff=lfs merge=lfs -text
48
- images/legacy/splashscreen.png filter=lfs diff=lfs merge=lfs -text
49
- images/openbb_gradient.png filter=lfs diff=lfs merge=lfs -text
50
- images/openbb_splashscreen.png filter=lfs diff=lfs merge=lfs -text
51
- images/openbb_terminal_illustration.gif filter=lfs diff=lfs merge=lfs -text
 
1
+ * linguist-vendored
2
+ *.py linguist-vendored=false
3
+ text eol=lf
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
.gitignore ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # General
2
+ __pycache__/
3
+ *.pyc
4
+ .DS_Store
5
+ *.env
6
+ .venv
7
+ venv*/
8
+ venv
9
+ .vscode
10
+ *.ipynb
11
+ env/
12
+ venv/
13
+ !notebooks/jupyter/.gitkeep
14
+ .python-version
15
+ .mypy_cache
16
+ .ruff_cache
17
+ .pytest_cache
18
+ iframe_figures/
19
+ exports/*
20
+ .idea
21
+ .coverage
22
+ .scannerwork
23
+ htmlcov
24
+ **/.ipynb_checkpoints
25
+ *.swp
26
+ *.http
27
+ .coverage.*
28
+ *_tests.csv
29
+ *_sdk_audit.csv
30
+ !build/docker/compose.env
31
+ .dccache
32
+ *rome.json
33
+ **/node_modules/*
34
+ .cursorignore
35
+ darts_logs/
36
+ custom_imports/*.csv
37
+ custom_imports/*/*.csv
38
+ cache/
39
+ lightning_logs/
40
+ */mocked_path
41
+ *.pem
42
+
43
+ # CLI
44
+ *.pyo
45
+ **/dist/*
46
+ build/cli
47
+ build/nsis/app
48
+ DMG/*
49
+ *.dmg
50
+ *.sh
51
+ cli/openbb_cli/assets/styles/user/hub.richstyle.json
52
+
53
+ # Platform
54
+ openbb_platform/openbb/package/*
55
+
56
+ # Dev Container env
57
+ obb/*
58
+
59
+ # OpenBB Distribution
60
+ !build/conda/installer/*.sh
61
+ *.pkg
62
+ *.exe
63
+ build/conda/tmp
.markdownlintrc ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "default": true,
3
+ "MD025": false,
4
+ "MD013": {
5
+ "line_length": 380,
6
+ "tables": false,
7
+ "code_blocks": false
8
+ },
9
+ "MD033": false,
10
+ "MD036": false,
11
+ "MD041": false
12
+ }
.pre-commit-config.yaml ADDED
@@ -0,0 +1,81 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: v5.0.0
4
+ hooks:
5
+ - id: check-yaml
6
+ exclude: 'construct.yaml'
7
+ - id: end-of-file-fixer
8
+ exclude_types: [css, markdown, text, svg]
9
+ - id: trailing-whitespace
10
+ exclude_types: [html, markdown, text]
11
+ - id: check-merge-conflict
12
+ - id: detect-private-key
13
+ - repo: https://github.com/psf/black
14
+ rev: 25.1.0
15
+ hooks:
16
+ - id: black
17
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
18
+ rev: "v0.11.2"
19
+ hooks:
20
+ - id: ruff
21
+ - repo: https://github.com/pycqa/pydocstyle
22
+ rev: 6.3.0
23
+ hooks:
24
+ - id: pydocstyle
25
+ additional_dependencies: [tomli]
26
+ name: pydocstyle
27
+ entry: pydocstyle
28
+ language: python
29
+ types: [python]
30
+ files: '^(openbb_platform/|cli/).*\.py$'
31
+ exclude: 'tests/.*\.py|openbb_platform/test_.*\.py'
32
+ args: ["--config=ruff.toml"]
33
+ - repo: https://github.com/codespell-project/codespell
34
+ rev: v2.4.1
35
+ hooks:
36
+ - id: codespell
37
+ entry: codespell
38
+ args:
39
+ [
40
+ "--ignore-words=.codespell.ignore",
41
+ "--quiet-level=2",
42
+ "--skip=./**/tests/**,./**/test_*.py,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,build/pyinstaller/*,./website/config.toml",
43
+ "-x=.github/workflows/general-linting.yml"
44
+ ]
45
+ - repo: https://github.com/pre-commit/mirrors-mypy
46
+ rev: "v1.15.0"
47
+ hooks:
48
+ - id: mypy
49
+ name: mypy
50
+ description: ""
51
+ entry: mypy
52
+ language: python
53
+ "types_or": [python, pyi]
54
+ args: ["--ignore-missing-imports", "--scripts-are-modules", "--check-untyped-defs"]
55
+ additional_dependencies: ["types-requests", "types-setuptools", "types-python-dateutil", "types-pytz"]
56
+ require_serial: true
57
+ exclude: 'test_.*\.py'
58
+ - repo: https://github.com/kynan/nbstripout
59
+ rev: 0.8.1
60
+ hooks:
61
+ - id: nbstripout
62
+ name: Strip notebooks output
63
+ - repo: local
64
+ hooks:
65
+ - id: pylint
66
+ name: pylint
67
+ entry: pylint
68
+ language: system
69
+ types: [python]
70
+ - repo: https://github.com/Yelp/detect-secrets
71
+ rev: v1.5.0
72
+ hooks:
73
+ - id: detect-secrets
74
+ args:
75
+ [
76
+ "--baseline",
77
+ ".secrets.baseline",
78
+ "--exclude-files",
79
+ "cassettes/.*|record/.*|website/content/api/.*|openbb_platform/extensions/charting/openbb_charting/infrastructure/assets/.*\\.js|openbb_platform/extensions/charting/openbb_charting/infrastructure/.*\\.html",
80
+ ]
81
+ exclude: package.lock.json
.pydocstyle.ini ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ [pydocstyle]
2
+ inherit = True
3
+ ignore = D202,D203,D205,D210,D212,D213,D214,D215,D400,D404,D405,D406,D407,D408,D409,D410,D411,D413,D415,D416,D417
4
+ match = .*\.py
.pylintrc ADDED
@@ -0,0 +1,399 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [MASTER]
2
+
3
+ # A comma-separated list of package or module names from where C extensions may
4
+ # be loaded. Extensions are loading into the active Python interpreter and may
5
+ # run arbitrary code
6
+ extension-pkg-allow-list=math,binascii
7
+
8
+ # Add files or directories to the blacklist. They should be base names, not
9
+ # paths.
10
+ ignore=CVS
11
+
12
+ # Add files or directories matching the regex patterns to the blacklist. The
13
+ # regex matches against base names, not paths.
14
+ ignore-patterns=
15
+
16
+ # Python code to execute, usually for sys.path manipulation such as
17
+ # pygtk.require().
18
+ #init-hook=
19
+
20
+ # Use multiple processes to speed up Pylint.
21
+ # jobs=1
22
+ jobs=2
23
+
24
+ # List of plugins (as comma separated values of python modules names) to load,
25
+ # usually to register additional checkers.
26
+ load-plugins=
27
+
28
+ # Pickle collected data for later comparisons.
29
+ persistent=yes
30
+
31
+ # Specify a configuration file.
32
+ #rcfile=
33
+
34
+ # Allow loading of arbitrary C extensions. Extensions are imported into the
35
+ # active Python interpreter and may run arbitrary code.
36
+ unsafe-load-any-extension=no
37
+
38
+
39
+ [MESSAGES CONTROL]
40
+
41
+ # Only show warnings with the listed confidence levels. Leave empty to show
42
+ # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
43
+ confidence=
44
+
45
+ # Disable the message, report, category or checker with the given id(s). You
46
+ # can either give multiple identifiers separated by comma (,) or put this
47
+ # option multiple times (only on the command line, not in the configuration
48
+ # file where it should appear only once).You can also use "--disable=all" to
49
+ # disable everything first and then reenable specific checks. For example, if
50
+ # you want to run only the similarities checker, you can use "--disable=all
51
+ # --enable=similarities". If you want to run only the classes checker, but have
52
+ # no Warning level messages displayed, use"--disable=all --enable=classes
53
+ # --disable=W"
54
+ # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
55
+ # disable=too-many-instance-attributes,len-as-condition,too-few-public-methods,anomalous-backslash-in-string,no-else-return,simplifiable-if-statement,too-many-arguments,duplicate-code,no-name-in-module,no-member,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,missing-docstring,invalid-name,bad-whitespace,consider-using-enumerate,unexpected-keyword-arg
56
+
57
+ disable=useless-return,missing-docstring,invalid-name,import-error,broad-except,unnecessary-lambda,missing-timeout,duplicate-code,consider-using-generator,unbalanced-tuple-unpacking,use-list-literal,no-name-in-module,use-sequence-for-iteration,use-dict-literal,unspecified-encoding,unsubscriptable-object,broad-exception-raised,possibly-used-before-assignment
58
+
59
+ # Enable the message, report, category or checker with the given id(s). You can
60
+ # either give multiple identifier separated by comma (,) or put this option
61
+ # multiple time (only on the command line, not in the configuration file where
62
+ # it should appear only once). See also the "--disable" option for examples.
63
+ enable=
64
+
65
+
66
+ [REPORTS]
67
+
68
+ # Python expression which should return a note less than 10 (10 is the highest
69
+ # note). You have access to the variables errors warning, statement which
70
+ # respectively contain the number of errors / warnings messages and the total
71
+ # number of statements analyzed. This is used by the global evaluation report
72
+ # (RP0004).
73
+ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
74
+
75
+ # Template used to display messages. This is a python new-style format string
76
+ # used to format the message information. See doc for all details
77
+ msg-template='{path} {line}: {msg_id} {msg} ({symbol})'
78
+
79
+ # Set the output format. Available formats are text, parseable, colorized, json
80
+ # and msvs (visual studio).You can also give a reporter class, eg
81
+ # mypackage.mymodule.MyReporterClass.
82
+ output-format=text
83
+
84
+ # Tells whether to display a full report or only the messages
85
+ reports=no
86
+
87
+ # Activate the evaluation score.
88
+ score=yes
89
+
90
+
91
+ [REFACTORING]
92
+
93
+ # Maximum number of nested blocks for function / method body
94
+ max-nested-blocks=9
95
+
96
+
97
+ [LOGGING]
98
+
99
+ # Logging modules to check that the string format arguments are in logging
100
+ # function parameter format
101
+ logging-modules=logging
102
+
103
+
104
+ [SPELLING]
105
+
106
+ # Spelling dictionary name. Available dictionaries: none. To make it working
107
+ # install python-enchant package.
108
+ spelling-dict=
109
+
110
+ # List of comma separated words that should not be checked.
111
+ spelling-ignore-words=
112
+
113
+ # A path to a file that contains private dictionary; one word per line.
114
+ spelling-private-dict-file=
115
+
116
+ # Tells whether to store unknown words to indicated private dictionary in
117
+ # --spelling-private-dict-file option instead of raising a message.
118
+ spelling-store-unknown-words=no
119
+
120
+
121
+ [MISCELLANEOUS]
122
+
123
+ # List of note tags to take in consideration, separated by a comma.
124
+ # notes=FIXME,XXX,TODO
125
+ notes=FIXME,XXX
126
+
127
+
128
+ [TYPECHECK]
129
+
130
+ # List of decorators that produce context managers, such as
131
+ # contextlib.contextmanager. Add to this list to register other decorators that
132
+ # produce valid context managers.
133
+ contextmanager-decorators=contextlib.contextmanager
134
+
135
+ # List of members which are set dynamically and missed by pylint inference
136
+ # system, and so shouldn't trigger E1101 when accessed. Python regular
137
+ # expressions are accepted.
138
+ generated-members=
139
+
140
+ # Tells whether missing members accessed in mixin class should be ignored. A
141
+ # mixin class is detected if its name ends with "mixin" (case insensitive).
142
+ ignore-mixin-members=yes
143
+
144
+ # This flag controls whether pylint should warn about no-member and similar
145
+ # checks whenever an opaque object is returned when inferring. The inference
146
+ # can return multiple potential results while evaluating a Python object, but
147
+ # some branches might not be evaluated, which results in partial inference. In
148
+ # that case, it might be useful to still emit no-member and other checks for
149
+ # the rest of the inferred objects.
150
+ ignore-on-opaque-inference=yes
151
+
152
+ # List of class names for which member attributes should not be checked (useful
153
+ # for classes with dynamically set attributes). This supports the use of
154
+ # qualified names.
155
+ ignored-classes=optparse.Values,thread._local,_thread._local
156
+
157
+ # List of module names for which member attributes should not be checked
158
+ # (useful for modules/projects where namespaces are manipulated during runtime
159
+ # and thus existing member attributes cannot be deduced by static analysis. It
160
+ # supports qualified module names, as well as Unix pattern matching.
161
+ ignored-modules=
162
+
163
+ # Show a hint with possible names when a member name was not found. The aspect
164
+ # of finding the hint is based on edit distance.
165
+ missing-member-hint=yes
166
+
167
+ # The minimum edit distance a name should have in order to be considered a
168
+ # similar match for a missing member name.
169
+ missing-member-hint-distance=1
170
+
171
+ # The total number of similar names that should be taken in consideration when
172
+ # showing a hint for a missing member.
173
+ missing-member-max-choices=1
174
+
175
+
176
+ [VARIABLES]
177
+
178
+ # List of additional names supposed to be defined in builtins. Remember that
179
+ # you should avoid to define new builtins when possible.
180
+ additional-builtins=
181
+
182
+ # Tells whether unused global variables should be treated as a violation.
183
+ allow-global-unused-variables=yes
184
+
185
+ # List of strings which can identify a callback function by name. A callback
186
+ # name must start or end with one of those strings.
187
+ callbacks=cb_,_cb
188
+
189
+ # A regular expression matching the name of dummy variables (i.e. expectedly
190
+ # not used).
191
+ dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
192
+
193
+ # Argument names that match this expression will be ignored. Default to name
194
+ # with leading underscore
195
+ ignored-argument-names=_.*|^ignored_|^unused_
196
+
197
+ # Tells whether we should check for unused import in __init__ files.
198
+ init-import=no
199
+
200
+ # List of qualified module names which can have objects that can redefine
201
+ # builtins.
202
+ redefining-builtins-modules=six.moves,future.builtins
203
+
204
+
205
+ [FORMAT]
206
+
207
+ # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
208
+ # expected-line-ending-format=
209
+ expected-line-ending-format=LF
210
+
211
+ # Regexp for a line that is allowed to be longer than the limit.
212
+ ignore-long-lines=^\s*(# )?<?https?://\S+>?$
213
+
214
+ # Number of spaces of indent required inside a hanging or continued line.
215
+ indent-after-paren=4
216
+
217
+ # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
218
+ # tab).
219
+ indent-string=' '
220
+
221
+ # Maximum number of characters on a single line.
222
+ max-line-length=140
223
+
224
+ # Maximum number of lines in a module
225
+ max-module-lines=1000
226
+
227
+ # Allow the body of a class to be on the same line as the declaration if body
228
+ # contains single statement.
229
+ single-line-class-stmt=no
230
+
231
+ # Allow the body of an if to be on the same line as the test if there is no
232
+ # else.
233
+ single-line-if-stmt=no
234
+
235
+
236
+ [SIMILARITIES]
237
+
238
+ # Ignore comments when computing similarities.
239
+ ignore-comments=yes
240
+
241
+ # Ignore docstrings when computing similarities.
242
+ ignore-docstrings=yes
243
+
244
+ # Ignore imports when computing similarities.
245
+ ignore-imports=no
246
+
247
+ # Minimum lines number of a similarity.
248
+ min-similarity-lines=4
249
+
250
+
251
+ [BASIC]
252
+
253
+ # Regular expression matching correct argument names
254
+ argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
255
+
256
+ # Regular expression matching correct attribute names
257
+ attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
258
+
259
+ # Bad variable names which should always be refused, separated by a comma
260
+ bad-names=foo,bar,baz,toto,tutu,tata
261
+
262
+ # Regular expression matching correct class attribute names
263
+ class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
264
+
265
+ # Regular expression matching correct class names
266
+ # class-rgx=[A-Z_][a-zA-Z0-9]+$
267
+ class-rgx=[A-Z_][a-zA-Z0-9_]+$
268
+
269
+ # Regular expression matching correct constant names
270
+ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
271
+
272
+ # Minimum line length for functions/classes that require docstrings, shorter
273
+ # ones are exempt.
274
+ docstring-min-length=-1
275
+
276
+ # Regular expression matching correct function names
277
+ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
278
+
279
+ # Good variable names which should always be accepted, separated by a comma
280
+ # good-names=i,j,k,ex,Run,_
281
+ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
282
+
283
+ # Include a hint for the correct naming format with invalid-name
284
+ include-naming-hint=no
285
+
286
+ # Regular expression matching correct inline iteration names
287
+ inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
288
+
289
+ # Regular expression matching correct method names
290
+ method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
291
+
292
+ # Regular expression matching correct module names
293
+ module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
294
+
295
+ # Colon-delimited sets of names that determine each other's naming style when
296
+ # the name regexes allow several styles.
297
+ name-group=
298
+
299
+ # Regular expression which should only match function or class names that do
300
+ # not require a docstring.
301
+ no-docstring-rgx=^_
302
+
303
+ # List of decorators that produce properties, such as abc.abstractproperty. Add
304
+ # to this list to register other decorators that produce valid properties.
305
+ property-classes=abc.abstractproperty
306
+
307
+ # Regular expression matching correct variable names
308
+ variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
309
+
310
+
311
+ [IMPORTS]
312
+
313
+ # Allow wildcard imports from modules that define __all__.
314
+ allow-wildcard-with-all=no
315
+
316
+ # Analyse import fallback blocks. This can be used to support both Python 2 and
317
+ # 3 compatible code, which means that the block might have code that exists
318
+ # only in one or another interpreter, leading to false positives when analysed.
319
+ analyse-fallback-blocks=no
320
+
321
+ # Deprecated modules which should not be used, separated by a comma
322
+ deprecated-modules=optparse,tkinter.tix
323
+
324
+ # Create a graph of external dependencies in the given file (report RP0402 must
325
+ # not be disabled)
326
+ ext-import-graph=
327
+
328
+ # Create a graph of every (i.e. internal and external) dependencies in the
329
+ # given file (report RP0402 must not be disabled)
330
+ import-graph=
331
+
332
+ # Create a graph of internal dependencies in the given file (report RP0402 must
333
+ # not be disabled)
334
+ int-import-graph=
335
+
336
+ # Force import order to recognize a module as part of the standard
337
+ # compatibility libraries.
338
+ known-standard-library=
339
+
340
+ # Force import order to recognize a module as part of a third party library.
341
+ known-third-party=enchant
342
+
343
+
344
+ [CLASSES]
345
+
346
+ # List of method names used to declare (i.e. assign) instance attributes.
347
+ defining-attr-methods=__init__,__new__,setUp
348
+
349
+ # List of member names, which should be excluded from the protected access
350
+ # warning.
351
+ exclude-protected=_asdict,_fields,_replace,_source,_make
352
+
353
+ # List of valid names for the first argument in a class method.
354
+ valid-classmethod-first-arg=cls
355
+
356
+ # List of valid names for the first argument in a metaclass class method.
357
+ valid-metaclass-classmethod-first-arg=mcs
358
+
359
+
360
+ [DESIGN]
361
+
362
+ # Maximum number of arguments for function / method
363
+ max-args=8
364
+
365
+ # Maximum number of attributes for a class (see R0902).
366
+ # max-attributes=7
367
+ max-attributes=11
368
+
369
+ # Maximum number of boolean expressions in a if statement
370
+ max-bool-expr=5
371
+
372
+ # Maximum number of branch for function / method body
373
+ max-branches=25
374
+
375
+ # Maximum number of locals for function / method body
376
+ max-locals=40
377
+
378
+ # Maximum number of parents for a class (see R0901).
379
+ max-parents=7
380
+
381
+ # Maximum number of public methods for a class (see R0904).
382
+ max-public-methods=30
383
+
384
+ # Maximum number of return / yield for function / method body
385
+ max-returns=9
386
+
387
+ # Maximum number of statements in function / method body
388
+ max-statements=120
389
+
390
+ # Minimum number of public methods for a class (see R0903).
391
+ min-public-methods=0
392
+
393
+
394
+ [EXCEPTIONS]
395
+
396
+ # Exceptions that will emit a warning when being caught. Defaults to
397
+ # "Exception"
398
+ overgeneral-exceptions=builtins.BaseException,
399
+ builtins.Exception
.secrets.baseline ADDED
@@ -0,0 +1,148 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "version": "1.4.0",
3
+ "plugins_used": [
4
+ {
5
+ "name": "ArtifactoryDetector"
6
+ },
7
+ {
8
+ "name": "AWSKeyDetector"
9
+ },
10
+ {
11
+ "name": "AzureStorageKeyDetector"
12
+ },
13
+ {
14
+ "name": "Base64HighEntropyString",
15
+ "limit": 4.5
16
+ },
17
+ {
18
+ "name": "BasicAuthDetector"
19
+ },
20
+ {
21
+ "name": "CloudantDetector"
22
+ },
23
+ {
24
+ "name": "DiscordBotTokenDetector"
25
+ },
26
+ {
27
+ "name": "GitHubTokenDetector"
28
+ },
29
+ {
30
+ "name": "HexHighEntropyString",
31
+ "limit": 3.0
32
+ },
33
+ {
34
+ "name": "IbmCloudIamDetector"
35
+ },
36
+ {
37
+ "name": "IbmCosHmacDetector"
38
+ },
39
+ {
40
+ "name": "JwtTokenDetector"
41
+ },
42
+ {
43
+ "name": "KeywordDetector",
44
+ "keyword_exclude": "example"
45
+ },
46
+ {
47
+ "name": "MailchimpDetector"
48
+ },
49
+ {
50
+ "name": "NpmDetector"
51
+ },
52
+ {
53
+ "name": "PrivateKeyDetector"
54
+ },
55
+ {
56
+ "name": "SendGridDetector"
57
+ },
58
+ {
59
+ "name": "SlackDetector"
60
+ },
61
+ {
62
+ "name": "SoftlayerDetector"
63
+ },
64
+ {
65
+ "name": "SquareOAuthDetector"
66
+ },
67
+ {
68
+ "name": "StripeDetector"
69
+ },
70
+ {
71
+ "name": "TwilioKeyDetector"
72
+ }
73
+ ],
74
+ "filters_used": [
75
+ {
76
+ "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
77
+ },
78
+ {
79
+ "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
80
+ "min_level": 2
81
+ },
82
+ {
83
+ "path": "detect_secrets.filters.heuristic.is_indirect_reference"
84
+ },
85
+ {
86
+ "path": "detect_secrets.filters.heuristic.is_likely_id_string"
87
+ },
88
+ {
89
+ "path": "detect_secrets.filters.heuristic.is_lock_file"
90
+ },
91
+ {
92
+ "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
93
+ },
94
+ {
95
+ "path": "detect_secrets.filters.heuristic.is_potential_uuid"
96
+ },
97
+ {
98
+ "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
99
+ },
100
+ {
101
+ "path": "detect_secrets.filters.heuristic.is_sequential_string"
102
+ },
103
+ {
104
+ "path": "detect_secrets.filters.heuristic.is_swagger_file"
105
+ },
106
+ {
107
+ "path": "detect_secrets.filters.heuristic.is_templated_secret"
108
+ },
109
+ {
110
+ "path": "detect_secrets.filters.regex.should_exclude_file",
111
+ "pattern": [
112
+ "test*.py"
113
+ ]
114
+ },
115
+ {
116
+ "path": "detect_secrets.filters.regex.should_exclude_line",
117
+ "pattern": [
118
+ ".*example.*",
119
+ ".*_api_key.*"
120
+ ]
121
+ },
122
+ {
123
+ "path": "detect_secrets.filters.regex.should_exclude_secret",
124
+ "pattern": [
125
+ "example",
126
+ "REPLACE_ME",
127
+ "PASSWORD",
128
+ "PASS",
129
+ "my_email",
130
+ "my_password",
131
+ "my_pat",
132
+ "fmp",
133
+ "other_key",
134
+ "polygon",
135
+ "fred",
136
+ "benzinga",
137
+ "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6ImRiMjEyZDdhZj",
138
+ "c2MWI0ZTNlOGNjZGM3OWQ5Zjk4YWM5In0.eyJhY2Nlc3NfdG9rZW4iOiJ0",
139
+ "b2tlbiIsInRva2VuX3R5cGUiOiJCZWFyZXIiLCJ1dWlkIjoidXVpZCIsInV",
140
+ "zZXJuYW1lIjoidXNlcm5hbWUiLCJlbWFpbCI6ImVtYWlsIiwicHJpbWFyeV9",
141
+ "1c2FnZSI6InByaW1hcnlfdXNhZ2UifQ.FAtE8-a1a-313Zoa6dREIxGZOHaW9",
142
+ "-JLZnFzyJ6dlHBZnkjQT2tfaaefxnTdAlSmToQwxGykvuatmI7L0wztPQ"
143
+ ]
144
+ }
145
+ ],
146
+ "results": {},
147
+ "generated_at": "2023-12-14T18:07:51Z"
148
+ }
CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,88 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Citizen Code of Conduct
2
+
3
+ ## 1. Purpose
4
+
5
+ A primary goal of OpenBB Terminal is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
6
+
7
+ This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
8
+
9
+ We invite all those who participate in OpenBB Terminal to help us create safe and positive experiences for everyone.
10
+
11
+ ## 2. Open [Source/Culture/Tech] Citizenship
12
+
13
+ A supplemental goal of this Code of Conduct is to increase open [source/culture/tech] citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
14
+
15
+ Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
16
+
17
+ If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
18
+
19
+ ## 3. Expected Behavior
20
+
21
+ The following behaviors are expected and requested of all community members:
22
+
23
+ - Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
24
+ - Exercise consideration and respect in your speech and actions.
25
+ - Attempt collaboration before conflict.
26
+ - Refrain from demeaning, discriminatory, or harassing behavior and speech.
27
+ - Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
28
+ - Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
29
+
30
+ ## 4. Unacceptable Behavior
31
+
32
+ The following behaviors are considered harassment and are unacceptable within our community:
33
+
34
+ - Violence, threats of violence or violent language directed against another person.
35
+ - Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
36
+ - Posting or displaying sexually explicit or violent material.
37
+ - Posting or threatening to post other people's personally identifying information ("doxing").
38
+ - Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
39
+ - Inappropriate photography or recording.
40
+ - Inappropriate physical contact. You should have someone's consent before touching them.
41
+ - Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
42
+ - Deliberate intimidation, stalking or following (online or in person).
43
+ - Advocating for, or encouraging, any of the above behavior.
44
+ - Sustained disruption of community events, including talks and presentations.
45
+
46
+ ## 6. Consequences of Unacceptable Behavior
47
+
48
+ Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
49
+
50
+ Anyone asked to stop unacceptable behavior is expected to comply immediately.
51
+
52
+ If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
53
+
54
+ ## 7. Reporting Guidelines
55
+
56
+ If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. dro.lopes@campus.fct.unl.pt.
57
+
58
+ [Reporting guidelines](https://github.com/OpenBB-finance/OpenBB)
59
+
60
+ Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
61
+
62
+ ## 8. Addressing Grievances
63
+
64
+ If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify OpenBBTerminal with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
65
+
66
+ ## 9. Scope
67
+
68
+ We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
69
+
70
+ This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
71
+
72
+ ## 10. Contact info
73
+
74
+ dro.lopes@campus.fct.unl.pt
75
+
76
+ ## 11. License and attribution
77
+
78
+ The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
79
+
80
+ Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
81
+
82
+ _Revision 2.3. Posted 6 March 2017._
83
+
84
+ _Revision 2.2. Posted 4 February 2016._
85
+
86
+ _Revision 2.1. Posted 23 June 2014._
87
+
88
+ _Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._
LICENSE ADDED
@@ -0,0 +1,665 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Copyright (c) 2021-2025 OpenBB Inc.
2
+
3
+ All files in this repository are licensed under the GNU Affero General Public License v3.0.
4
+
5
+ GNU AFFERO GENERAL PUBLIC LICENSE
6
+ Version 3, 19 November 2007
7
+
8
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
9
+ Everyone is permitted to copy and distribute verbatim copies
10
+ of this license document, but changing it is not allowed.
11
+
12
+ Preamble
13
+
14
+ The GNU Affero General Public License is a free, copyleft license for
15
+ software and other kinds of works, specifically designed to ensure
16
+ cooperation with the community in the case of network server software.
17
+
18
+ The licenses for most software and other practical works are designed
19
+ to take away your freedom to share and change the works. By contrast,
20
+ our General Public Licenses are intended to guarantee your freedom to
21
+ share and change all versions of a program--to make sure it remains free
22
+ software for all its users.
23
+
24
+ When we speak of free software, we are referring to freedom, not
25
+ price. Our General Public Licenses are designed to make sure that you
26
+ have the freedom to distribute copies of free software (and charge for
27
+ them if you wish), that you receive source code or can get it if you
28
+ want it, that you can change the software or use pieces of it in new
29
+ free programs, and that you know you can do these things.
30
+
31
+ Developers that use our General Public Licenses protect your rights
32
+ with two steps: (1) assert copyright on the software, and (2) offer
33
+ you this License which gives you legal permission to copy, distribute
34
+ and/or modify the software.
35
+
36
+ A secondary benefit of defending all users' freedom is that
37
+ improvements made in alternate versions of the program, if they
38
+ receive widespread use, become available for other developers to
39
+ incorporate. Many developers of free software are heartened and
40
+ encouraged by the resulting cooperation. However, in the case of
41
+ software used on network servers, this result may fail to come about.
42
+ The GNU General Public License permits making a modified version and
43
+ letting the public access it on a server without ever releasing its
44
+ source code to the public.
45
+
46
+ The GNU Affero General Public License is designed specifically to
47
+ ensure that, in such cases, the modified source code becomes available
48
+ to the community. It requires the operator of a network server to
49
+ provide the source code of the modified version running there to the
50
+ users of that server. Therefore, public use of a modified version, on
51
+ a publicly accessible server, gives the public access to the source
52
+ code of the modified version.
53
+
54
+ An older license, called the Affero General Public License and
55
+ published by Affero, was designed to accomplish similar goals. This is
56
+ a different license, not a version of the Affero GPL, but Affero has
57
+ released a new version of the Affero GPL which permits relicensing under
58
+ this license.
59
+
60
+ The precise terms and conditions for copying, distribution and
61
+ modification follow.
62
+
63
+ TERMS AND CONDITIONS
64
+
65
+ 1. Definitions.
66
+
67
+ "This License" refers to version 3 of the GNU Affero General Public License.
68
+
69
+ "Copyright" also means copyright-like laws that apply to other kinds of
70
+ works, such as semiconductor masks.
71
+
72
+ "The Program" refers to any copyrightable work licensed under this
73
+ License. Each licensee is addressed as "you". "Licensees" and
74
+ "recipients" may be individuals or organizations.
75
+
76
+ To "modify" a work means to copy from or adapt all or part of the work
77
+ in a fashion requiring copyright permission, other than the making of an
78
+ exact copy. The resulting work is called a "modified version" of the
79
+ earlier work or a work "based on" the earlier work.
80
+
81
+ A "covered work" means either the unmodified Program or a work based
82
+ on the Program.
83
+
84
+ To "propagate" a work means to do anything with it that, without
85
+ permission, would make you directly or secondarily liable for
86
+ infringement under applicable copyright law, except executing it on a
87
+ computer or modifying a private copy. Propagation includes copying,
88
+ distribution (with or without modification), making available to the
89
+ public, and in some countries other activities as well.
90
+
91
+ To "convey" a work means any kind of propagation that enables other
92
+ parties to make or receive copies. Mere interaction with a user through
93
+ a computer network, with no transfer of a copy, is not conveying.
94
+
95
+ An interactive user interface displays "Appropriate Legal Notices"
96
+ to the extent that it includes a convenient and prominently visible
97
+ feature that (1) displays an appropriate copyright notice, and (2)
98
+ tells the user that there is no warranty for the work (except to the
99
+ extent that warranties are provided), that licensees may convey the
100
+ work under this License, and how to view a copy of this License. If
101
+ the interface presents a list of user commands or options, such as a
102
+ menu, a prominent item in the list meets this criterion.
103
+
104
+ 1. Source Code.
105
+
106
+ The "source code" for a work means the preferred form of the work
107
+ for making modifications to it. "Object code" means any non-source
108
+ form of a work.
109
+
110
+ A "Standard Interface" means an interface that either is an official
111
+ standard defined by a recognized standards body, or, in the case of
112
+ interfaces specified for a particular programming language, one that
113
+ is widely used among developers working in that language.
114
+
115
+ The "System Libraries" of an executable work include anything, other
116
+ than the work as a whole, that (a) is included in the normal form of
117
+ packaging a Major Component, but which is not part of that Major
118
+ Component, and (b) serves only to enable use of the work with that
119
+ Major Component, or to implement a Standard Interface for which an
120
+ implementation is available to the public in source code form. A
121
+ "Major Component", in this context, means a major essential component
122
+ (kernel, window system, and so on) of the specific operating system
123
+ (if any) on which the executable work runs, or a compiler used to
124
+ produce the work, or an object code interpreter used to run it.
125
+
126
+ The "Corresponding Source" for a work in object code form means all
127
+ the source code needed to generate, install, and (for an executable
128
+ work) run the object code and to modify the work, including scripts to
129
+ control those activities. However, it does not include the work's
130
+ System Libraries, or general-purpose tools or generally available free
131
+ programs which are used unmodified in performing those activities but
132
+ which are not part of the work. For example, Corresponding Source
133
+ includes interface definition files associated with source files for
134
+ the work, and the source code for shared libraries and dynamically
135
+ linked subprograms that the work is specifically designed to require,
136
+ such as by intimate data communication or control flow between those
137
+ subprograms and other parts of the work.
138
+
139
+ The Corresponding Source need not include anything that users
140
+ can regenerate automatically from other parts of the Corresponding
141
+ Source.
142
+
143
+ The Corresponding Source for a work in source code form is that
144
+ same work.
145
+
146
+ 2. Basic Permissions.
147
+
148
+ All rights granted under this License are granted for the term of
149
+ copyright on the Program, and are irrevocable provided the stated
150
+ conditions are met. This License explicitly affirms your unlimited
151
+ permission to run the unmodified Program. The output from running a
152
+ covered work is covered by this License only if the output, given its
153
+ content, constitutes a covered work. This License acknowledges your
154
+ rights of fair use or other equivalent, as provided by copyright law.
155
+
156
+ You may make, run and propagate covered works that you do not
157
+ convey, without conditions so long as your license otherwise remains
158
+ in force. You may convey covered works to others for the sole purpose
159
+ of having them make modifications exclusively for you, or provide you
160
+ with facilities for running those works, provided that you comply with
161
+ the terms of this License in conveying all material for which you do
162
+ not control copyright. Those thus making or running the covered works
163
+ for you must do so exclusively on your behalf, under your direction
164
+ and control, on terms that prohibit them from making any copies of
165
+ your copyrighted material outside their relationship with you.
166
+
167
+ Conveying under any other circumstances is permitted solely under
168
+ the conditions stated below. Sublicensing is not allowed; section 10
169
+ makes it unnecessary.
170
+
171
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
172
+
173
+ No covered work shall be deemed part of an effective technological
174
+ measure under any applicable law fulfilling obligations under article
175
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
176
+ similar laws prohibiting or restricting circumvention of such
177
+ measures.
178
+
179
+ When you convey a covered work, you waive any legal power to forbid
180
+ circumvention of technological measures to the extent such circumvention
181
+ is effected by exercising rights under this License with respect to
182
+ the covered work, and you disclaim any intention to limit operation or
183
+ modification of the work as a means of enforcing, against the work's
184
+ users, your or third parties' legal rights to forbid circumvention of
185
+ technological measures.
186
+
187
+ 4. Conveying Verbatim Copies.
188
+
189
+ You may convey verbatim copies of the Program's source code as you
190
+ receive it, in any medium, provided that you conspicuously and
191
+ appropriately publish on each copy an appropriate copyright notice;
192
+ keep intact all notices stating that this License and any
193
+ non-permissive terms added in accord with section 7 apply to the code;
194
+ keep intact all notices of the absence of any warranty; and give all
195
+ recipients a copy of this License along with the Program.
196
+
197
+ You may charge any price or no price for each copy that you convey,
198
+ and you may offer support or warranty protection for a fee.
199
+
200
+ 5. Conveying Modified Source Versions.
201
+
202
+ You may convey a work based on the Program, or the modifications to
203
+ produce it from the Program, in the form of source code under the
204
+ terms of section 4, provided that you also meet all of these conditions:
205
+
206
+ a) The work must carry prominent notices stating that you modified
207
+ it, and giving a relevant date.
208
+
209
+ b) The work must carry prominent notices stating that it is
210
+ released under this License and any conditions added under section
211
+ 7. This requirement modifies the requirement in section 4 to
212
+ "keep intact all notices".
213
+
214
+ c) You must license the entire work, as a whole, under this
215
+ License to anyone who comes into possession of a copy. This
216
+ License will therefore apply, along with any applicable section 7
217
+ additional terms, to the whole of the work, and all its parts,
218
+ regardless of how they are packaged. This License gives no
219
+ permission to license the work in any other way, but it does not
220
+ invalidate such permission if you have separately received it.
221
+
222
+ d) If the work has interactive user interfaces, each must display
223
+ Appropriate Legal Notices; however, if the Program has interactive
224
+ interfaces that do not display Appropriate Legal Notices, your
225
+ work need not make them do so.
226
+
227
+ A compilation of a covered work with other separate and independent
228
+ works, which are not by their nature extensions of the covered work,
229
+ and which are not combined with it such as to form a larger program,
230
+ in or on a volume of a storage or distribution medium, is called an
231
+ "aggregate" if the compilation and its resulting copyright are not
232
+ used to limit the access or legal rights of the compilation's users
233
+ beyond what the individual works permit. Inclusion of a covered work
234
+ in an aggregate does not cause this License to apply to the other
235
+ parts of the aggregate.
236
+
237
+ 6. Conveying Non-Source Forms.
238
+
239
+ You may convey a covered work in object code form under the terms
240
+ of sections 4 and 5, provided that you also convey the
241
+ machine-readable Corresponding Source under the terms of this License,
242
+ in one of these ways:
243
+
244
+ a) Convey the object code in, or embodied in, a physical product
245
+ (including a physical distribution medium), accompanied by the
246
+ Corresponding Source fixed on a durable physical medium
247
+ customarily used for software interchange.
248
+
249
+ b) Convey the object code in, or embodied in, a physical product
250
+ (including a physical distribution medium), accompanied by a
251
+ written offer, valid for at least three years and valid for as
252
+ long as you offer spare parts or customer support for that product
253
+ model, to give anyone who possesses the object code either (1) a
254
+ copy of the Corresponding Source for all the software in the
255
+ product that is covered by this License, on a durable physical
256
+ medium customarily used for software interchange, for a price no
257
+ more than your reasonable cost of physically performing this
258
+ conveying of source, or (2) access to copy the
259
+ Corresponding Source from a network server at no charge.
260
+
261
+ c) Convey individual copies of the object code with a copy of the
262
+ written offer to provide the Corresponding Source. This
263
+ alternative is allowed only occasionally and noncommercially, and
264
+ only if you received the object code with such an offer, in accord
265
+ with subsection 6b.
266
+
267
+ d) Convey the object code by offering access from a designated
268
+ place (gratis or for a charge), and offer equivalent access to the
269
+ Corresponding Source in the same way through the same place at no
270
+ further charge. You need not require recipients to copy the
271
+ Corresponding Source along with the object code. If the place to
272
+ copy the object code is a network server, the Corresponding Source
273
+ may be on a different server (operated by you or a third party)
274
+ that supports equivalent copying facilities, provided you maintain
275
+ clear directions next to the object code saying where to find the
276
+ Corresponding Source. Regardless of what server hosts the
277
+ Corresponding Source, you remain obligated to ensure that it is
278
+ available for as long as needed to satisfy these requirements.
279
+
280
+ e) Convey the object code using peer-to-peer transmission, provided
281
+ you inform other peers where the object code and Corresponding
282
+ Source of the work are being offered to the general public at no
283
+ charge under subsection 6d.
284
+
285
+ A separable portion of the object code, whose source code is excluded
286
+ from the Corresponding Source as a System Library, need not be
287
+ included in conveying the object code work.
288
+
289
+ A "User Product" is either (1) a "consumer product", which means any
290
+ tangible personal property which is normally used for personal, family,
291
+ or household purposes, or (2) anything designed or sold for incorporation
292
+ into a dwelling. In determining whether a product is a consumer product,
293
+ doubtful cases shall be resolved in favor of coverage. For a particular
294
+ product received by a particular user, "normally used" refers to a
295
+ typical or common use of that class of product, regardless of the status
296
+ of the particular user or of the way in which the particular user
297
+ actually uses, or expects or is expected to use, the product. A product
298
+ is a consumer product regardless of whether the product has substantial
299
+ commercial, industrial or non-consumer uses, unless such uses represent
300
+ the only significant mode of use of the product.
301
+
302
+ "Installation Information" for a User Product means any methods,
303
+ procedures, authorization keys, or other information required to install
304
+ and execute modified versions of a covered work in that User Product from
305
+ a modified version of its Corresponding Source. The information must
306
+ suffice to ensure that the continued functioning of the modified object
307
+ code is in no case prevented or interfered with solely because
308
+ modification has been made.
309
+
310
+ If you convey an object code work under this section in, or with, or
311
+ specifically for use in, a User Product, and the conveying occurs as
312
+ part of a transaction in which the right of possession and use of the
313
+ User Product is transferred to the recipient in perpetuity or for a
314
+ fixed term (regardless of how the transaction is characterized), the
315
+ Corresponding Source conveyed under this section must be accompanied
316
+ by the Installation Information. But this requirement does not apply
317
+ if neither you nor any third party retains the ability to install
318
+ modified object code on the User Product (for example, the work has
319
+ been installed in ROM).
320
+
321
+ The requirement to provide Installation Information does not include a
322
+ requirement to continue to provide support service, warranty, or updates
323
+ for a work that has been modified or installed by the recipient, or for
324
+ the User Product in which it has been modified or installed. Access to a
325
+ network may be denied when the modification itself materially and
326
+ adversely affects the operation of the network or violates the rules and
327
+ protocols for communication across the network.
328
+
329
+ Corresponding Source conveyed, and Installation Information provided,
330
+ in accord with this section must be in a format that is publicly
331
+ documented (and with an implementation available to the public in
332
+ source code form), and must require no special password or key for
333
+ unpacking, reading or copying.
334
+
335
+ 7. Additional Terms.
336
+
337
+ "Additional permissions" are terms that supplement the terms of this
338
+ License by making exceptions from one or more of its conditions.
339
+ Additional permissions that are applicable to the entire Program shall
340
+ be treated as though they were included in this License, to the extent
341
+ that they are valid under applicable law. If additional permissions
342
+ apply only to part of the Program, that part may be used separately
343
+ under those permissions, but the entire Program remains governed by
344
+ this License without regard to the additional permissions.
345
+
346
+ When you convey a copy of a covered work, you may at your option
347
+ remove any additional permissions from that copy, or from any part of
348
+ it. (Additional permissions may be written to require their own
349
+ removal in certain cases when you modify the work.) You may place
350
+ additional permissions on material, added by you to a covered work,
351
+ for which you have or can give appropriate copyright permission.
352
+
353
+ Notwithstanding any other provision of this License, for material you
354
+ add to a covered work, you may (if authorized by the copyright holders of
355
+ that material) supplement the terms of this License with terms:
356
+
357
+ a) Disclaiming warranty or limiting liability differently from the
358
+ terms of sections 15 and 16 of this License; or
359
+
360
+ b) Requiring preservation of specified reasonable legal notices or
361
+ author attributions in that material or in the Appropriate Legal
362
+ Notices displayed by works containing it; or
363
+
364
+ c) Prohibiting misrepresentation of the origin of that material, or
365
+ requiring that modified versions of such material be marked in
366
+ reasonable ways as different from the original version; or
367
+
368
+ d) Limiting the use for publicity purposes of names of licensors or
369
+ authors of the material; or
370
+
371
+ e) Declining to grant rights under trademark law for use of some
372
+ trade names, trademarks, or service marks; or
373
+
374
+ f) Requiring indemnification of licensors and authors of that
375
+ material by anyone who conveys the material (or modified versions of
376
+ it) with contractual assumptions of liability to the recipient, for
377
+ any liability that these contractual assumptions directly impose on
378
+ those licensors and authors.
379
+
380
+ All other non-permissive additional terms are considered "further
381
+ restrictions" within the meaning of section 10. If the Program as you
382
+ received it, or any part of it, contains a notice stating that it is
383
+ governed by this License along with a term that is a further
384
+ restriction, you may remove that term. If a license document contains
385
+ a further restriction but permits relicensing or conveying under this
386
+ License, you may add to a covered work material governed by the terms
387
+ of that license document, provided that the further restriction does
388
+ not survive such relicensing or conveying.
389
+
390
+ If you add terms to a covered work in accord with this section, you
391
+ must place, in the relevant source files, a statement of the
392
+ additional terms that apply to those files, or a notice indicating
393
+ where to find the applicable terms.
394
+
395
+ Additional terms, permissive or non-permissive, may be stated in the
396
+ form of a separately written license, or stated as exceptions;
397
+ the above requirements apply either way.
398
+
399
+ 8. Termination.
400
+
401
+ You may not propagate or modify a covered work except as expressly
402
+ provided under this License. Any attempt otherwise to propagate or
403
+ modify it is void, and will automatically terminate your rights under
404
+ this License (including any patent licenses granted under the third
405
+ paragraph of section 11).
406
+
407
+ However, if you cease all violation of this License, then your
408
+ license from a particular copyright holder is reinstated (a)
409
+ provisionally, unless and until the copyright holder explicitly and
410
+ finally terminates your license, and (b) permanently, if the copyright
411
+ holder fails to notify you of the violation by some reasonable means
412
+ prior to 60 days after the cessation.
413
+
414
+ Moreover, your license from a particular copyright holder is
415
+ reinstated permanently if the copyright holder notifies you of the
416
+ violation by some reasonable means, this is the first time you have
417
+ received notice of violation of this License (for any work) from that
418
+ copyright holder, and you cure the violation prior to 30 days after
419
+ your receipt of the notice.
420
+
421
+ Termination of your rights under this section does not terminate the
422
+ licenses of parties who have received copies or rights from you under
423
+ this License. If your rights have been terminated and not permanently
424
+ reinstated, you do not qualify to receive new licenses for the same
425
+ material under section 10.
426
+
427
+ 9. Acceptance Not Required for Having Copies.
428
+
429
+ You are not required to accept this License in order to receive or
430
+ run a copy of the Program. Ancillary propagation of a covered work
431
+ occurring solely as a consequence of using peer-to-peer transmission
432
+ to receive a copy likewise does not require acceptance. However,
433
+ nothing other than this License grants you permission to propagate or
434
+ modify any covered work. These actions infringe copyright if you do
435
+ not accept this License. Therefore, by modifying or propagating a
436
+ covered work, you indicate your acceptance of this License to do so.
437
+
438
+ 10. Automatic Licensing of Downstream Recipients.
439
+
440
+ Each time you convey a covered work, the recipient automatically
441
+ receives a license from the original licensors, to run, modify and
442
+ propagate that work, subject to this License. You are not responsible
443
+ for enforcing compliance by third parties with this License.
444
+
445
+ An "entity transaction" is a transaction transferring control of an
446
+ organization, or substantially all assets of one, or subdividing an
447
+ organization, or merging organizations. If propagation of a covered
448
+ work results from an entity transaction, each party to that
449
+ transaction who receives a copy of the work also receives whatever
450
+ licenses to the work the party's predecessor in interest had or could
451
+ give under the previous paragraph, plus a right to possession of the
452
+ Corresponding Source of the work from the predecessor in interest, if
453
+ the predecessor has it or can get it with reasonable efforts.
454
+
455
+ You may not impose any further restrictions on the exercise of the
456
+ rights granted or affirmed under this License. For example, you may
457
+ not impose a license fee, royalty, or other charge for exercise of
458
+ rights granted under this License, and you may not initiate litigation
459
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
460
+ any patent claim is infringed by making, using, selling, offering for
461
+ sale, or importing the Program or any portion of it.
462
+
463
+ 11. Patents.
464
+
465
+ A "contributor" is a copyright holder who authorizes use under this
466
+ License of the Program or a work on which the Program is based. The
467
+ work thus licensed is called the contributor's "contributor version".
468
+
469
+ A contributor's "essential patent claims" are all patent claims
470
+ owned or controlled by the contributor, whether already acquired or
471
+ hereafter acquired, that would be infringed by some manner, permitted
472
+ by this License, of making, using, or selling its contributor version,
473
+ but do not include claims that would be infringed only as a
474
+ consequence of further modification of the contributor version. For
475
+ purposes of this definition, "control" includes the right to grant
476
+ patent sublicenses in a manner consistent with the requirements of
477
+ this License.
478
+
479
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
480
+ patent license under the contributor's essential patent claims, to
481
+ make, use, sell, offer for sale, import and otherwise run, modify and
482
+ propagate the contents of its contributor version.
483
+
484
+ In the following three paragraphs, a "patent license" is any express
485
+ agreement or commitment, however denominated, not to enforce a patent
486
+ (such as an express permission to practice a patent or covenant not to
487
+ sue for patent infringement). To "grant" such a patent license to a
488
+ party means to make such an agreement or commitment not to enforce a
489
+ patent against the party.
490
+
491
+ If you convey a covered work, knowingly relying on a patent license,
492
+ and the Corresponding Source of the work is not available for anyone
493
+ to copy, free of charge and under the terms of this License, through a
494
+ publicly available network server or other readily accessible means,
495
+ then you must either (1) cause the Corresponding Source to be so
496
+ available, or (2) arrange to deprive yourself of the benefit of the
497
+ patent license for this particular work, or (3) arrange, in a manner
498
+ consistent with the requirements of this License, to extend the patent
499
+ license to downstream recipients. "Knowingly relying" means you have
500
+ actual knowledge that, but for the patent license, your conveying the
501
+ covered work in a country, or your recipient's use of the covered work
502
+ in a country, would infringe one or more identifiable patents in that
503
+ country that you have reason to believe are valid.
504
+
505
+ If, pursuant to or in connection with a single transaction or
506
+ arrangement, you convey, or propagate by procuring conveyance of, a
507
+ covered work, and grant a patent license to some of the parties
508
+ receiving the covered work authorizing them to use, propagate, modify
509
+ or convey a specific copy of the covered work, then the patent license
510
+ you grant is automatically extended to all recipients of the covered
511
+ work and works based on it.
512
+
513
+ A patent license is "discriminatory" if it does not include within
514
+ the scope of its coverage, prohibits the exercise of, or is
515
+ conditioned on the non-exercise of one or more of the rights that are
516
+ specifically granted under this License. You may not convey a covered
517
+ work if you are a party to an arrangement with a third party that is
518
+ in the business of distributing software, under which you make payment
519
+ to the third party based on the extent of your activity of conveying
520
+ the work, and under which the third party grants, to any of the
521
+ parties who would receive the covered work from you, a discriminatory
522
+ patent license (a) in connection with copies of the covered work
523
+ conveyed by you (or copies made from those copies), or (b) primarily
524
+ for and in connection with specific products or compilations that
525
+ contain the covered work, unless you entered into that arrangement,
526
+ or that patent license was granted, prior to 28 March 2007.
527
+
528
+ Nothing in this License shall be construed as excluding or limiting
529
+ any implied license or other defenses to infringement that may
530
+ otherwise be available to you under applicable patent law.
531
+
532
+ 12. No Surrender of Others' Freedom.
533
+
534
+ If conditions are imposed on you (whether by court order, agreement or
535
+ otherwise) that contradict the conditions of this License, they do not
536
+ excuse you from the conditions of this License. If you cannot convey a
537
+ covered work so as to satisfy simultaneously your obligations under this
538
+ License and any other pertinent obligations, then as a consequence you may
539
+ not convey it at all. For example, if you agree to terms that obligate you
540
+ to collect a royalty for further conveying from those to whom you convey
541
+ the Program, the only way you could satisfy both those terms and this
542
+ License would be to refrain entirely from conveying the Program.
543
+
544
+ 13. Remote Network Interaction; Use with the GNU General Public License.
545
+
546
+ Notwithstanding any other provision of this License, if you modify the
547
+ Program, your modified version must prominently offer all users
548
+ interacting with it remotely through a computer network (if your version
549
+ supports such interaction) an opportunity to receive the Corresponding
550
+ Source of your version by providing access to the Corresponding Source
551
+ from a network server at no charge, through some standard or customary
552
+ means of facilitating copying of software. This Corresponding Source
553
+ shall include the Corresponding Source for any work covered by version 3
554
+ of the GNU General Public License that is incorporated pursuant to the
555
+ following paragraph.
556
+
557
+ Notwithstanding any other provision of this License, you have
558
+ permission to link or combine any covered work with a work licensed
559
+ under version 3 of the GNU General Public License into a single
560
+ combined work, and to convey the resulting work. The terms of this
561
+ License will continue to apply to the part which is the covered work,
562
+ but the work with which it is combined will remain governed by version
563
+ 3 of the GNU General Public License.
564
+
565
+ 14. Revised Versions of this License.
566
+
567
+ The Free Software Foundation may publish revised and/or new versions of
568
+ the GNU Affero General Public License from time to time. Such new versions
569
+ will be similar in spirit to the present version, but may differ in detail to
570
+ address new problems or concerns.
571
+
572
+ Each version is given a distinguishing version number. If the
573
+ Program specifies that a certain numbered version of the GNU Affero General
574
+ Public License "or any later version" applies to it, you have the
575
+ option of following the terms and conditions either of that numbered
576
+ version or of any later version published by the Free Software
577
+ Foundation. If the Program does not specify a version number of the
578
+ GNU Affero General Public License, you may choose any version ever published
579
+ by the Free Software Foundation.
580
+
581
+ If the Program specifies that a proxy can decide which future
582
+ versions of the GNU Affero General Public License can be used, that proxy's
583
+ public statement of acceptance of a version permanently authorizes you
584
+ to choose that version for the Program.
585
+
586
+ Later license versions may give you additional or different
587
+ permissions. However, no additional obligations are imposed on any
588
+ author or copyright holder as a result of your choosing to follow a
589
+ later version.
590
+
591
+ 15. Disclaimer of Warranty.
592
+
593
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
594
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
595
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
596
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
597
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
598
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
599
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
600
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
601
+
602
+ 16. Limitation of Liability.
603
+
604
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
605
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
606
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
607
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
608
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
609
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
610
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
611
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
612
+ SUCH DAMAGES.
613
+
614
+ 17. Interpretation of Sections 15 and 16.
615
+
616
+ If the disclaimer of warranty and limitation of liability provided
617
+ above cannot be given local legal effect according to their terms,
618
+ reviewing courts shall apply local law that most closely approximates
619
+ an absolute waiver of all civil liability in connection with the
620
+ Program, unless a warranty or assumption of liability accompanies a
621
+ copy of the Program in return for a fee.
622
+
623
+ END OF TERMS AND CONDITIONS
624
+
625
+ How to Apply These Terms to Your New Programs
626
+
627
+ If you develop a new program, and you want it to be of the greatest
628
+ possible use to the public, the best way to achieve this is to make it
629
+ free software which everyone can redistribute and change under these terms.
630
+
631
+ To do so, attach the following notices to the program. It is safest
632
+ to attach them to the start of each source file to most effectively
633
+ state the exclusion of warranty; and each file should have at least
634
+ the "copyright" line and a pointer to where the full notice is found.
635
+
636
+ <one line to give the program's name and a brief idea of what it does.>
637
+ Copyright (C) <year> <name of author>
638
+
639
+ This program is free software: you can redistribute it and/or modify
640
+ it under the terms of the GNU Affero General Public License as published
641
+ by the Free Software Foundation, either version 3 of the License, or
642
+ (at your option) any later version.
643
+
644
+ This program is distributed in the hope that it will be useful,
645
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
646
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
647
+ GNU Affero General Public License for more details.
648
+
649
+ You should have received a copy of the GNU Affero General Public License
650
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
651
+
652
+ Also add information on how to contact you by electronic and paper mail.
653
+
654
+ If your software can interact with users remotely through a computer
655
+ network, you should also make sure that it provides a way for users to
656
+ get its source. For example, if your program is a web application, its
657
+ interface could display a "Source" link that leads users to an archive
658
+ of the code. There are many ways you could offer source, and different
659
+ solutions will be better for different programs; see section 13 for the
660
+ specific requirements.
661
+
662
+ You should also get your employer (if you work as a programmer) or school,
663
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
664
+ For more information on this, and how to apply and follow the GNU AGPL, see
665
+ <https://www.gnu.org/licenses/>.
pytest.ini ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ [pytest]
2
+ addopts = -p no:warnings
3
+ markers =
4
+ linux: tests that are not stable on Windows
5
+ integration: OpenBB Platform integration test marker
6
+ testpaths =
7
+ tests
8
+ openbb_platform/**/tests
ruff.toml ADDED
@@ -0,0 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # This is an introductory addition of ruff. We should look to adding:
2
+ # PD: pandas-vet
3
+ # All options here: https://github.com/charliermarsh/ruff#supported-rules
4
+
5
+ exclude = [
6
+ "^openbb_platform/platform/core/openbb_core/app/static/package/.*",
7
+ "^openbb_platform/openbb/package/.*",
8
+ ]
9
+
10
+ line-length = 122
11
+ target-version = "py39"
12
+ fix = true
13
+
14
+ [lint]
15
+ select = [
16
+ "E",
17
+ "W",
18
+ "F",
19
+ "Q",
20
+ "S",
21
+ "UP",
22
+ "I",
23
+ "PLC",
24
+ "PLE",
25
+ "PLR",
26
+ "PLW",
27
+ "SIM",
28
+ "T20",
29
+ ]
30
+ # These ignores should be seen as temporary solutions to problems that will NEED fixed
31
+ ignore = ["PLR2004", "PLR0913", "PLR0915", "UP035", "UP006"]
32
+
33
+ [lint.per-file-ignores]
34
+ "**/tests/*" = ["S101"]
35
+ "*init*.py" = ["F401"]
36
+ "website/*" = ["T201", "PLR0915"]
37
+ "*integration/*" = ["S101"]
38
+
39
+ [lint.isort]
40
+ combine-as-imports = true
41
+ force-wrap-aliases = true
42
+
43
+ [lint.pylint]
44
+ max-args = 8
45
+ max-branches = 26
46
+ max-returns = 9
47
+ max-statements = 30
48
+
49
+ [lint.pydocstyle]
50
+ convention = "numpy"
51
+
52
+ [lint.flake8-import-conventions.aliases]
53
+ "matplotlib.pyplot" = "plt"
54
+ numpy = "np"
55
+ pandas = "pd"
56
+ seaborn = "sns"